Raytrix Light Field SDK  4.0
Logo
Public Member Functions | List of all members
Rx::LFR::Net::SeqFileWriter Class Reference

Detailed Description

Provides methods for writing frames into a sequence in a rays file.

Inherits Rx::Net::NativeInterfaceWrapper< Rx::LFR::CSeqFileWriter, Rx::LFR::Net::Interfaces::ESeqFileWriter >.

Public Member Functions

 SeqFileWriter ()
 Default constructor. More...
 
 ~SeqFileWriter ()
 Destructor. Closes the opened file. More...
 
unsigned Close ()
 Closes the opened sequence file and stops the background buffer thread. More...
 
unsigned GetDoubleShotMode ()
 Gets the double shot mode that has been passed in StartWriting. More...
 
unsigned __int64 GetFileSize ()
 Gets the current file size in bytes. More...
 
unsigned GetFrameCount ()
 Gets the current number of frames in the opened sequence. More...
 
Rx::Net::ImageFormatGetFrameFormat ()
 Gets the frame format that has been passed in StartWriting. More...
 
unsigned GetFrameSize ()
 Gets the size of a frame in bytes. More...
 
virtual System::Object^  GetInterface (Rx::LFR::Net::Interfaces::ESeqFileWriter eData)
 Gets the interface. More...
 
unsigned GetUsedFrameBufferCount ()
 Gets the current number of used buffer slots. More...
 
bool IsOpen ()
 Queries if a file has been opened. More...
 
bool IsWriting ()
 Queries if StartWriting has been called. More...
 
void Open (System::String^ sFilename, unsigned uFrameBufferCount)
 Opens the given ray sequence for writing. More...
 
void StartWriting (Rx::Net::ImageFormat^ xFrameFormat, Calibration^ xCalib, Rx::Net::MetaData^ xMeta, unsigned uDoubleShotMode)
 Starts the write process. This starts the background buffer thread. More...
 
void WriteFrame (Rx::Net::Image^ xFrame)
 Writes the given frame at the current frame index. More...
 
void WriteFrame (Rx::LFR::Net::ConstImage^ xFrame)
 Writes the given frame at the current frame index. More...
 

Constructor & Destructor Documentation

Rx::LFR::Net::SeqFileWriter::SeqFileWriter ( )
inline

Default constructor.

Rx::LFR::Net::SeqFileWriter::~SeqFileWriter ( )
inline

Destructor. Closes the opened file.

Member Function Documentation

unsigned Rx::LFR::Net::SeqFileWriter::Close ( )
inline

Closes the opened sequence file and stops the background buffer thread.

Returns
The number of frames written.
unsigned Rx::LFR::Net::SeqFileWriter::GetDoubleShotMode ( )
inline

Gets the double shot mode that has been passed in StartWriting.

Returns
The double shot mode.
unsigned __int64 Rx::LFR::Net::SeqFileWriter::GetFileSize ( )
inline

Gets the current file size in bytes.

Returns
The file size.
unsigned Rx::LFR::Net::SeqFileWriter::GetFrameCount ( )
inline

Gets the current number of frames in the opened sequence.

Returns
The frame count.
Rx::Net::ImageFormat ^ Rx::LFR::Net::SeqFileWriter::GetFrameFormat ( )
inline

Gets the frame format that has been passed in StartWriting.

Returns
The frame format.
unsigned Rx::LFR::Net::SeqFileWriter::GetFrameSize ( )
inline

Gets the size of a frame in bytes.

Returns
The frame size.

Gets the interface.

Returns
The interface.
unsigned Rx::LFR::Net::SeqFileWriter::GetUsedFrameBufferCount ( )
inline

Gets the current number of used buffer slots.

Returns
The used frame buffer count.
bool Rx::LFR::Net::SeqFileWriter::IsOpen ( )
inline

Queries if a file has been opened.

Returns
True if open, false if not.
bool Rx::LFR::Net::SeqFileWriter::IsWriting ( )
inline

Queries if StartWriting has been called.

Returns
True if writing, false if not.
void Rx::LFR::Net::SeqFileWriter::Open ( System::String^  sFilename,
unsigned  uFrameBufferCount 
)
inline

Opens the given ray sequence for writing.

Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save feature.

Parameters
sFilename[in] The complete file path.
uFrameBufferCountNumber of frames to buffer. Must NOT be zero. Default is 2.
void Rx::LFR::Net::SeqFileWriter::StartWriting ( Rx::Net::ImageFormat xFrameFormat,
Calibration xCalib,
Rx::Net::MetaData^  xMeta,
unsigned  uDoubleShotMode 
)
inline

Starts the write process. This starts the background buffer thread.

Parameters
xFrameFormat[in] The frame format.
xCalib[in] The calibration.
xMeta[in] The meta data.
uDoubleShotModeThe double shot mode.
void Rx::LFR::Net::SeqFileWriter::WriteFrame ( Rx::Net::Image xFrame)
inline

Writes the given frame at the current frame index.

Parameters
xFrame[in] The frame.
void Rx::LFR::Net::SeqFileWriter::WriteFrame ( Rx::LFR::Net::ConstImage xFrame)
inline

Writes the given frame at the current frame index.

Parameters
xFrame[in] The frame.