Raytrix Light Field SDK  5.0
Rx::FileIO::CTrixBaseWriter Class Reference

Detailed Description

TRIX File Base Writer.

Inherits Rx::FileIO::CTrixBase.

Public Member Functions

 CTrixBaseWriter ()
 Default constructor. More...
 
 ~CTrixBaseWriter ()
 Destructor. More...
 
void Close ()
 Closes this CTrixBaseWriter and finalizes the file. More...
 
size_t GetApproximatedFileSize ()
 Gets approximated file size. More...
 
void Open (const CRxString &sxFilename)
 Opens a new file for write. More...
 
size_t WriteFrame (const CRxImage &xFocusImg, const CRxImage &xDepthImg, const CRxImage &xDepth3DImg, Codec::IImageCodec *pxFocusCodec=NULL, Codec::IImageCodec *pxDepthCodec=NULL, Codec::IImageCodec *pxDepth3DCodec=NULL)
 Writes a frame. More...
 

Static Public Member Functions

static const CRxStringGetGuid ()
 Gets the unique identifier of this type. More...
 
static unsigned GetVersion ()
 Gets the version. More...
 

Constructor & Destructor Documentation

◆ CTrixBaseWriter()

Rx::FileIO::CTrixBaseWriter::CTrixBaseWriter ( )

Default constructor.

◆ ~CTrixBaseWriter()

Rx::FileIO::CTrixBaseWriter::~CTrixBaseWriter ( )

Destructor.

Member Function Documentation

◆ Close()

void Rx::FileIO::CTrixBaseWriter::Close ( )

Closes this CTrixBaseWriter and finalizes the file.

◆ GetApproximatedFileSize()

size_t Rx::FileIO::CTrixBaseWriter::GetApproximatedFileSize ( )

Gets approximated file size.

Returns
The approximated file size.

◆ GetGuid()

static const CRxString& Rx::FileIO::CTrixBase::GetGuid ( )
staticinherited

Gets the unique identifier of this type.

Returns
The unique identifier.

◆ GetVersion()

static unsigned Rx::FileIO::CTrixBase::GetVersion ( )
staticinherited

Gets the version.

Returns
The version.

◆ Open()

void Rx::FileIO::CTrixBaseWriter::Open ( const CRxString sxFilename)

Opens a new file for write.

Parameters
sxFilenameThe filename.

◆ WriteFrame()

size_t Rx::FileIO::CTrixBaseWriter::WriteFrame ( const CRxImage xFocusImg,
const CRxImage xDepthImg,
const CRxImage xDepth3DImg,
Codec::IImageCodec *  pxFocusCodec = NULL,
Codec::IImageCodec *  pxDepthCodec = NULL,
Codec::IImageCodec *  pxDepth3DCodec = NULL 
)

Writes a frame.

Parameters
xFocusImgThe focus image.
xDepthImgThe depth image.
xDepth3DImgThe depth 3D image.
pxFocusCodec[in,out] If non-null, the focus codec.
pxDepthCodec[in,out] If non-null, the depth codec.
pxDepth3DCodec[in,out] If non-null, the depth 3d codec.
Returns
.