Raytrix Light Field SDK  5.0
Rx::Interop::Runtime30::IMemory2DAccess Class Referenceabstract

Detailed Description

Interface for 2D memory read operations.

Inherited by Rx::Interop::Runtime30::IMemory2D.

Public Member Functions

virtual size_t GetElementSize () const =0
 Gets the element size. The memory block is made up of blocks of the given number of bytes. The function Length() returns the number of elements in the memory block, where each element is of the size given in GetElementSize(). For example, an array of 10 doubles has element size 8 and length 10. More...
 
virtual const void * GetPointer () const =0
 Gets the pointer to memory. More...
 
virtual void GetSize (size_t &nRows, size_t &nCols) const =0
 Gets the number of elements in the memory block. The total number of bytes allocated by the memory block is given by the nRows times nCols times the element size. More...
 
virtual bool IsValid () const =0
 Query if this object is valid. This function returns also true if the object itself is valid but the memory block has size zero. More...
 

Protected Member Functions

virtual ~IMemory2DAccess ()
 Destructor. More...
 

Constructor & Destructor Documentation

◆ ~IMemory2DAccess()

virtual Rx::Interop::Runtime30::IMemory2DAccess::~IMemory2DAccess ( )
inlineprotectedvirtual

Destructor.

Member Function Documentation

◆ GetElementSize()

virtual size_t Rx::Interop::Runtime30::IMemory2DAccess::GetElementSize ( ) const
pure virtual

Gets the element size. The memory block is made up of blocks of the given number of bytes. The function Length() returns the number of elements in the memory block, where each element is of the size given in GetElementSize(). For example, an array of 10 doubles has element size 8 and length 10.

Returns
The element size in bytes.

Implemented in Rx::CRxArray2DBase< TValue >, Rx::CRxArray2DDouble, and Rx::CRxArray2DInt.

◆ GetPointer()

virtual const void* Rx::Interop::Runtime30::IMemory2DAccess::GetPointer ( ) const
pure virtual

Gets the pointer to memory.

Returns
The pointer to memory.

Implemented in Rx::CRxArray2DBase< TValue >, Rx::CRxArray2DDouble, and Rx::CRxArray2DInt.

◆ GetSize()

virtual void Rx::Interop::Runtime30::IMemory2DAccess::GetSize ( size_t &  nRows,
size_t &  nCols 
) const
pure virtual

Gets the number of elements in the memory block. The total number of bytes allocated by the memory block is given by the nRows times nCols times the element size.

Parameters
nRows[out] The number of rows.
nCols[out] The number of columns.

Implemented in Rx::CRxArray2DBase< TValue >, Rx::CRxArray2DDouble, and Rx::CRxArray2DInt.

◆ IsValid()

virtual bool Rx::Interop::Runtime30::IMemory2DAccess::IsValid ( ) const
pure virtual

Query if this object is valid. This function returns also true if the object itself is valid but the memory block has size zero.

Returns
True if valid, false if not.

Implemented in Rx::CRxArray2DBase< TValue >, Rx::CRxArray2DDouble, and Rx::CRxArray2DInt.