Varjo Native SDK
Varjo_events.h
Go to the documentation of this file.
1 // Copyright 2019 Varjo Technologies Oy. All rights reserved.
2 
3 #ifndef VARJO_EVENTS_H
4 #define VARJO_EVENTS_H
5 
6 #include "Varjo_types.h"
7 #include "Varjo_types_mr.h"
9 
10 #if defined __cplusplus
11 extern "C" {
12 #endif
13 
14 typedef int64_t varjo_EventType;
26 
27 #define VARJO_LAST_EVENT varjo_EventType_DataStreamStop
28 
29 typedef int8_t varjo_ButtonId;
31 
32 typedef int64_t varjo_TrackingStatus;
36 
37 typedef int64_t varjo_HeadsetStatus;
40 
41 typedef int64_t varjo_DisplayStatus;
45 
46 typedef int64_t varjo_MRDeviceStatus;
49 
52  int64_t timestamp;
53 };
54 
57 };
58 
62 };
63 
66 };
67 
70 };
71 
74 };
75 
78 };
79 
82 };
83 
86 };
87 
90 };
91 
94 };
95 
98 };
99 
102  struct varjo_EventButton button;
112 };
113 
117 struct varjo_Event {
118  struct varjo_EventHeader header;
119  union varjo_EventData data;
120 };
121 
122 
123 #if defined __cplusplus
124 }
125 #endif
126 
127 #endif // VARJO_EVENTS_H
varjo_TrackingStatus
int64_t varjo_TrackingStatus
Definition: Varjo_events.h:32
varjo_EventData::button
struct varjo_EventButton button
Button event data.
Definition: Varjo_events.h:102
varjo_HeadsetStatus_Disconnected
static const varjo_HeadsetStatus varjo_HeadsetStatus_Disconnected
Headset is disconnected.
Definition: Varjo_events.h:39
varjo_ButtonId_Application
static const varjo_ButtonId varjo_ButtonId_Application
Button ID for application button on the headset.
Definition: Varjo_events.h:30
varjo_EventButton::buttonId
varjo_ButtonId buttonId
Id of the button.
Definition: Varjo_events.h:61
varjo_DisplayStatus_ContextNotFound
static const varjo_DisplayStatus varjo_DisplayStatus_ContextNotFound
Context display is not found.
Definition: Varjo_events.h:42
varjo_DisplayStatus
int64_t varjo_DisplayStatus
Definition: Varjo_events.h:41
varjo_EventMRCameraPropertyChange::type
varjo_CameraPropertyType type
Changed property. Value can be queried with varjo_MRGetCameraPropertyMode and varjo_MRGetCameraProper...
Definition: Varjo_events.h:89
varjo_EventForeground
Definition: Varjo_events.h:72
varjo_EventHeadsetStandbyStatus::onStandby
varjo_Bool onStandby
Is the headset on standby.
Definition: Varjo_events.h:77
varjo_EventTrackingStatus::status
varjo_TrackingStatus status
Current tracking status.
Definition: Varjo_events.h:65
varjo_EventMRDeviceStatus
Definition: Varjo_events.h:84
varjo_EventHeadsetStatus::status
varjo_HeadsetStatus status
Current headset status.
Definition: Varjo_events.h:69
varjo_EventType_HeadsetStatus
static const varjo_EventType varjo_EventType_HeadsetStatus
Event for headset connection and disconnection.
Definition: Varjo_events.h:18
varjo_EventDataStreamStart::streamId
varjo_StreamId streamId
Stream id.
Definition: Varjo_events.h:93
varjo_EventType
int64_t varjo_EventType
Definition: Varjo_events.h:14
varjo_EventData::foreground
struct varjo_EventForeground foreground
Foreground status event data.
Definition: Varjo_events.h:107
varjo_DisplayStatus_AllDisplaysFound
static const varjo_DisplayStatus varjo_DisplayStatus_AllDisplaysFound
All displays found.
Definition: Varjo_events.h:44
varjo_CameraPropertyType
int64_t varjo_CameraPropertyType
Camera property types that can be accessed to control video see through cameras.
Definition: Varjo_types_mr.h:78
varjo_TrackingStatus_Disconnected
static const varjo_TrackingStatus varjo_TrackingStatus_Disconnected
Tracking disconnected.
Definition: Varjo_events.h:35
varjo_EventDataStreamStop::streamId
varjo_StreamId streamId
Stream id.
Definition: Varjo_events.h:97
varjo_HeadsetStatus_Connected
static const varjo_HeadsetStatus varjo_HeadsetStatus_Connected
Headset is connected.
Definition: Varjo_events.h:38
varjo_HeadsetStatus
int64_t varjo_HeadsetStatus
Definition: Varjo_events.h:37
varjo_TrackingStatus_Lost
static const varjo_TrackingStatus varjo_TrackingStatus_Lost
No tracking data available.
Definition: Varjo_events.h:34
varjo_EventTrackingStatus
Definition: Varjo_events.h:64
varjo_Bool
int32_t varjo_Bool
Definition: Varjo_types.h:133
varjo_Event::header
struct varjo_EventHeader header
Event header.
Definition: Varjo_events.h:118
varjo_ButtonId
int8_t varjo_ButtonId
Definition: Varjo_events.h:29
varjo_EventVisibility::visible
varjo_Bool visible
Current visibility.
Definition: Varjo_events.h:56
varjo_EventData::mrDeviceStatus
struct varjo_EventMRDeviceStatus mrDeviceStatus
Mixed reality device status event data.
Definition: Varjo_events.h:108
varjo_EventHeadsetStandbyStatus
Definition: Varjo_events.h:76
varjo_Event::data
union varjo_EventData data
Event data.
Definition: Varjo_events.h:119
varjo_EventForeground::isForeground
varjo_Bool isForeground
Is the session on foreground.
Definition: Varjo_events.h:73
varjo_MRDeviceStatus_Connected
static const varjo_MRDeviceStatus varjo_MRDeviceStatus_Connected
Mixed reality capable device is connected.
Definition: Varjo_events.h:47
varjo_EventMRDeviceStatus::status
varjo_MRDeviceStatus status
Is there a mixed reality capable device connected.
Definition: Varjo_events.h:85
varjo_EventData::dataStreamStop
struct varjo_EventDataStreamStop dataStreamStop
Data stream stop event data.
Definition: Varjo_events.h:111
Varjo_types_mr.h
varjo_EventData::headsetStatus
struct varjo_EventHeadsetStatus headsetStatus
Headset status event data.
Definition: Varjo_events.h:104
varjo_TrackingStatus_Ok
static const varjo_TrackingStatus varjo_TrackingStatus_Ok
Tracking is ok.
Definition: Varjo_events.h:33
varjo_EventData::trackingStatus
struct varjo_EventTrackingStatus trackingStatus
Tracking status event data.
Definition: Varjo_events.h:103
varjo_EventData
Definition: Varjo_events.h:100
varjo_EventButton
Definition: Varjo_events.h:59
varjo_EventHeadsetStatus
Definition: Varjo_events.h:68
varjo_Event
Event struct used for all the events by the event system.
Definition: Varjo_events.h:117
varjo_EventData::headsetStandbyStatus
struct varjo_EventHeadsetStandbyStatus headsetStandbyStatus
Headset standby status event data.
Definition: Varjo_events.h:106
Varjo_types_datastream.h
varjo_EventData::dataStreamStart
struct varjo_EventDataStreamStart dataStreamStart
Data stream start event data.
Definition: Varjo_events.h:110
varjo_EventButton::pressed
varjo_Bool pressed
Is the button pressed down.
Definition: Varjo_events.h:60
varjo_EventHeader
Definition: Varjo_events.h:50
varjo_EventHeader::timestamp
int64_t timestamp
Timestamp of the time when the event was issued.
Definition: Varjo_events.h:52
Varjo_types.h
varjo_EventData::displayStatus
struct varjo_EventDisplayStatus displayStatus
Display status event data.
Definition: Varjo_events.h:105
varjo_EventType_MRCameraPropertyChange
static const varjo_EventType varjo_EventType_MRCameraPropertyChange
Event sent right after a camera property (e.g. exposure mode) change.
Definition: Varjo_events.h:23
varjo_EventType_Foreground
static const varjo_EventType varjo_EventType_Foreground
Event for when application goes to background or foreground.
Definition: Varjo_events.h:21
varjo_EventData::mrCameraPropertyChange
struct varjo_EventMRCameraPropertyChange mrCameraPropertyChange
Camera property change event data.
Definition: Varjo_events.h:109
varjo_EventType_HeadsetStandbyStatus
static const varjo_EventType varjo_EventType_HeadsetStandbyStatus
Event for changes in headset standby status.
Definition: Varjo_events.h:20
varjo_StreamId
int64_t varjo_StreamId
Stream ID to identify a data stream configuration.
Definition: Varjo_types_datastream.h:105
varjo_EventType_TrackingStatus
static const varjo_EventType varjo_EventType_TrackingStatus
Event that is received when there's a change in positional tracking state.
Definition: Varjo_events.h:17
varjo_EventHeader::type
varjo_EventType type
Type of the event.
Definition: Varjo_events.h:51
varjo_DisplayStatus_FocusNotFound
static const varjo_DisplayStatus varjo_DisplayStatus_FocusNotFound
Focus display is not found.
Definition: Varjo_events.h:43
varjo_EventType_MRDeviceStatus
static const varjo_EventType varjo_EventType_MRDeviceStatus
Event for determining whether mixed reality capable device is connected.
Definition: Varjo_events.h:22
varjo_EventDisplayStatus::status
varjo_DisplayStatus status
Current display status.
Definition: Varjo_events.h:81
varjo_EventType_DataStreamStop
static const varjo_EventType varjo_EventType_DataStreamStop
Event emitted when a data stream has stopped.
Definition: Varjo_events.h:25
varjo_EventVisibility
Definition: Varjo_events.h:55
varjo_EventType_Button
static const varjo_EventType varjo_EventType_Button
Button event that is received when a button is pressed or released.
Definition: Varjo_events.h:16
varjo_EventData::visibility
struct varjo_EventVisibility visibility
Visibility event data.
Definition: Varjo_events.h:101
varjo_EventType_DisplayStatus
static const varjo_EventType varjo_EventType_DisplayStatus
Event for changes in headset display connections. Eg. if cables are unplugged.
Definition: Varjo_events.h:19
varjo_EventDataStreamStop
Definition: Varjo_events.h:96
varjo_MRDeviceStatus
int64_t varjo_MRDeviceStatus
Definition: Varjo_events.h:46
varjo_EventDisplayStatus
Definition: Varjo_events.h:80
varjo_MRDeviceStatus_Disconnected
static const varjo_MRDeviceStatus varjo_MRDeviceStatus_Disconnected
Mixed reality capable device is disconnected.
Definition: Varjo_events.h:48
varjo_EventType_Visibility
static const varjo_EventType varjo_EventType_Visibility
Visibility event received when application being shown / hidden.
Definition: Varjo_events.h:15
varjo_EventMRCameraPropertyChange
Definition: Varjo_events.h:88
varjo_EventType_DataStreamStart
static const varjo_EventType varjo_EventType_DataStreamStart
Event emitted when a data stream has started.
Definition: Varjo_events.h:24
varjo_EventDataStreamStart
Definition: Varjo_events.h:92