Varjo Native SDK
Varjo.h
Go to the documentation of this file.
1 // Copyright 2019-2021 Varjo Technologies Oy. All rights reserved.
2 
3 #ifndef VARJO_H
4 #define VARJO_H
5 
6 #include "Varjo_types.h"
7 #include "Varjo_events.h"
8 #include "Varjo_export.h"
9 #include "Varjo_version_defines.h"
10 
11 #if defined __cplusplus
12 extern "C" {
13 #endif
14 
27 
33 VARJO_API const char* varjo_GetVersionString();
34 
47 VARJO_API const uint64_t varjo_GetVersion();
48 
61 VARJO_API struct varjo_Session* varjo_SessionInit(void);
62 
71 VARJO_API void varjo_SessionShutDown(struct varjo_Session* session);
72 
82 VARJO_API void varjo_SessionSetPriority(struct varjo_Session* session, int32_t priority);
83 
92 VARJO_API varjo_Nanoseconds varjo_GetCurrentTime(struct varjo_Session* session);
93 
103 VARJO_API struct varjo_FrameInfo* varjo_CreateFrameInfo(struct varjo_Session* session);
104 
110 VARJO_API void varjo_FreeFrameInfo(struct varjo_FrameInfo* frameInfo);
111 
118 VARJO_API void varjo_SetCenteredProjection(struct varjo_Session* session, varjo_Bool enabled);
119 
125 VARJO_API int32_t varjo_GetViewCount(struct varjo_Session* session);
126 
135 VARJO_API struct varjo_AlignedView varjo_GetAlignedView(double* projectionMatrix);
136 
151 VARJO_API void varjo_WaitSync(struct varjo_Session* session, struct varjo_FrameInfo* frameInfo);
152 
165 VARJO_API varjo_Nanoseconds varjo_FrameGetDisplayTime(struct varjo_Session* session);
166 
180 VARJO_API struct varjo_Matrix varjo_FrameGetPose(struct varjo_Session* session, varjo_PoseType type);
181 
194 VARJO_API struct varjo_Matrix varjo_GetTrackingToLocalTransform(struct varjo_Session* session);
195 
204 VARJO_API struct varjo_Matrix varjo_GetRelativePoseTransform(struct varjo_Session* session, varjo_PoseType src, varjo_PoseType dest);
205 
214 VARJO_API struct varjo_Matrix varjo_ApplyTransform(struct varjo_Session* session, struct varjo_Matrix* m1, struct varjo_Matrix* m2);
215 
227 VARJO_API void varjo_ResetPose(struct varjo_Session* session, varjo_Bool position, varjo_RotationReset rotation);
228 
241 VARJO_API struct varjo_ViewDescription varjo_GetViewDescription(struct varjo_Session* session, int32_t viewIndex);
242 
259 VARJO_API struct varjo_Mesh2Df* varjo_CreateOcclusionMesh(struct varjo_Session* session, int32_t viewIndex, varjo_WindingOrder windingOrder);
260 
266 VARJO_API void varjo_FreeOcclusionMesh(struct varjo_Mesh2Df* mesh);
267 
279 VARJO_API varjo_Error varjo_GetError(struct varjo_Session* session);
280 
286 VARJO_API const char* varjo_GetErrorDesc(varjo_Error error);
287 
293 VARJO_API void varjo_GazeInit(struct varjo_Session* session);
294 
302 VARJO_API void varjo_GazeInitWithParameters(struct varjo_Session* session, struct varjo_GazeParameters* parameters, int32_t parameterCount);
303 
312 VARJO_API varjo_Bool varjo_IsGazeAllowed(struct varjo_Session* session);
313 
323 VARJO_API void varjo_RequestGazeCalibration(struct varjo_Session* session);
324 
337  struct varjo_Session* session, struct varjo_GazeCalibrationParameters* parameters, int32_t parameterCount);
338 
347 VARJO_API struct varjo_Gaze varjo_GetGaze(struct varjo_Session* session);
348 
359 VARJO_API int32_t varjo_GetGazeArray(struct varjo_Session* session, struct varjo_Gaze* array, int32_t maxSize);
360 
366 VARJO_API void varjo_SyncProperties(struct varjo_Session* session);
367 
374 VARJO_API int32_t varjo_GetPropertyCount(struct varjo_Session* session);
375 
383 VARJO_API varjo_PropertyKey varjo_GetPropertyKey(struct varjo_Session* session, int32_t index);
384 
392 VARJO_API const char* varjo_GetPropertyName(struct varjo_Session* session, varjo_PropertyKey propertyKey);
393 
401 VARJO_API varjo_Bool varjo_HasProperty(struct varjo_Session* session, varjo_PropertyKey propertyKey);
402 
410 VARJO_API varjo_Bool varjo_GetPropertyBool(struct varjo_Session* session, varjo_PropertyKey propertyKey);
411 
419 VARJO_API double varjo_GetPropertyDouble(struct varjo_Session* session, varjo_PropertyKey propertyKey);
420 
428 VARJO_API int32_t varjo_GetPropertyInt(struct varjo_Session* session, varjo_PropertyKey propertyKey);
429 
441 VARJO_API void varjo_GetPropertyString(struct varjo_Session* session, varjo_PropertyKey propertyKey, char* buffer, uint32_t maxSize);
442 
451 VARJO_API uint32_t varjo_GetPropertyStringSize(struct varjo_Session* session, varjo_PropertyKey propertyKey);
452 
459 VARJO_API struct varjo_SwapChainLimits varjo_GetSwapChainLimits(struct varjo_Session* session);
460 
472 VARJO_API void varjo_GetSupportedTextureFormats(struct varjo_Session* session, varjo_RenderAPI renderApi, int32_t* formatCount, varjo_TextureFormat* formats);
473 
481 VARJO_API struct varjo_Event* varjo_AllocateEvent();
482 
490 VARJO_API void varjo_FreeEvent(struct varjo_Event* event);
491 
505 VARJO_API varjo_Bool varjo_PollEvent(struct varjo_Session* session, struct varjo_Event* evt);
506 
518 VARJO_API void varjo_GetTextureSize(struct varjo_Session* session, varjo_TextureSize_Type type, int32_t viewIndex, int32_t* width, int32_t* height);
519 
534 VARJO_API void varjo_D3D12UpdateVariableRateShadingTexture(struct varjo_Session* session, struct ID3D12GraphicsCommandList* commandList,
535  struct ID3D12Resource* texture, struct varjo_VariableRateShadingConfig* config);
536 
551 VARJO_API void varjo_D3D11UpdateVariableRateShadingTexture(struct varjo_Session* session, struct ID3D11Device* device, struct ID3D11Texture2D* texture,
552  struct varjo_VariableRateShadingConfig* config, struct varjo_ShadingRateTable* shadingRateTable);
553 
569 VARJO_API void varjo_GLUpdateVariableRateShadingTexture(struct varjo_Session* session, unsigned int texture, int width, int height,
570  struct varjo_VariableRateShadingConfig* config, struct varjo_ShadingRateTable* shadingRateTable);
571 
584 VARJO_API varjo_Bool varjo_GetRenderingGaze(struct varjo_Session* session, struct varjo_Gaze* gaze);
585 
600  struct varjo_Session* session, int32_t indexView, struct varjo_Gaze* gaze, struct varjo_FoveatedFovTangents_Hints* hints);
601 
611 VARJO_API struct varjo_FovTangents varjo_GetFovTangents(struct varjo_Session* session, int32_t viewIndex);
612 
613 #if defined __cplusplus
614 }
615 #endif
616 
617 #endif
varjo_Nanoseconds
int64_t varjo_Nanoseconds
Time in nanoseconds.
Definition: Varjo_types.h:141
varjo_D3D11UpdateVariableRateShadingTexture
void varjo_D3D11UpdateVariableRateShadingTexture(struct varjo_Session *session, struct ID3D11Device *device, struct ID3D11Texture2D *texture, struct varjo_VariableRateShadingConfig *config, struct varjo_ShadingRateTable *shadingRateTable)
Updates variable rate shading texture.
varjo_AllocateEvent
struct varjo_Event * varjo_AllocateEvent()
Allocates an event.
varjo_GetPropertyCount
int32_t varjo_GetPropertyCount(struct varjo_Session *session)
Gets the number of system properties.
varjo_GetPropertyInt
int32_t varjo_GetPropertyInt(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Gets an integer value of a property.
varjo_GetTextureSize
void varjo_GetTextureSize(struct varjo_Session *session, varjo_TextureSize_Type type, int32_t viewIndex, int32_t *width, int32_t *height)
Gets texture size for specific varjo_TextureSize_type and view index.
Varjo_events.h
varjo_ApplyTransform
struct varjo_Matrix varjo_ApplyTransform(struct varjo_Session *session, struct varjo_Matrix *m1, struct varjo_Matrix *m2)
Applies transform using post multiplication.
Varjo_export.h
varjo_FreeEvent
void varjo_FreeEvent(struct varjo_Event *event)
Free an event.
varjo_GetPropertyString
void varjo_GetPropertyString(struct varjo_Session *session, varjo_PropertyKey propertyKey, char *buffer, uint32_t maxSize)
Gets a string value of a property.
varjo_FreeFrameInfo
void varjo_FreeFrameInfo(struct varjo_FrameInfo *frameInfo)
Frees an allocated frame info.
varjo_GazeInitWithParameters
void varjo_GazeInitWithParameters(struct varjo_Session *session, struct varjo_GazeParameters *parameters, int32_t parameterCount)
Initializes the gaze tracking system with provided parameters.
varjo_GazeParameters
Parameters passed to varjo_GazeInitWithParameters function.
Definition: Varjo_types.h:464
varjo_ViewDescription
View description.
Definition: Varjo_types.h:404
varjo_PoseType
int64_t varjo_PoseType
Definition: Varjo_types.h:190
varjo_ShadingRateTable
Definition: Varjo_types.h:524
varjo_D3D12UpdateVariableRateShadingTexture
void varjo_D3D12UpdateVariableRateShadingTexture(struct varjo_Session *session, struct ID3D12GraphicsCommandList *commandList, struct ID3D12Resource *texture, struct varjo_VariableRateShadingConfig *config)
Creates variable rate shading texture.
varjo_Gaze::gaze
struct varjo_Ray gaze
Normalized gaze direction ray.
Definition: Varjo_types.h:417
varjo_RenderAPI
int64_t varjo_RenderAPI
Render API flags.
Definition: Varjo_types.h:227
varjo_Bool
int32_t varjo_Bool
Definition: Varjo_types.h:134
varjo_Gaze
Gaze tracker vectors and tracking state.
Definition: Varjo_types.h:414
varjo_GetPropertyBool
varjo_Bool varjo_GetPropertyBool(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Gets a boolean value of a property.
varjo_ResetPose
void varjo_ResetPose(struct varjo_Session *session, varjo_Bool position, varjo_RotationReset rotation)
Resets pose tracking origin.
varjo_GetCurrentTime
varjo_Nanoseconds varjo_GetCurrentTime(struct varjo_Session *session)
Gets the current time in a format that Varjo API uses.
varjo_GetViewCount
int32_t varjo_GetViewCount(struct varjo_Session *session)
Gets numbers of views.
varjo_SyncProperties
void varjo_SyncProperties(struct varjo_Session *session)
Updates and synchronizes system properties with the system state.
varjo_WindingOrder
int64_t varjo_WindingOrder
Definition: Varjo_types.h:203
varjo_GetSupportedTextureFormats
void varjo_GetSupportedTextureFormats(struct varjo_Session *session, varjo_RenderAPI renderApi, int32_t *formatCount, varjo_TextureFormat *formats)
Gets supported texture formats in the order of most preferred to least preferred.
varjo_GetErrorDesc
const char * varjo_GetErrorDesc(varjo_Error error)
Gets error description for the specified error code.
varjo_FovTangents
Definition: Varjo_types.h:490
varjo_HasProperty
varjo_Bool varjo_HasProperty(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Checks if the key has value in the properties.
varjo_GetAlignedView
struct varjo_AlignedView varjo_GetAlignedView(double *projectionMatrix)
Gets an aligned view from a projection matrix.
varjo_PropertyKey
int64_t varjo_PropertyKey
System status properties.
Definition: Varjo_types.h:174
varjo_FrameGetPose
struct varjo_Matrix varjo_FrameGetPose(struct varjo_Session *session, varjo_PoseType type)
Gets a pose for the current frame.
varjo_GazeInit
void varjo_GazeInit(struct varjo_Session *session)
Initializes the gaze tracking system.
varjo_GetPropertyKey
varjo_PropertyKey varjo_GetPropertyKey(struct varjo_Session *session, int32_t index)
Gets a property key for a property index.
varjo_FrameGetDisplayTime
varjo_Nanoseconds varjo_FrameGetDisplayTime(struct varjo_Session *session)
Gets the time when the frame is scheduled to be displayed.
varjo_FrameInfo
Per-frame information.
Definition: Varjo_types.h:394
varjo_SessionInit
struct varjo_Session * varjo_SessionInit(void)
Initializes a Varjo client session.
varjo_GetPropertyName
const char * varjo_GetPropertyName(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Gets the name of the property key.
varjo_AlignedView
Axis aligned tangents from a projection matrix.
Definition: Varjo_types.h:372
varjo_GetRenderingGaze
varjo_Bool varjo_GetRenderingGaze(struct varjo_Session *session, struct varjo_Gaze *gaze)
Returns gaze which can be used for foveated rendering or to generate variable rate shading texture.
varjo_SwapChainLimits
Minimum and maximum limits for swap chain texture count and size.
Definition: Varjo_types.h:432
varjo_GetGaze
struct varjo_Gaze varjo_GetGaze(struct varjo_Session *session)
Gets the current state of the user gaze.
varjo_CreateFrameInfo
struct varjo_FrameInfo * varjo_CreateFrameInfo(struct varjo_Session *session)
Creates a frame info with initial values.
varjo_TextureFormat
int64_t varjo_TextureFormat
Definition: Varjo_types.h:207
varjo_Event
Event struct used for all the events by the event system.
Definition: Varjo_events.h:123
varjo_GetPropertyStringSize
uint32_t varjo_GetPropertyStringSize(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Gets the size of a buffer that is big enough to hold the property, including the null terminator.
varjo_SessionSetPriority
void varjo_SessionSetPriority(struct varjo_Session *session, int32_t priority)
Sets session overlay priority.
varjo_GazeCalibrationParameters
Parameters passed to varjo_RequestGazeCalibrationWithParameters function.
Definition: Varjo_types.h:472
varjo_GetRelativePoseTransform
struct varjo_Matrix varjo_GetRelativePoseTransform(struct varjo_Session *session, varjo_PoseType src, varjo_PoseType dest)
Gets a relative transformation from source pose to destination pose.
varjo_IsGazeAllowed
varjo_Bool varjo_IsGazeAllowed(struct varjo_Session *session)
Is gaze allowed to be used?
varjo_GLUpdateVariableRateShadingTexture
void varjo_GLUpdateVariableRateShadingTexture(struct varjo_Session *session, unsigned int texture, int width, int height, struct varjo_VariableRateShadingConfig *config, struct varjo_ShadingRateTable *shadingRateTable)
Updates variable rate shading texture.
varjo_CreateOcclusionMesh
struct varjo_Mesh2Df * varjo_CreateOcclusionMesh(struct varjo_Session *session, int32_t viewIndex, varjo_WindingOrder windingOrder)
Creates the occlusion mesh for a given view index.
varjo_GetTrackingToLocalTransform
struct varjo_Matrix varjo_GetTrackingToLocalTransform(struct varjo_Session *session)
Transform from tracking space to local client space.
varjo_GetViewDescription
struct varjo_ViewDescription varjo_GetViewDescription(struct varjo_Session *session, int32_t viewIndex)
Gets the display information for a given view.
varjo_GetVersionString
const char * varjo_GetVersionString()
Gets the short version of the runtime.
varjo_GetError
varjo_Error varjo_GetError(struct varjo_Session *session)
Gets the latest error code.
Varjo_types.h
varjo_IsAvailable
varjo_Bool varjo_IsAvailable()
Checks whether Varjo system is available.
varjo_Matrix
Double precision 4x4 matrix.
Definition: Varjo_types.h:294
varjo_RequestGazeCalibration
void varjo_RequestGazeCalibration(struct varjo_Session *session)
Requests a HMD gaze calibration.
varjo_PollEvent
varjo_Bool varjo_PollEvent(struct varjo_Session *session, struct varjo_Event *evt)
Polls events.
varjo_VariableRateShadingConfig
Definition: Varjo_types.h:535
varjo_Error
int64_t varjo_Error
Definition: Varjo_types.h:13
varjo_GetFovTangents
struct varjo_FovTangents varjo_GetFovTangents(struct varjo_Session *session, int32_t viewIndex)
Returns tangents for a given view index.
varjo_GetPropertyDouble
double varjo_GetPropertyDouble(struct varjo_Session *session, varjo_PropertyKey propertyKey)
Gets a floating point value of a property.
varjo_RotationReset
int64_t varjo_RotationReset
Rotation reset types.
Definition: Varjo_types.h:166
varjo_GetSwapChainLimits
struct varjo_SwapChainLimits varjo_GetSwapChainLimits(struct varjo_Session *session)
Gets swap chain limits.
varjo_SetCenteredProjection
void varjo_SetCenteredProjection(struct varjo_Session *session, varjo_Bool enabled)
Forces the provided projection matrices to be centered.
varjo_FreeOcclusionMesh
void varjo_FreeOcclusionMesh(struct varjo_Mesh2Df *mesh)
Frees the memory allocated by varjo_CreateOcclusionMesh.
varjo_GetVersion
const uint64_t varjo_GetVersion()
Gets the version number of the runtime.
varjo_GetFoveatedFovTangents
struct varjo_FovTangents varjo_GetFoveatedFovTangents(struct varjo_Session *session, int32_t indexView, struct varjo_Gaze *gaze, struct varjo_FoveatedFovTangents_Hints *hints)
Returns foveated view tangents for a given index and gaze vector.
varjo_SessionShutDown
void varjo_SessionShutDown(struct varjo_Session *session)
Shuts down a session and releases all the resources internally allocated by Varjo session.
varjo_GetGazeArray
int32_t varjo_GetGazeArray(struct varjo_Session *session, struct varjo_Gaze *array, int32_t maxSize)
Gets gaze measurements since last query.
varjo_Mesh2Df
2D triangle list mesh.
Definition: Varjo_types.h:361
varjo_WaitSync
void varjo_WaitSync(struct varjo_Session *session, struct varjo_FrameInfo *frameInfo)
Called at the start of a frame.
varjo_FoveatedFovTangents_Hints
Definition: Varjo_types.h:497
varjo_RequestGazeCalibrationWithParameters
void varjo_RequestGazeCalibrationWithParameters(struct varjo_Session *session, struct varjo_GazeCalibrationParameters *parameters, int32_t parameterCount)
Requests a HMD gaze calibration with provided parameters.
varjo_TextureSize_Type
int64_t varjo_TextureSize_Type
Definition: Varjo_types.h:477