Raytrix Light Field SDK
5.0
|
Image format descriptor.
Public Types | |
typedef int | TInt4[4] |
Typedef for a int[4]. More... | |
Public Member Functions | |
RX_CUDA_EXP | CRxImageFormat () |
Default constructor. More... | |
RX_CUDA_EXP | CRxImageFormat (int iWidth, int iHeight, Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType) |
Default constructor. More... | |
RX_CUDA_EXP | CRxImageFormat (int iWidthPX, int iHeightPX) |
Constructor. Defines only the width and the height. More... | |
RX_CUDA_EXP | ~CRxImageFormat () |
Destructor. More... | |
float | GetAspectRatio () const |
Gets the aspect ratio of this format. This is height / width. More... | |
RX_CUDA_EXP int | GetBitDepth () const |
Gets the bit depth. This is the number of bits per channel. More... | |
RX_CUDA_EXP unsigned | GetByteCount () const |
Gets the total number of bytes allocated by images that are of this image format. More... | |
RX_CUDA_EXP int | GetBytesPerChannel () const |
Gets the bytes per channel. More... | |
RX_CUDA_EXP int | GetBytesPerPixel () const |
Gets the bytes per pixel. More... | |
RX_CUDA_EXP int | GetComponentCount () const |
Gets the component count. More... | |
RX_CUDA_EXP unsigned | GetPixelCount () const |
Gets the pixel count. More... | |
RX_CUDA_EXP bool | HasCustomDataType () const |
Returns true if the data type of this image format is one of the custom (non primitive) data types. More... | |
RX_CUDA_EXP bool | IsBayerPixelType () const |
Query if this CRxImageFormat is bayer pixel type. More... | |
template<class TPix > | |
RX_CUDA_EXP bool | IsOfType () const |
Test whether format is of particular pixel type. More... | |
RX_CUDA_EXP bool | IsValid () const |
Query if this object is valid. More... | |
RX_CUDA_EXP bool | operator!= (const CRxImageFormat &xFormat) const |
Inequality operator. More... | |
RX_CUDA_EXP bool | operator== (const CRxImageFormat &xFormat) const |
Equality operator. More... | |
RX_CUDA_EXP void | Reset () |
Resets this CRxImageFormat. More... | |
void | SetROIDefinition (const TInt4 &piROIDefinition) |
Sets the ROI definition. More... | |
CRxString | ToString () const |
Convert this CRxImageFormat into a string representation. More... | |
Static Public Member Functions | |
static CRxString | ToString (Interop::Runtime28::EDataType::ID eDataType) |
Converts the given data type to a string. More... | |
static CRxString | ToString (Interop::Runtime28::EPixelType::ID ePixelType) |
Converts the given pixel type to a string. More... | |
Public Attributes | |
Interop::Runtime28::EDataType::ID | m_eDataType |
The data type. More... | |
Interop::Runtime28::EPixelType::ID | m_ePixelType |
The pixel type. More... | |
int | m_iHeight |
The height. More... | |
int | m_iWidth |
The width. More... | |
TInt4 | 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: More... | |
typedef int Rx::CRxImageFormat::TInt4[4] |
Typedef for a int[4].
|
inline |
Default constructor.
|
inline |
Constructor. Defines only the width and the height.
iWidthPX | The width in pixels. |
iHeightPX | The height in pixels. |
|
inline |
Default constructor.
|
inline |
Destructor.
|
inline |
Gets the aspect ratio of this format. This is height / width.
|
inline |
Gets the bit depth. This is the number of bits per channel.
|
inline |
Gets the total number of bytes allocated by images that are of this image format.
|
inline |
Gets the bytes per channel.
|
inline |
Gets the bytes per pixel.
|
inline |
Gets the component count.
|
inline |
Gets the pixel count.
|
inline |
Returns true if the data type of this image format is one of the custom (non primitive) data types.
|
inline |
Query if this CRxImageFormat is bayer pixel type.
|
inline |
Test whether format is of particular pixel type.
This function uses the static function IsOfType() of the pixel types to check whether the given template parameter pixel type matches the pixel and data types of this instance.
TPix | The pixel type. |
|
inline |
Query if this object is valid.
|
inline |
Inequality operator.
xFormat | Describes the format to use. |
|
inline |
Equality operator.
xFormat | Describes the format to use. |
|
inline |
Resets this CRxImageFormat.
|
inline |
Sets the ROI definition.
piROIDefinition | The ROI definition. |
|
inline |
Convert this CRxImageFormat into a string representation.
|
inlinestatic |
Converts the given data type to a string.
eDataType | The data type. |
|
inlinestatic |
Converts the given pixel type to a string.
ePixelType | The pixel type. |
Interop::Runtime28::EDataType::ID Rx::CRxImageFormat::m_eDataType |
The data type.
Interop::Runtime28::EPixelType::ID Rx::CRxImageFormat::m_ePixelType |
The pixel type.
int Rx::CRxImageFormat::m_iHeight |
The height.
int Rx::CRxImageFormat::m_iWidth |
The width.
TInt4 Rx::CRxImageFormat::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: