Edit

class Input::Frames::Frame

Represents a Frame being passed into or retrieved from the Vision SDK.

Members

Properties

Syntax: public FrameProperties & Properties;

Gets a collection of additional Frame properties.

Data

Syntax: public const uint8_t * Data;

DataSizeInBytes

Syntax: public const size_t DataSizeInBytes;

~Frame

Syntax: public inline ~Frame ( );

Create

Syntax: public inline static std::shared_ptr< Frame > Create ( const uint8_t * data , size_t dataSizeInBytes );

Create a Frame that wraps a data buffer owned by the caller.

Parameters

  • data The data buffer.

  • dataSizeInBytes The data buffer size in bytes

Returns

A shared pointer to the newly created frame

CreateWithDataCopy

Syntax: public inline static std::shared_ptr< Frame > CreateWithDataCopy ( const uint8_t * data , size_t dataSizeInBytes );

Create a Frame that copies the data buffer provided by the caller.

Parameters

  • data The data buffer.

  • dataSizeInBytes The data buffer size in bytes

Returns

A shared pointer to the newly created frame