Rx::CRxImageFormat Class Reference

Detailed Description

Image format descriptor.

Public Member Functions
RX_CUDA_EXP	CRxImageFormat ()
	Default constructor. More...
RX_CUDA_EXP	CRxImageFormat (int iWidth, int iHeight, Rx::Interop::Runtime28::EPixelType::ID ePixelType, Rx::Interop::Runtime28::EDataType::ID eDataType)
	Default constructor. More...
RX_CUDA_EXP	~CRxImageFormat ()
	Destructor. More...
RX_CUDA_EXP unsigned	GetByteCount () const
	Gets the byte count. 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	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	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...
Rx::CRxString	ToString () const
	Convert this CRxImageFormat into a string representation. More...

Static Public Member Functions
static Rx::CRxString	DataType2String (Rx::Interop::Runtime28::EDataType::ID eDataType)
	Converts the given data type to a string. More...
static Rx::CRxString	PixelType2String (Rx::Interop::Runtime28::EPixelType::ID ePixelType)
	Converts the given pixel type to a string. More...

Public Attributes
Rx::Interop::Runtime28::EDataType::ID	m_eDataType
Rx::Interop::Runtime28::EPixelType::ID	m_ePixelType
int	m_iHeight
int	m_iWidth

Constructor & Destructor Documentation

RX_CUDA_EXP Rx::CRxImageFormat::CRxImageFormat ( )

inline

Default constructor.

RX_CUDA_EXP Rx::CRxImageFormat::CRxImageFormat ( int  iWidth, int  iHeight, Rx::Interop::Runtime28::EPixelType::ID  ePixelType, Rx::Interop::Runtime28::EDataType::ID  eDataType  )

inline

Default constructor.

RX_CUDA_EXP Rx::CRxImageFormat::~CRxImageFormat ( )

inline

Destructor.

Member Function Documentation

static Rx::CRxString Rx::CRxImageFormat::DataType2String ( Rx::Interop::Runtime28::EDataType::ID  eDataType )

inlinestatic

Converts the given data type to a string.

Parameters

eDataType

Data type.

Returns

The data type as a string.

RX_CUDA_EXP unsigned Rx::CRxImageFormat::GetByteCount ( ) const

inline

Gets the byte count.

Returns

The byte count.

RX_CUDA_EXP int Rx::CRxImageFormat::GetBytesPerPixel ( ) const

inline

Gets the bytes per pixel.

Returns

The bytes per pixel.

RX_CUDA_EXP int Rx::CRxImageFormat::GetComponentCount ( ) const

inline

Gets the component count.

Returns

The component count.

RX_CUDA_EXP unsigned Rx::CRxImageFormat::GetPixelCount ( ) const

inline

Gets the pixel count.

Returns

The pixel count.

RX_CUDA_EXP bool Rx::CRxImageFormat::IsBayerPixelType ( ) const

inline

Query if this CRxImageFormat is bayer pixel type.

Returns

True if bayer pixel type, false if not.

template<class TPix >

RX_CUDA_EXP bool Rx::CRxImageFormat::IsOfType ( ) const

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.

Template Parameters

TPix	Type of the pix.

Returns

True if of type< t pix>, false if not.

RX_CUDA_EXP bool Rx::CRxImageFormat::operator!= ( const CRxImageFormat &  xFormat ) const

inline

Inequality operator.

Parameters

xFormat

Describes the format to use.

Returns

True if the parameters are not considered equivalent.

RX_CUDA_EXP bool Rx::CRxImageFormat::operator== ( const CRxImageFormat &  xFormat ) const

inline

Equality operator.

Parameters

xFormat

Describes the format to use.

Returns

True if the parameters are considered equivalent.

static Rx::CRxString Rx::CRxImageFormat::PixelType2String ( Rx::Interop::Runtime28::EPixelType::ID  ePixelType )

inlinestatic

Converts the given pixel type to a string.

Parameters

ePixelType

Pixel type.

Returns

The pixel type as a string.

RX_CUDA_EXP void Rx::CRxImageFormat::Reset ( )

inline

Resets this CRxImageFormat.

Rx::CRxString Rx::CRxImageFormat::ToString ( ) const

inline

Convert this CRxImageFormat into a string representation.

Returns

This CRxImageFormat as a std::string.

Member Data Documentation

Rx::Interop::Runtime28::EDataType::ID Rx::CRxImageFormat::m_eDataType

Rx::Interop::Runtime28::EPixelType::ID Rx::CRxImageFormat::m_ePixelType

int Rx::CRxImageFormat::m_iHeight

int Rx::CRxImageFormat::m_iWidth