Raytrix Light Field SDK  5.0
Rx::InteropNet::Runtime28::IImage Interface Reference

Detailed Description

Interface for images. We use enums as parameters for interface functions as they are not version dependent. That is, if the enum definition is extended in a later version of this assembly, the enum classes stay compatible.

Inherited by Rx::Net::Image.

Public Member Functions

bool Create (int iWidth, int iHeight, EPixelType ePixelType, EDataType eDataType)
 Prepares memory. More...
 
bool Destroy ()
 Destroys this IImage. Thus, all used memory is freed. More...
 
int GetBytesPerPixel ()
 Gets the bytes per pixel. More...
 
void * GetDataPtr ()
 Gets the data pointer. More...
 

Properties

EDataType DataType [get]
 Gets the identifier of the data type. More...
 
int Height [get]
 Gets the height. More...
 
bool IsValid [get]
 Gets a value indicating whether this IImage is valid. More...
 
EPixelType PixelType [get]
 Gets the identifier of the pixel type. More...
 
int Width [get]
 Gets the width. More...
 

Member Function Documentation

◆ Create()

bool Rx::InteropNet::Runtime28::IImage::Create ( int  iWidth,
int  iHeight,
EPixelType  ePixelType,
EDataType  eDataType 
)

Prepares memory.

Parameters
iWidthThe width.
iHeightThe height.
ePixelTypeIdentifier for the image type.
eDataTypeIdentifier for the data type.
Returns
True if it succeeds, false if it fails.

◆ Destroy()

bool Rx::InteropNet::Runtime28::IImage::Destroy ( )

Destroys this IImage. Thus, all used memory is freed.

Returns
True if it succeeds, false if it fails.

Implemented in Rx::Net::Image.

◆ GetBytesPerPixel()

int Rx::InteropNet::Runtime28::IImage::GetBytesPerPixel ( )

Gets the bytes per pixel.

Returns
The bytes per pixel.

Implemented in Rx::Net::Image.

◆ GetDataPtr()

void* Rx::InteropNet::Runtime28::IImage::GetDataPtr ( )

Gets the data pointer.

Returns
Null if it fails, else the data pointer.

Implemented in Rx::Net::Image.

Property Documentation

◆ DataType

EDataType Rx::InteropNet::Runtime28::IImage::DataType
get

Gets the identifier of the data type.

◆ Height

int Rx::InteropNet::Runtime28::IImage::Height
get

Gets the height.

◆ IsValid

bool Rx::InteropNet::Runtime28::IImage::IsValid
get

Gets a value indicating whether this IImage is valid.

◆ PixelType

EPixelType Rx::InteropNet::Runtime28::IImage::PixelType
get

Gets the identifier of the pixel type.

◆ Width

int Rx::InteropNet::Runtime28::IImage::Width
get

Gets the width.