Namespace: Rx – Class: CRxImageFormat – Header: Rx.Core.Ex/RxImageFormat.h
CRxImageFormat Class
#include "Rx.Core.Ex/RxImageFormat.h"
class CRxImageFormatImage format descriptor.
Constructors
| CRxImageFormat() | Default constructor. |
| CRxImageFormat(iWidthPX, iHeightPX) | Constructs the image format with the given width and height. |
| CRxImageFormat(iWidth, iHeight, ePixelType, eDataType) | Constructs the image format with the given width, height, pixel type and data type. |
Destructor
| ~CRxImageFormat() | Destructor. |
Methods
| Reset() | Resets this CRxImageFormat. |
| ToString() | Convert this CRxImageFormat into a string representation. |
| IsOfType() | Test whether format is of particular pixel type. |
| IsBayerPixelType() | Query if this CRxImageFormat is bayer pixel type. |
| HasCustomDataType() | Returns true if the data type of this image format is one of the custom (non primitive) data types. |
| IsValid() | Query if this object is valid. |
| IsSizeValid() | Query if this object is valid. |
| GetComponentCount() | Gets the component count. |
| GetBytesPerChannel() | Gets the bytes per channel. |
| GetBitDepth() | Gets the bit depth. This is the number of bits per channel. |
| GetBytesPerPixel() | Gets the bytes per pixel. |
| GetPixelCount() | Gets the pixel count. |
| GetByteCount() | Gets the total number of bytes allocated by images that are of this image format. |
| GetAspectRatio() | Gets the aspect ratio of this format. This is height / width. |
| SetROIDefinition(piROIDefinition) | Sets the ROI definition. |
Static Methods
| ToString(ePixelType) | Converts the given pixel type to a string. |
| ToString(eDataType) | Converts the given data type to a string. |
Operators
| operator==(xFormat) | Equality operator. |
| operator!=(xFormat) | Inequality operator. |
Variables
| m_iWidth | The width. |
| m_iHeight | The height. |
| m_eDataType | The data type. |
| m_ePixelType | The pixel type. |
| m_piROI | If this image format describes an image that is taken from a ROI of a larger area (e.g. a camera sensor), these 4 values describe the ROI: |
Typedefs
| TInt4 | Typedef for a int[4]. |