Varjo Native SDK
Data Structures | Macros | Typedefs | Variables
Varjo_events.h File Reference

Go to the source code of this file.

Data Structures

struct  varjo_EventHeader
 
struct  varjo_EventVisibility
 
struct  varjo_EventButton
 
struct  varjo_EventTrackingStatus
 
struct  varjo_EventHeadsetStatus
 
struct  varjo_EventForeground
 
struct  varjo_EventHeadsetStandbyStatus
 
struct  varjo_EventStandbyStatus
 
struct  varjo_EventDisplayStatus
 
struct  varjo_EventMRDeviceStatus
 
struct  varjo_EventMRCameraPropertyChange
 
struct  varjo_EventDataStreamStart
 
struct  varjo_EventDataStreamStop
 
struct  varjo_EventTextureSizeChange
 
struct  varjo_EventVisibilityMeshChange
 
union  varjo_EventData
 
struct  varjo_Event
 Event struct used for all the events by the event system. More...
 

Macros

#define VARJO_LAST_EVENT   varjo_EventType_VisibilityMeshChange
 

Typedefs

typedef int64_t varjo_EventType
 
typedef int8_t varjo_ButtonId
 
typedef int64_t varjo_TrackingStatus
 
typedef int64_t varjo_HeadsetStatus
 
typedef int64_t varjo_DisplayStatus
 
typedef int64_t varjo_MRDeviceStatus
 

Variables

static const varjo_EventType varjo_EventType_Visibility = 0x1
 Visibility event received when application being shown / hidden. More...
 
static const varjo_EventType varjo_EventType_Button = 0x2
 Button event that is received when a button is pressed or released. More...
 
static const varjo_EventType varjo_EventType_TrackingStatus = 0x3
 Event that is received when there's a change in positional tracking state. More...
 
static const varjo_EventType varjo_EventType_HeadsetStatus = 0x4
 Event for headset connection and disconnection. More...
 
static const varjo_EventType varjo_EventType_DisplayStatus = 0x5
 Event for changes in headset display connections. Eg. if cables are unplugged. More...
 
static VARJORUNTIME_DEPRECATED const varjo_EventType varjo_EventType_HeadsetStandbyStatus
 Event for changes in standby status. More...
 
static const varjo_EventType varjo_EventType_StandbyStatus = 0x6
 Event for changes in standby status. More...
 
static const varjo_EventType varjo_EventType_Foreground = 0x7
 Event for when application goes to background or foreground. More...
 
static const varjo_EventType varjo_EventType_MRDeviceStatus = 0x8
 Event for determining whether mixed reality capable device is connected. More...
 
static const varjo_EventType varjo_EventType_MRCameraPropertyChange = 0x9
 Event sent right after a camera property (e.g. exposure mode) change. More...
 
static const varjo_EventType varjo_EventType_DataStreamStart = 0xA
 Event emitted when a data stream has started. More...
 
static const varjo_EventType varjo_EventType_DataStreamStop = 0xB
 Event emitted when a data stream has stopped. More...
 
static const varjo_EventType varjo_EventType_TextureSizeChange = 0xC
 Event emitted when a texture size has changed. More...
 
static const varjo_EventType varjo_EventType_MRChromaKeyConfigChange = 0xD
 Event emitted when chroma key configuration has changed. More...
 
static const varjo_EventType varjo_EventType_VisibilityMeshChange = 0xE
 Event emitted when occlusion/visibility mesh has changed. More...
 
static const varjo_ButtonId varjo_ButtonId_Application = 0
 Button ID for application button on the headset. More...
 
static const varjo_TrackingStatus varjo_TrackingStatus_Ok = 0x0
 Tracking is ok. More...
 
static const varjo_TrackingStatus varjo_TrackingStatus_Lost = 0x1
 No tracking data available. More...
 
static const varjo_TrackingStatus varjo_TrackingStatus_Disconnected = 0x2
 Tracking disconnected. More...
 
static const varjo_HeadsetStatus varjo_HeadsetStatus_Connected = 0x1
 Headset is connected. More...
 
static const varjo_HeadsetStatus varjo_HeadsetStatus_Disconnected = 0x2
 Headset is disconnected. More...
 
static const varjo_DisplayStatus varjo_DisplayStatus_ContextNotFound = 0x1
 Context display is not found. More...
 
static const varjo_DisplayStatus varjo_DisplayStatus_FocusNotFound = 0x2
 Focus display is not found. More...
 
static const varjo_DisplayStatus varjo_DisplayStatus_AllDisplaysFound = 0x4
 All displays found. More...
 
static const varjo_MRDeviceStatus varjo_MRDeviceStatus_Connected = 0x1
 Mixed reality capable device is connected. More...
 
static const varjo_MRDeviceStatus varjo_MRDeviceStatus_Disconnected = 0x2
 Mixed reality capable device is disconnected. More...
 

Data Structure Documentation

◆ varjo_EventHeader

struct varjo_EventHeader
Data Fields
int64_t timestamp Timestamp of the time when the event was issued.
varjo_EventType type Type of the event.

◆ varjo_EventVisibility

struct varjo_EventVisibility
Data Fields
varjo_Bool visible Current visibility.

◆ varjo_EventButton

struct varjo_EventButton
Data Fields
varjo_ButtonId buttonId Id of the button.
varjo_Bool pressed Is the button pressed down.

◆ varjo_EventTrackingStatus

struct varjo_EventTrackingStatus
Data Fields
varjo_TrackingStatus status Current tracking status.

◆ varjo_EventHeadsetStatus

struct varjo_EventHeadsetStatus
Data Fields
varjo_HeadsetStatus status Current headset status.

◆ varjo_EventForeground

struct varjo_EventForeground
Data Fields
varjo_Bool isForeground Is the session on foreground.

◆ varjo_EventHeadsetStandbyStatus

struct varjo_EventHeadsetStandbyStatus
Data Fields
varjo_Bool onStandby True if there are no consumers e.g. headset, analytics window and mirror view in VarjoBase of rendered frames.

◆ varjo_EventStandbyStatus

struct varjo_EventStandbyStatus
Data Fields
varjo_Bool onStandby True if there are no consumers e.g. headset, analytics window and mirror view in VarjoBase of rendered frames.

◆ varjo_EventDisplayStatus

struct varjo_EventDisplayStatus
Data Fields
varjo_DisplayStatus status Current display status.

◆ varjo_EventMRDeviceStatus

struct varjo_EventMRDeviceStatus
Data Fields
varjo_MRDeviceStatus status Is there a mixed reality capable device connected.

◆ varjo_EventMRCameraPropertyChange

struct varjo_EventMRCameraPropertyChange
Data Fields
varjo_CameraPropertyType type Changed property. Value can be queried with varjo_MRGetCameraPropertyMode and varjo_MRGetCameraPropertyValue.

◆ varjo_EventDataStreamStart

struct varjo_EventDataStreamStart
Data Fields
varjo_StreamId streamId Stream id.

◆ varjo_EventDataStreamStop

struct varjo_EventDataStreamStop
Data Fields
varjo_StreamId streamId Stream id.

◆ varjo_EventTextureSizeChange

struct varjo_EventTextureSizeChange
Data Fields
varjo_TextureSize_Type_Mask typeMask Bitmask of changed texture size types.

◆ varjo_EventVisibilityMeshChange

struct varjo_EventVisibilityMeshChange
Data Fields
uint32_t viewIndex viewIndex for which visibility/occlusion mesh is changed and should be re-queried.

◆ varjo_EventData

union varjo_EventData
Data Fields
struct varjo_EventButton button Button event data.
struct varjo_EventDataStreamStart dataStreamStart Data stream start event data.
struct varjo_EventDataStreamStop dataStreamStop Data stream stop event data.
struct varjo_EventDisplayStatus displayStatus Display status event data.
struct varjo_EventForeground foreground Foreground status event data.
VARJORUNTIME_DEPRECATED struct varjo_EventHeadsetStandbyStatus headsetStandbyStatus Headset standby status event data.
Deprecated:
, varjo_EventStandbyStatus should be used,
struct varjo_EventHeadsetStatus headsetStatus Headset status event data.
struct varjo_EventMRCameraPropertyChange mrCameraPropertyChange Camera property change event data.
struct varjo_EventMRDeviceStatus mrDeviceStatus Mixed reality device status event data.
struct varjo_EventStandbyStatus standbyStatus Standby status event data.
struct varjo_EventTextureSizeChange textureSizeChange Texture size change data.
struct varjo_EventTrackingStatus trackingStatus Tracking status event data.
struct varjo_EventVisibility visibility Visibility event data.
struct varjo_EventVisibilityMeshChange visibilityMeshChange Visibility mesh change data.

◆ varjo_Event

struct varjo_Event

Event struct used for all the events by the event system.

Data Fields
union varjo_EventData data Event data.
struct varjo_EventHeader header Event header.

Macro Definition Documentation

◆ VARJO_LAST_EVENT

#define VARJO_LAST_EVENT   varjo_EventType_VisibilityMeshChange

Typedef Documentation

◆ varjo_ButtonId

typedef int8_t varjo_ButtonId

◆ varjo_DisplayStatus

typedef int64_t varjo_DisplayStatus

◆ varjo_EventType

typedef int64_t varjo_EventType

◆ varjo_HeadsetStatus

typedef int64_t varjo_HeadsetStatus

◆ varjo_MRDeviceStatus

typedef int64_t varjo_MRDeviceStatus

◆ varjo_TrackingStatus

typedef int64_t varjo_TrackingStatus

Variable Documentation

◆ varjo_ButtonId_Application

const varjo_ButtonId varjo_ButtonId_Application = 0
static

Button ID for application button on the headset.

◆ varjo_DisplayStatus_AllDisplaysFound

const varjo_DisplayStatus varjo_DisplayStatus_AllDisplaysFound = 0x4
static

All displays found.

◆ varjo_DisplayStatus_ContextNotFound

const varjo_DisplayStatus varjo_DisplayStatus_ContextNotFound = 0x1
static

Context display is not found.

◆ varjo_DisplayStatus_FocusNotFound

const varjo_DisplayStatus varjo_DisplayStatus_FocusNotFound = 0x2
static

Focus display is not found.

◆ varjo_EventType_Button

const varjo_EventType varjo_EventType_Button = 0x2
static

Button event that is received when a button is pressed or released.

◆ varjo_EventType_DataStreamStart

const varjo_EventType varjo_EventType_DataStreamStart = 0xA
static

Event emitted when a data stream has started.

◆ varjo_EventType_DataStreamStop

const varjo_EventType varjo_EventType_DataStreamStop = 0xB
static

Event emitted when a data stream has stopped.

◆ varjo_EventType_DisplayStatus

const varjo_EventType varjo_EventType_DisplayStatus = 0x5
static

Event for changes in headset display connections. Eg. if cables are unplugged.

◆ varjo_EventType_Foreground

const varjo_EventType varjo_EventType_Foreground = 0x7
static

Event for when application goes to background or foreground.

◆ varjo_EventType_HeadsetStandbyStatus

VARJORUNTIME_DEPRECATED const varjo_EventType varjo_EventType_HeadsetStandbyStatus
static
Initial value:
=
0x6

Event for changes in standby status.

Deprecated:
, varjo_EventType_StandbyStatus should be used.

◆ varjo_EventType_HeadsetStatus

const varjo_EventType varjo_EventType_HeadsetStatus = 0x4
static

Event for headset connection and disconnection.

◆ varjo_EventType_MRCameraPropertyChange

const varjo_EventType varjo_EventType_MRCameraPropertyChange = 0x9
static

Event sent right after a camera property (e.g. exposure mode) change.

◆ varjo_EventType_MRChromaKeyConfigChange

const varjo_EventType varjo_EventType_MRChromaKeyConfigChange = 0xD
static

Event emitted when chroma key configuration has changed.

◆ varjo_EventType_MRDeviceStatus

const varjo_EventType varjo_EventType_MRDeviceStatus = 0x8
static

Event for determining whether mixed reality capable device is connected.

◆ varjo_EventType_StandbyStatus

const varjo_EventType varjo_EventType_StandbyStatus = 0x6
static

Event for changes in standby status.

◆ varjo_EventType_TextureSizeChange

const varjo_EventType varjo_EventType_TextureSizeChange = 0xC
static

Event emitted when a texture size has changed.

◆ varjo_EventType_TrackingStatus

const varjo_EventType varjo_EventType_TrackingStatus = 0x3
static

Event that is received when there's a change in positional tracking state.

◆ varjo_EventType_Visibility

const varjo_EventType varjo_EventType_Visibility = 0x1
static

Visibility event received when application being shown / hidden.

◆ varjo_EventType_VisibilityMeshChange

const varjo_EventType varjo_EventType_VisibilityMeshChange = 0xE
static

Event emitted when occlusion/visibility mesh has changed.

◆ varjo_HeadsetStatus_Connected

const varjo_HeadsetStatus varjo_HeadsetStatus_Connected = 0x1
static

Headset is connected.

◆ varjo_HeadsetStatus_Disconnected

const varjo_HeadsetStatus varjo_HeadsetStatus_Disconnected = 0x2
static

Headset is disconnected.

◆ varjo_MRDeviceStatus_Connected

const varjo_MRDeviceStatus varjo_MRDeviceStatus_Connected = 0x1
static

Mixed reality capable device is connected.

◆ varjo_MRDeviceStatus_Disconnected

const varjo_MRDeviceStatus varjo_MRDeviceStatus_Disconnected = 0x2
static

Mixed reality capable device is disconnected.

◆ varjo_TrackingStatus_Disconnected

const varjo_TrackingStatus varjo_TrackingStatus_Disconnected = 0x2
static

Tracking disconnected.

◆ varjo_TrackingStatus_Lost

const varjo_TrackingStatus varjo_TrackingStatus_Lost = 0x1
static

No tracking data available.

◆ varjo_TrackingStatus_Ok

const varjo_TrackingStatus varjo_TrackingStatus_Ok = 0x0
static

Tracking is ok.