Wikitude Unity Expert Edition
Public Member Functions | Public Attributes | List of all members
Wikitude.CameraFrame Class Reference

A class that contains color frames, along with their metadata. More...

Public Member Functions

 CameraFrame (long frameId, long colorTimestamp, ColorCameraFrameMetadata colorMetadata, List< CameraFramePlane > colorData)
 Constructs a camera frame that should be analyzed and optionally rendered to the screen. More...
 
 CameraFrame (long frameId, long colorTimestamp, ColorCameraFrameMetadata colorMetadata, List< CameraFramePlane > colorData, Matrix4x4 pose)
 Constructs a camera frame that should be analyzed and optionally rendered to the screen. More...
 

Public Attributes

long FrameId => _frameId
 Unique id used to identify individual frames. More...
 
long ColorTimestamp => _colorTimestamp
 The timestamp for the color frame. More...
 
ColorCameraFrameMetadata ColorMetadata => _colorMetadata
 The metadata associated with the color frame. More...
 
List< CameraFramePlaneColorData => _colorData
 A list of planes of the camera data. More...
 

Detailed Description

A class that contains color frames, along with their metadata.

Constructor & Destructor Documentation

Wikitude.CameraFrame.CameraFrame ( long  frameId,
long  colorTimestamp,
ColorCameraFrameMetadata  colorMetadata,
List< CameraFramePlane colorData 
)
inline

Constructs a camera frame that should be analyzed and optionally rendered to the screen.

Parameters
frameIdA unique ID for this frame
colorTimestampThe timestamp for the color data
colorMetadataAdditional information that describes the frame
colorDataA list of planes that contain the frame data
Wikitude.CameraFrame.CameraFrame ( long  frameId,
long  colorTimestamp,
ColorCameraFrameMetadata  colorMetadata,
List< CameraFramePlane colorData,
Matrix4x4  pose 
)
inline

Constructs a camera frame that should be analyzed and optionally rendered to the screen.

Parameters
frameIdA unique ID for this frame
colorTimestampThe timestamp for the color data
colorMetadataAdditional information that describes the frame
colorDataA list of planes that contain the frame data
poseThe pose associated with this frame, tracked by an external tracking system

Member Data Documentation

List<CameraFramePlane> Wikitude.CameraFrame.ColorData => _colorData

A list of planes of the camera data.

ColorCameraFrameMetadata Wikitude.CameraFrame.ColorMetadata => _colorMetadata

The metadata associated with the color frame.

long Wikitude.CameraFrame.ColorTimestamp => _colorTimestamp

The timestamp for the color frame.

long Wikitude.CameraFrame.FrameId => _frameId

Unique id used to identify individual frames.