Time-of-Flight-SDK
Public Member Functions | List of all members
aditof::Frame Class Reference

Frame of a camera. More...

#include <frame.h>

Public Member Functions

SDK_API Frame ()
 Constructor.
 
SDK_API ~Frame ()
 Destructor.
 
SDK_API Frame (const Frame &op)
 Copy constructor.
 
SDK_API Frameoperator= (const Frame &op)
 Copy assignment.
 
SDK_API Frame (Frame &&) noexcept
 Move constructor.
 
SDK_API Frameoperator= (Frame &&) noexcept
 Move assignment.
 
SDK_API Status setDetails (const FrameDetails &details)
 Configures the frame with the given details. More...
 
SDK_API Status getDetails (FrameDetails &details) const
 Gets the current details of the frame. More...
 
SDK_API Status getData (FrameDataType dataType, uint16_t **dataPtr)
 Gets the address where the specified data is being stored. More...
 

Detailed Description

Frame of a camera.

Definition at line 49 of file frame.h.

Member Function Documentation

◆ getData()

SDK_API Status aditof::Frame::getData ( FrameDataType  dataType,
uint16_t **  dataPtr 
)

Gets the address where the specified data is being stored.

Parameters
dataType
[out]dataPtr
Returns
Status

◆ getDetails()

SDK_API Status aditof::Frame::getDetails ( FrameDetails details) const

Gets the current details of the frame.

Parameters
[out]details
Returns
Status

◆ setDetails()

SDK_API Status aditof::Frame::setDetails ( const FrameDetails details)

Configures the frame with the given details.

Parameters
details
Returns
Status

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