Rx::Net::ImageFormat Class Reference

Detailed Description

Image format.

Public Member Functions
	ImageFormat ()
	Default constructor. More...
	ImageFormat (ImageFormat^ xFormat)
	Copy constructor. More...
	ImageFormat (const CRxImageFormat &xFormat)
	Constructor. More...
	ImageFormat (int iWidth, int iHeight, InteropNet::Runtime28::EPixelType ePixelType, InteropNet::Runtime28::EDataType eDataType)
	Constructor. More...
	~ImageFormat ()
	Destructor. More...
bool	Equals (ImageFormat^ xFormat)
	Tests if this ImageFormat^ is considered equal to another. More...
unsigned	GetByteCount ()
	Gets the byte count. More...
int	GetBytesPerPixel ()
	Gets the bytes per pixel. More...
int	GetComponentCount ()
	Gets the component count. More...
const CRxImageFormat &	GetNative ()
	Gets the native CRxImageFormat. More...
unsigned	GetPixelCount ()
	Gets the pixel count. More...
bool	HasCustomDataType ()
	Returns true if the data type of this image format is one of the custom (non primitive) data types. More...
bool	IsBayerPixelType ()
	Query if this object is of bayer pixel type. More...
void	Reset ()
	Resets this object. More...
CRxImageFormat	ToNative ()
	Converts this ImageFormat to a CRxImageFormat. More...
virtual System::String^	ToString () override
	Convert this ImageFormat into a string representation. More...

Static Public Member Functions
static CRxImageFormat	ToNative (ImageFormat^ xImageFormat)
	Converts an ImageFormat to a CRxImageFormat. More...

Protected Attributes
CRxImageFormat *	m_pxNative
	The native image format. More...

Properties
InteropNet::Runtime28::EDataType	DataType [get, set]
	Gets or sets the type of the data. More...
int	Height [get, set]
	Gets or sets the height. More...
InteropNet::Runtime28::EPixelType	PixelType [get, set]
	Gets or sets the type of the pixel. More...
int	Width [get, set]
	Gets or sets the width. More...

Constructor & Destructor Documentation

Rx::Net::ImageFormat::ImageFormat ( )

inline

Default constructor.

Rx::Net::ImageFormat::ImageFormat ( ImageFormat^  xFormat )

inline

Copy constructor.

Parameters

xFormat

[in] If non-null, describes the format to use.

Rx::Net::ImageFormat::ImageFormat ( const CRxImageFormat &  xFormat )

inline

Constructor.

Parameters

xFormat

Describes the format to use.

Rx::Net::ImageFormat::ImageFormat ( int  iWidth, int  iHeight, InteropNet::Runtime28::EPixelType  ePixelType, InteropNet::Runtime28::EDataType  eDataType  )

inline

Constructor.

Parameters

iWidth	Width.
iHeight	Height.
ePixelType	Pixel type.
eDataType	Data type.

Rx::Net::ImageFormat::~ImageFormat ( )

inline

Destructor.

Member Function Documentation

bool Rx::Net::ImageFormat::Equals ( ImageFormat^  xFormat )

inline

Tests if this ImageFormat^ is considered equal to another.

Parameters

xFormat

[in] If non-null, the image format^ to compare to this object.

Returns

True if the objects are considered equal, false if they are not.

unsigned Rx::Net::ImageFormat::GetByteCount ( )

inline

Gets the byte count.

Returns

The byte count.

int Rx::Net::ImageFormat::GetBytesPerPixel ( )

inline

Gets the bytes per pixel.

Returns

The bytes per pixel.

int Rx::Net::ImageFormat::GetComponentCount ( )

inline

Gets the component count.

Returns

The component count.

const CRxImageFormat& Rx::Net::ImageFormat::GetNative ( )

inline

Gets the native CRxImageFormat.

Returns

The native image format.

unsigned Rx::Net::ImageFormat::GetPixelCount ( )

inline

Gets the pixel count.

Returns

The pixel count.

bool Rx::Net::ImageFormat::HasCustomDataType ( )

inline

Returns true if the data type of this image format is one of the custom (non primitive) data types.

Returns

True if the data type is custom, false if not.

bool Rx::Net::ImageFormat::IsBayerPixelType ( )

inline

Query if this object is of bayer pixel type.

Returns

True if of bayer pixel type, false if not.

void Rx::Net::ImageFormat::Reset ( )

inline

Resets this object.

static CRxImageFormat Rx::Net::ImageFormat::ToNative ( ImageFormat^  xImageFormat )

inlinestatic

Converts an ImageFormat to a CRxImageFormat.

Parameters

xImageFormat

[in] The ImageFormat.

Returns

xImageFormat as a CRxImageFormat.

CRxImageFormat Rx::Net::ImageFormat::ToNative ( )

inline

Converts this ImageFormat to a CRxImageFormat.

Returns

This ImageFormat as a CRxImageFormat.

virtual System::String ^ Rx::Net::ImageFormat::ToString ( )

inlineoverridevirtual

Convert this ImageFormat into a string representation.

Returns

This ImageFormat as a System::String^.

Member Data Documentation

CRxImageFormat* Rx::Net::ImageFormat::m_pxNative

protected

The native image format.

Property Documentation

InteropNet:: Runtime28:: EDataType Rx::Net::ImageFormat::DataType

getset

Gets or sets the type of the data.

int Rx::Net::ImageFormat::Height

getset

Gets or sets the height.

InteropNet:: Runtime28:: EPixelType Rx::Net::ImageFormat::PixelType

getset

Gets or sets the type of the pixel.

int Rx::Net::ImageFormat::Width

getset

Gets or sets the width.