tsvb::ILockedFrameData Class Reference

Access to the data inside IFrame. More...

#include <vb_sdk/frame.h>

Inheritance diagram for tsvb::ILockedFrameData:

Public Member Functions
virtual unsigned int	bytesPerLine (int planarIndex) const =0
	Returns the number of bytes per line.
virtual void *	dataPointer (int planarIndex)=0
	Returns pointer to component data.
Public Member Functions inherited from tsvb::IRelease
virtual void	release ()=0
	Releases the memory that was allocated for the object.

Detailed Description

Access to the data inside IFrame.

Obtained with IFrame::lock(). Don't use the IFrame until ILockedFrameData is released.

If obtained with FrameLock::write or FrameLock::readWrite, the changes are applied after ILockedFrameData is released. If obtained with FrameLock::read, don't change the data.

Member Function Documentation

bytesPerLine()

virtual unsigned int tsvb::ILockedFrameData::bytesPerLine ( int planarIndex ) const

pure virtual

Returns the number of bytes per line.

Parameters

planarIndex

See dataPointer().

dataPointer()

virtual void * tsvb::ILockedFrameData::dataPointer ( int planarIndex )

pure virtual

Returns pointer to component data.

Parameters

planarIndex

Depends on the frame format. For FrameFormat::bgra32 and FrameFormat::rgba32 always use 0. For FrameFormat::nv12, 0 returns pointer to the Y component, 1 returns pointer to the UV component.

---

The documentation for this class was generated from the following file:

• vb_sdk/frame.h