Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Rx::Net::ImageFormat Class Reference

Detailed Description

Image format.

Public Member Functions

 ImageFormat ()
 Default constructor. More...
 
 ImageFormat (ImageFormat^ xFormat)
 Copy constructor. More...
 
 ImageFormat (const Rx::CRxImageFormat &xFormat)
 Constructor. More...
 
 ImageFormat (int iWidth, int iHeight, Rx::InteropNet::Runtime28::EPixelType ePixelType, Rx::InteropNet::Runtime28::EDataType eDataType)
 Constructor. 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...
 
unsigned GetPixelCount ()
 
bool IsBayerPixelType ()
 Query if this object is of bayer pixel type. More...
 
void Reset ()
 Resets this object. More...
 
Rx::CRxImageFormat ToRxImageFormat ()
 Converts this ImageFormat to a Rx::CRxImageFormat. More...
 
virtual System::String^ ToString () override
 Convert this ImageFormat into a string representation. More...
 

Static Public Member Functions

static Rx::CRxImageFormat ToRxImageFormat (ImageFormat^ xImageFormat)
 Converts an ImageFormat to a Rx::CRxImageFormat. More...
 

Protected Attributes

Rx::InteropNet::Runtime28::EDataType m_eDataType
 Type of the data. More...
 
Rx::InteropNet::Runtime28::EPixelType m_ePixelType
 Type of the pixel. More...
 
int m_iHeight
 Zero-based index of the height. More...
 
int m_iWidth
 Zero-based index of the width. More...
 

Properties

Rx::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...
 
Rx::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 Rx::CRxImageFormat xFormat)
inline

Constructor.

Parameters
xFormatDescribes the format to use.
Rx::Net::ImageFormat::ImageFormat ( int  iWidth,
int  iHeight,
Rx::InteropNet::Runtime28::EPixelType  ePixelType,
Rx::InteropNet::Runtime28::EDataType  eDataType 
)
inline

Constructor.

Parameters
iWidthWidth.
iHeightHeight.
ePixelTypePixel type.
eDataTypeData type.

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.
unsigned Rx::Net::ImageFormat::GetPixelCount ( )
inline
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 Rx::CRxImageFormat Rx::Net::ImageFormat::ToRxImageFormat ( ImageFormat xImageFormat)
inlinestatic

Converts an ImageFormat to a Rx::CRxImageFormat.

Parameters
xImageFormat[in,out] The ImageFormat.
Returns
xImageFormat as a Rx::CRxImageFormat.
Rx::CRxImageFormat Rx::Net::ImageFormat::ToRxImageFormat ( )
inline

Converts this ImageFormat to a Rx::CRxImageFormat.

Returns
This ImageFormat as a Rx::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

Rx::InteropNet::Runtime28::EDataType Rx::Net::ImageFormat::m_eDataType
protected

Type of the data.

Rx::InteropNet::Runtime28::EPixelType Rx::Net::ImageFormat::m_ePixelType
protected

Type of the pixel.

int Rx::Net::ImageFormat::m_iHeight
protected

Zero-based index of the height.

int Rx::Net::ImageFormat::m_iWidth
protected

Zero-based index of the width.

Property Documentation

Rx:: 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.

Rx:: 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.