Public Attributes | List of all members
aditof::FrameDataDetails Struct Reference

Describes the properties of a data that embedded within the frame. More...

#include <frame_definitions.h>

Public Attributes

unsigned int bytesCount
 The total number of bytes that the data has. This can be useful when copying data to another location or when saving data to a file or any other usecase where the size in bytes needs to be known. More...
 
unsigned int height
 The height of the frame data. More...
 
unsigned int subelementSize
 The size in bytes of a sub-element. A sub-element is a sub-component of an element. All sub-elements make up an element. For instance a 3D point (which is an element) has X, Y and Z coordinates which are sub-elements of the 3D point. More...
 
unsigned int subelementsPerElement
 The number of sub-elements that an element has. An element is the smallest part of the image (a.k.a. captured scene) that together with other elements make up the entire image. More...
 
std::string type
 The type of data that can be found in a frame. For example it could be depth data or IR data, etc. More...
 
unsigned int width
 The width of the frame data. More...
 

Detailed Description

Describes the properties of a data that embedded within the frame.

Definition at line 48 of file frame_definitions.h.

Member Data Documentation

◆ bytesCount

unsigned int aditof::FrameDataDetails::bytesCount

The total number of bytes that the data has. This can be useful when copying data to another location or when saving data to a file or any other usecase where the size in bytes needs to be known.

Definition at line 86 of file frame_definitions.h.

◆ height

unsigned int aditof::FrameDataDetails::height

The height of the frame data.

Definition at line 63 of file frame_definitions.h.

◆ subelementSize

unsigned int aditof::FrameDataDetails::subelementSize

The size in bytes of a sub-element. A sub-element is a sub-component of an element. All sub-elements make up an element. For instance a 3D point (which is an element) has X, Y and Z coordinates which are sub-elements of the 3D point.

Definition at line 71 of file frame_definitions.h.

◆ subelementsPerElement

unsigned int aditof::FrameDataDetails::subelementsPerElement

The number of sub-elements that an element has. An element is the smallest part of the image (a.k.a. captured scene) that together with other elements make up the entire image.

Definition at line 78 of file frame_definitions.h.

◆ type

std::string aditof::FrameDataDetails::type

The type of data that can be found in a frame. For example it could be depth data or IR data, etc.

Definition at line 53 of file frame_definitions.h.

◆ width

unsigned int aditof::FrameDataDetails::width

The width of the frame data.

Definition at line 58 of file frame_definitions.h.


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


libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:06