Low Level API: Adapts grab result to Pylon::IImage.
More...
#include <pylon/ResultImage.h>
|
GrabResultT | m_grabResult |
| The grab result that is adapted to IImage.
|
|
bool | m_isUnique |
| User provided info whether the buffer is referenced only by this adapter.
|
|
template<typename GrabResultT>
class Pylon::CGrabResultImageT< GrabResultT >
Low Level API: Adapts grab result to Pylon::IImage.
template<typename GrabResultT >
Creates a grab result image object.
- Parameters
-
[in] | grabResult | A grab result. |
[in] | isUnique | User provided info whether the buffer is referenced only by this grab result. |
- Error Safety:
- Does not throw C++ exceptions.
template<typename GrabResultT >
Get the pointer to the buffer.
- Returns
- Returns the pointer to the used buffer or NULL if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the pointer to the buffer containing the image.
The buffer is at least as large as the value returned by GetImageSize().
- Returns
- Returns the pointer to the used buffer or NULL if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the current number of rows.
- Returns
- Returns the current number of rows or 0 if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the size of the image in bytes.
- Returns
- Returns the size of the image in bytes or 0 if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the vertical orientation of the image in memory.
- Returns
- Returns the orientation of the image or ImageOrientation_TopDown if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the number of extra data bytes at the end of each row.
- Returns
- Returns the number of extra data bytes at the end of each row or 0 if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the current pixel type.
- Returns
- Returns the pixel type or PixelType_Undefined if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the stride in bytes.
The stride in bytes can not be computed for packed image format when the stride is not byte aligned. See also Pylon::IsPacked(). The stride in bytes can not be computed if the image is invalid.
- Parameters
-
[out] | strideBytes | The stride in byte if it can be computed. |
- Returns
- Returns true if the stride can be computed.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Get the current number of columns in pixels.
- Returns
- Returns the current number of columns in pixels or 0 if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Indicates that the referenced buffer is only referenced by this image.
- Returns
- Returns true if the referenced buffer is only referenced by this image. Returns false if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
template<typename GrabResultT >
Can be used to check whether an image is valid.
- Returns
- Returns false if the image is invalid.
- Error Safety:
- Does not throw C++ exceptions.
Implements Pylon::IImage.
The documentation for this class was generated from the following file: