Detailed Description

Image format.

Public Member Functions
	ImageFormat ()
	Default constructor. More...

	ImageFormat (const CRxImageFormat &xFormat)
	Constructor. More...

	ImageFormat (ImageFormat^ xFormat)
	Copy constructor. More...

	ImageFormat (int iWidth, int iHeight, InteropNet::Runtime28::EPixelType ePixelType, InteropNet::Runtime28::EDataType eDataType)
	Constructor. More...

	!ImageFormat ()
	Finalizer. 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...

bool	IsValid ()
	Query if this object is valid. 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...

array< int >^	ROI `[get]`
	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...

int	Width `[get, set]`
	Gets or sets the width. More...

Constructor & Destructor Documentation

◆ ImageFormat() [1/4]

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

inline

Default constructor.

◆ ImageFormat() [2/4]

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

inline

Copy constructor.

Parameters

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

◆ ImageFormat() [3/4]

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

inline

Constructor.

Parameters

xFormat Describes the format to use.

◆ ImageFormat() [4/4]

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.

◆ ~ImageFormat()

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

inline

Destructor.

◆ !ImageFormat()

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

inline

Finalizer.

Member Function Documentation

◆ Equals()

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.

◆ GetByteCount()

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

inline

Gets the byte count.

Returns: The byte count.

◆ GetBytesPerPixel()

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

inline

Gets the bytes per pixel.

Returns: The bytes per pixel.

◆ GetComponentCount()

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

inline

Gets the component count.

Returns: The component count.

◆ GetNative()

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

inline

Gets the native CRxImageFormat.

Returns: The native image format.

◆ GetPixelCount()

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

inline

Gets the pixel count.

Returns: The pixel count.

◆ HasCustomDataType()

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.

◆ IsBayerPixelType()

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.

◆ IsValid()

bool Rx::Net::ImageFormat::IsValid ( )

inline

Query if this object is valid.

Returns: True if valid, false if not.

◆ Reset()

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

inline

Resets this object.

◆ ToNative() [1/2]

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

inline

Converts this ImageFormat to a CRxImageFormat.

Returns: This ImageFormat as a CRxImageFormat.

◆ ToNative() [2/2]

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.

◆ ToString()

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

◆ m_pxNative

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

protected

The native image format.

Property Documentation

◆ DataType

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

getset

Gets or sets the type of the data.

◆ Height

int Rx::Net::ImageFormat::Height

getset

Gets or sets the height.

◆ PixelType

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

getset

Gets or sets the type of the pixel.

◆ ROI

array< int>^ Rx::Net::ImageFormat::ROI

get

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:

(ROI[0], ROI[1]) is the pixel offset from the top left corner of the larger area to the top left corner of the image.
(ROI[2], ROI[3]) is the pixel offset from the bottom right corner of the larger area to the bottom right corner of the image.

◆ Width

int Rx::Net::ImageFormat::Width

getset

Gets or sets the width.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties

Constructor & Destructor Documentation

◆ ImageFormat() [1/4]

◆ ImageFormat() [2/4]

◆ ImageFormat() [3/4]

◆ ImageFormat() [4/4]

◆ ~ImageFormat()

◆ !ImageFormat()

Member Function Documentation

◆ Equals()

◆ GetByteCount()

◆ GetBytesPerPixel()

◆ GetComponentCount()

◆ GetNative()

◆ GetPixelCount()

◆ HasCustomDataType()

◆ IsBayerPixelType()

◆ IsValid()

◆ Reset()

◆ ToNative() [1/2]

◆ ToNative() [2/2]

◆ ToString()

Member Data Documentation

◆ m_pxNative

Property Documentation

◆ DataType

◆ Height

◆ PixelType

◆ ROI

◆ Width