CImageData
The CImageData class represents image data, which contains the image bytes, width, height, stride, pixel format, orientation and a tag.
Definition
Namespace: dynamsoft::basic_structures
Assembly: DynamsoftCore
class CImageData
Methods Summary
| Method | Description |
|---|---|
CImageData() |
Constructs an empty image data object. |
CImageData(int _bytesLength, const unsigned char* _bytes, int _width, int _height, int _stride, ImagePixelFormat _format, int _orientation=0, const CImageTag* _tag = NULL) |
Constructs an image data object with the specified parameters. |
CImageData(unsigned long long _bytesLength, const unsigned char* _bytes, FreeBytesFunc _freeBytesFunc, int _width, int _height, int _stride, ImagePixelFormat _format, int _orientation=0, const CImageTag* _tag = NULL) |
Constructs an image data object with the specified parameters. |
~CImageData() |
Destructs the image data object and frees the allocated memory. |
GetBytes |
Gets the image byte array. |
GetBytesLength |
Gets the length of the image byte array. |
GetWidth |
Gets the width of the image. |
GetHeight |
Gets the height of the image. |
GetStride |
Gets the stride of the image. |
GetImagePixelFormat |
Gets the pixel format of the image. |
GetOrientation |
Gets the orientation of the image. |
GetImageTag |
Gets the tag of the image. |
SetImageTag |
Sets the tag of the image. |
CImageData Constructor
Constructs an empty image data object.
CImageData()
CImageData Constructor2
Constructs an image data object with the specified parameters.
CImageData(int _bytesLength, const unsigned char* _bytes, int _width, int _height, int _stride, ImagePixelFormat _format, int _orientation=0, const CImageTag* _tag = NULL)
Parameters
_bytesLength The length of the image byte array.
_bytes The image byte array.
_width The width of the image.
_height The height of the image.
_stride The stride of the image.
_format The pixel format of the image.
_orientation The orientation of the image.
_tag The tag of the image.
CImageData Constructor3
Constructs an image data object with the specified parameters.
CImageData(unsigned long long _bytesLength, const unsigned char* _bytes, FreeBytesFunc _freeBytesFunc, int _width, int _height, int _stride, ImagePixelFormat _format, int _orientation=0, const CImageTag* _tag = NULL);
Parameters
_bytesLength The length of the image byte array.
_bytes The image byte array.
_freeBytesFunc The function to free the image byte array.
_width The width of the image.
_height The height of the image.
_stride The stride of the image.
_format The pixel format of the image.
_orientation The orientation of the image.
_tag The tag of the image.
~CImageData Destructor
Destructs the image data object and frees the allocated memory.
virtual ~CImageData()
GetBytes
Gets the image byte array.
const unsigned char* GetBytes() const
Return value
Returns a pointer to the image byte array.
GetBytesLength
Gets the length of the image byte array.
unsigned long long GetBytesLength() const
Return value
Returns the length of the image byte array.
GetWidth
Gets the width of the image.
int GetWidth() const
Return value
Returns the width of the image.
GetHeight
Gets the height of the image.
int GetHeight() const
Return value
Returns the height of the image.
GetStride
Gets the stride of the image.
int GetStride() const
Return value
Returns the stride of the image.
GetImagePixelFormat
Gets the pixel format of the image.
ImagePixelFormat GetImagePixelFormat() const
Return value
Returns the pixel format of the image.
See Also
GetOrientation
Gets the orientation of the image.
int GetOrientation() const
Return value
Returns the orientation of the image.
GetImageTag
Gets the tag of the image.
const CImageTag* GetImageTag() const
Return value
Returns a pointer to the tag of the image.
See Also
SetImageTag
Sets the tag of the image.
void SetImageTag(const CImageTag* _tag)
Parameters
_tag The tag of the image.
See Also
Yes
No