Fove SDK  v0.16.1
Static Public Attributes | List of all members
fove.headset.ClientCapabilities Class Reference

List of capabilities usable by clients. More...

Inheritance diagram for fove.headset.ClientCapabilities:
Inheritance graph
[legend]
Collaboration diagram for fove.headset.ClientCapabilities:
Collaboration graph
[legend]

Static Public Attributes

 Gaze = capi.ClientCapabilities.Gaze
 Enables eye tracking.
 
 None_ = capi.ClientCapabilities.None_
 No capabilities requested.
 
 Orientation = capi.ClientCapabilities.Orientation
 Enables headset orientation tracking.
 
 Position = capi.ClientCapabilities.Position
 Enables headset position tracking.
 

Detailed Description

List of capabilities usable by clients.

Most features require registering for the relevant capability. If a client queries data related to a capability it has not registered capi.ErrorCode.API_NotRegistered will be returned.

This enum is designed to be used as a flag set, so items support arithmetic operations like + and - as well as the containment operator in.

The FOVE runtime will keep any given set of hardware/software running so long as one client is registering a capability.

The registration of a capability does not necessarily mean that the capability is running. For example, if no position tracking camera is attached, no position tracking will occur regardless of how many clients registered for it.