QarAppVolumeSize Struct

The three frames every app volume API is expressed in. More...

Declaration

struct QarAppVolumeSize { ... }

Included Headers

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

Public Member Attributes Index

float	height_meters
	Cuboid extent along app-volume-space Y - the vertical rise - in metres. More...
float	length_meters
float	width_meters
	Cuboid extent along app-volume-space X, in metres. More...

Description

The three frames every app volume API is expressed in.

An app volume is a cuboid placed in the room that reserves the region a remote 3D application renders into.

Room space is the session's shared tracking space: right-handed, metres, +Y up. QarAppVolumeInit::pose, qar_app_volumes_change_pose() and qar_app_volume_get_pose() are given in it.

App volume space is the frame that pose defines. Its origin is the centre of the cuboid - not a corner, and not a point on the floor - and its axes are right-handed, laid out so that an unrotated volume stands upright in the room:

• +X spans width_meters,
• +Y spans height_meters and points up,
• +Z spans length_meters, the horizontal depth. The cuboid therefore covers x in [-width_meters/2, +width_meters/2], y in [-height_meters/2, +height_meters/2] and z in [-length_meters/2, +length_meters/2].

App content space is the coordinate system of the application rendering into the volume. QarAppVolumeInit::app_pose and qar_app_volumes_change_app_pose() place that application's origin inside app volume space, in volume metres; QarAppVolumeInit::app_scale converts app metres into volume metres. Nothing clips the application to the cuboid - the volume states where the app is meant to be, and gestures and layout are derived from it.

Definition at line 985 of file qar_streaming.h.

Public Member Attributes

height_meters

float QarAppVolumeSize::height_meters

Cuboid extent along app-volume-space Y - the vertical rise - in metres.

Definition at line 993 of file qar_streaming.h.

length_meters

float QarAppVolumeSize::length_meters

Cuboid extent along app-volume-space Z - the horizontal depth - in metres.

Definition at line 991 of file qar_streaming.h.

width_meters

float QarAppVolumeSize::width_meters

Cuboid extent along app-volume-space X, in metres.

Definition at line 988 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.