QarAppVolumeInit Struct

Declaration

struct QarAppVolumeInit { ... }

Included Headers

#include <qar-streaming-c/include/qar_streaming.h>

Public Member Attributes Index

QarPose	app_pose
float	app_scale
QarGeoAnchorFrame	app_world_anchor
const char *	common_name
const char *	display_name
	UTF-8 label shown to users; any characters, emoji included. More...
const QarAppVolumeGestureConfiguration *	gesture_configuration
	Optional gesture configuration. More...
bool	has_app_world_anchor
QarStructureHeader	header
size_t	initial_peer_count
const QarPeerId **	initial_peers
QarPose	pose
QarAppVolumeSize	size
	Cuboid extents, in metres, along app-volume-space X/Z/Y. More...

Definition at line 1712 of file qar_streaming.h.

Public Member Attributes

app_pose

QarPose QarAppVolumeInit::app_pose

Origin of the rendering application inside app volume space, in volume metres, relative to the cuboid centre. Unlike pose this is not a room -space pose, and app_scale does not scale it.

Definition at line 1732 of file qar_streaming.h.

app_scale

float QarAppVolumeInit::app_scale

Room-metres per app-metre: the factor between app content space and app volume space. 1.0 means 1 m in app coordinates renders as 1 m in the app volume. 0.5 means 1 m in app coordinates renders as 0.5 m in the app volume, so the app appears smaller. 10.0 means 1 m in app coordinates renders as 10 m in the app volume, so the app appears bigger. App pose remains in app-volume meters and is not scaled.

Definition at line 1739 of file qar_streaming.h.

app_world_anchor

QarGeoAnchorFrame QarAppVolumeInit::app_world_anchor

Read only when has_app_world_anchor is set. Its handedness must then be QAR_HANDEDNESS_LEFT or QAR_HANDEDNESS_RIGHT.

Definition at line 1743 of file qar_streaming.h.

common_name

const char* QarAppVolumeInit::common_name

Required stable identity key used by app_volumes_get_or_create() to derive the volume's id. Must not be NULL or empty, and must be ASCII.

Definition at line 1718 of file qar_streaming.h.

display_name

const char* QarAppVolumeInit::display_name

UTF-8 label shown to users; any characters, emoji included.

Definition at line 1720 of file qar_streaming.h.

gesture_configuration

const QarAppVolumeGestureConfiguration* QarAppVolumeInit::gesture_configuration

Optional gesture configuration.

Definition at line 1745 of file qar_streaming.h.

has_app_world_anchor

bool QarAppVolumeInit::has_app_world_anchor

Definition at line 1740 of file qar_streaming.h.

header

QarStructureHeader QarAppVolumeInit::header

Definition at line 1714 of file qar_streaming.h.

initial_peer_count

size_t QarAppVolumeInit::initial_peer_count

Definition at line 1728 of file qar_streaming.h.

initial_peers

const QarPeerId** QarAppVolumeInit::initial_peers

Definition at line 1727 of file qar_streaming.h.

pose

QarPose QarAppVolumeInit::pose

Placement of the cuboid's centre in room space, and the rotation taking app volume space into room space. See the QarAppVolumeSize documentation.

Definition at line 1724 of file qar_streaming.h.

size

QarAppVolumeSize QarAppVolumeInit::size

Cuboid extents, in metres, along app-volume-space X/Z/Y.

Definition at line 1726 of file qar_streaming.h.

---

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

• qar_streaming.h

---

Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.