Rx::FileIO::CTrixWriter Class Reference

Detailed Description

TRIX file writer.

Public Member Functions
	CTrixWriter ()
	Default constructor. More...
	~CTrixWriter ()
	Destructor. More...
void	Close ()
	Closes this CTrixWriter 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=nullptr, Codec::IImageCodec *pxDepthCodec=nullptr, Codec::IImageCodec *pxDepth3DCodec=nullptr)
	Saves a frame pair. More...

Constructor & Destructor Documentation

CTrixWriter()

Rx::FileIO::CTrixWriter::CTrixWriter

(

)

Default constructor.

~CTrixWriter()

Rx::FileIO::CTrixWriter::~CTrixWriter

(

)

Destructor.

Member Function Documentation

Close()

void Rx::FileIO::CTrixWriter::Close

(

)

Closes this CTrixWriter and finalizes the file.

GetApproximatedFileSize()

size_t Rx::FileIO::CTrixWriter::GetApproximatedFileSize

(

)

Gets approximated file size.

Returns

The approximated file size.

Open()

void Rx::FileIO::CTrixWriter::Open

(

const CRxString &

sxFilename

)

Opens a new file for write.

Parameters

sxFilename

The filename.

WriteFrame()

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

Saves a frame pair.

Parameters

xFocusImg	The focus image.
xDepthImg	The depth image. Must be of float lumincance type and will be scaled to 0.0-1.0.
xDepth3DImg	The in pixels depth 3D image.
pxFocusCodec	[in,out] (Optional) The focus codec. nullptr = Raw Image.
pxDepthCodec	[in,out] (Optional) The depth codec. nullptr = Raw Image.
pxDepth3DCodec	[in,out] (Optional) If non-null, (Optional) the in pixels depth 3D codec.

Returns

The frame index.