v3.6.0/apidocs/_varjo__types_8h_source.html

// Copyright 2019-2021 Varjo Technologies Oy. All rights reserved.


#ifndef VARJO_TYPES_H

#define VARJO_TYPES_H


#include <stdint.h>

#include "Varjo_export.h"


#if defined __cplusplus

extern "C" {

#endif


typedef int64_t varjo_Error;

static const varjo_Error varjo_Error_InvalidSession = 1;

static const varjo_Error varjo_Error_OutOfMemory = 2;

static const varjo_Error varjo_Error_InvalidVersion = 3;

static const varjo_Error varjo_Error_GraphicsNotInitialized = 4;

static const varjo_Error varjo_Error_FrameNotStarted = 5;

static const varjo_Error varjo_Error_FrameAlreadyStarted = 6;

static const varjo_Error varjo_Error_ViewIndexOutOfBounds = 7;

static const varjo_Error varjo_Error_InvalidPoseType = 8;

static const varjo_Error varjo_Error_NullPointer = 9;

static const varjo_Error varjo_Error_MixingTextures = 10;

static const varjo_Error varjo_Error_NaN = 11;

static const varjo_Error varjo_Error_NoHMDConnected = 12;

static const varjo_Error varjo_Error_ValidationFailure = 13;

static const varjo_Error varjo_Error_IndexOutOfBounds = 14;

static const varjo_Error varjo_Error_AlreadyLocked = 15;

static const varjo_Error varjo_Error_NotLocked = 16;

static const varjo_Error varjo_Error_InvalidSize = 17;


// Gaze errors (100 - 199)

static const varjo_Error varjo_Error_GazeNotInitialized = 100;

static const varjo_Error varjo_Error_GazeNotConnected = 101;

static const varjo_Error varjo_Error_GazeAlreadyInitialized = 102;

static const varjo_Error varjo_Error_GazeNotAllowed = 103;

static const varjo_Error varjo_Error_GazeInvalidParameter = 104;

static const varjo_Error varjo_Error_GazeUnsupportedParameter = 105;


// Graphics errors (200 - 299)

static const varjo_Error varjo_Error_D3D11DeviceCreationFailed = 200;

static const varjo_Error varjo_Error_GetD3D11_1DeviceFailed = 201;

static const varjo_Error varjo_Error_AcquireD3D11DeviceHandleFailed = 202;

static const varjo_Error varjo_Error_GLBackBufferAlreadyCreated = 203;

static const varjo_Error varjo_Error_GLExtensionNotFound = 204;

static const varjo_Error varjo_Error_GLCreateTextureFailed = 205;

static const varjo_Error varjo_Error_GLAcquireD3D11TextureHandleFailed = 206;

static const varjo_Error varjo_Error_GLLockTextureFailed = 207;

static const varjo_Error varjo_Error_GLCopyTextureFailed = 208;

static const varjo_Error varjo_Error_OpenSharedTextureFailed = 209;

static const varjo_Error varjo_Error_TextureMutexQueryFailed = 210;

static const varjo_Error varjo_Error_TextureMutexAcquireFailed = 211;

static const varjo_Error varjo_Error_TextureMutexReleaseFailed = 212;

static const varjo_Error varjo_Error_D3D11AlreadyInitialized = 213;

static const varjo_Error varjo_Error_D3D11ShutDownFailed = 214;

static const varjo_Error varjo_Error_GLAlreadyInitialized = 215;

static const varjo_Error varjo_Error_GLShutDownFailed = 216;

static const varjo_Error varjo_Error_UnsupportedTextureFormat = 217;

static const varjo_Error varjo_Error_SwapChainConfigInvalidWidth = 219;

static const varjo_Error varjo_Error_SwapChainConfigInvalidHeight = 220;

static const varjo_Error varjo_Error_SwapChainConfigInvalidTextureCount = 221;

static const varjo_Error varjo_Error_GraphicsShutDownFailed = 222;

static const varjo_Error varjo_Error_TextureIsNull = 223;

static const varjo_Error varjo_Error_InvalidFrameNumber = 224;

static const varjo_Error varjo_Error_InvalidRenderAPI = 225;

static const varjo_Error varjo_Error_InvalidMatrix = 226;

static const varjo_Error varjo_Error_UnsupportedDepthFormat = 227;

static const varjo_Error varjo_Error_InvalidClipDistances = 229;

static const varjo_Error varjo_Error_SwapChainInvalidTextureIndex = 230;

static const varjo_Error varjo_Error_D3D11CreateTextureFailed = 231;

static const varjo_Error varjo_Error_InvalidSwapChainRect = 232;

static const varjo_Error varjo_Error_ViewDepthExtensionValidationFailure = 233;

static const varjo_Error varjo_Error_D3D11OnD12DeviceCreationFailed = 234;

static const varjo_Error varjo_Error_D3D12CreateTextureFailed = 235;

static const varjo_Error varjo_Error_InvalidSwapChain = 236;

static const varjo_Error varjo_Error_WrongSwapChainTextureFormat = 237;

static const varjo_Error varjo_Error_InvalidViewExtension = 238;

static const varjo_Error varjo_Error_InvalidViewport = 239;

static const varjo_Error varjo_Error_GraphicsError = 240;

static const varjo_Error varjo_Error_InvalidTextureSizeType = 241;

static const varjo_Error varjo_Error_SwapChainTextureIsNotReleased = 242;

static const varjo_Error varjo_Error_GazeInvalid = 243;


// Compositor errors (300 - 399)

static const varjo_Error varjo_Error_ConnectToProgramManagerFailed = 300;

static const varjo_Error varjo_Error_RequestSwapChainFormatFailed = 301;

static const varjo_Error varjo_Error_OpenSharedEventFailed = 302;

static const varjo_Error varjo_Error_CreateIPCFailed = 303;

static const varjo_Error varjo_Error_InitializeCompositorLinkFailed = 304;

static const varjo_Error varjo_Error_RequestViewInfoFailed = 305;

static const varjo_Error varjo_Error_NoCompositorLink = 306;

static const varjo_Error varjo_Error_RequestCreateSwapChainFailed = 307;

static const varjo_Error varjo_Error_RequestMirrorConfigFailed = 308;


// Mixed reality errors (700 - 799)

static const varjo_Error varjo_Error_RequestFailed = 700;

static const varjo_Error varjo_Error_OperationFailed = 701;

static const varjo_Error varjo_Error_NotAvailable = 702;

static const varjo_Error varjo_Error_CapabilityNotAvailable = 703;

static const varjo_Error varjo_Error_CameraAlreadyLocked = 704;

static const varjo_Error varjo_Error_CameraNotLocked = 705;

static const varjo_Error varjo_Error_CameraInvalidPropertyType = 706;

static const varjo_Error varjo_Error_CameraInvalidPropertyValue = 707;

static const varjo_Error varjo_Error_CameraInvalidPropertyMode = 708;

static const varjo_Error varjo_Error_ChromaKeyAlreadyLocked = 709;

static const varjo_Error varjo_Error_ChromaKeyNotLocked = 710;

static const varjo_Error varjo_Error_ChromaKeyInvalidType = 711;

static const varjo_Error varjo_Error_ChromaKeyEstimatorAlreadyRunning = 712;

static const varjo_Error varjo_Error_ChromaKeyEstimatorNotRunning = 713;


// Data stream errors (800 - 899)

static const varjo_Error varjo_Error_DataStreamInvalidCallback = 800;

static const varjo_Error varjo_Error_DataStreamInvalidId = 801;

static const varjo_Error varjo_Error_DataStreamAlreadyInUse = 802;

static const varjo_Error varjo_Error_DataStreamNotInUse = 803;

static const varjo_Error varjo_Error_DataStreamBufferInvalidId = 804;

static const varjo_Error varjo_Error_DataStreamBufferAlreadyLocked = 805;

static const varjo_Error varjo_Error_DataStreamBufferNotLocked = 806;

static const varjo_Error varjo_Error_DataStreamFrameExpired = 807;

static const varjo_Error varjo_Error_DataStreamDataNotAvailable = 808;


// World errors (900 - 999)

static const varjo_Error varjo_Error_WorldObjectMarkersNotInitialized = 900;

static const varjo_Error varjo_Error_WorldComponentDoesNotExist = 901;

static const varjo_Error varjo_Error_WorldMarkerExpirationDurationIsNegative = 902;


// Foveation and variable rate shading errors (1000 - 1099)

static const varjo_Error varjo_Error_InvalidFoveationMode = 1000;

static const varjo_Error varjo_Error_UnableToInitializeVariableRateShading = 1001;

static const varjo_Error varjo_Error_InvalidVariableRateShadingRadius = 1002;


// Special error codes

static const varjo_Error varjo_NoError = 0;

static const varjo_Error varjo_Error_Unknown = -1;


typedef int32_t varjo_Bool;

static const varjo_Bool varjo_False = 0;

static const varjo_Bool varjo_True = 1;


typedef int64_t varjo_Nanoseconds;


typedef int64_t varjo_GazeStatus;

static const varjo_GazeStatus varjo_GazeStatus_Invalid = 0;

static const varjo_GazeStatus varjo_GazeStatus_Adjust = 1;

static const varjo_GazeStatus varjo_GazeStatus_Valid = 2;


typedef int64_t varjo_GazeEyeStatus;

static const varjo_GazeEyeStatus varjo_GazeEyeStatus_Invalid = 0;

static const varjo_GazeEyeStatus varjo_GazeEyeStatus_Visible = 1;

static const varjo_GazeEyeStatus varjo_GazeEyeStatus_Compensated = 2;

static const varjo_GazeEyeStatus varjo_GazeEyeStatus_Tracked = 3;


typedef int32_t varjo_GazeEyeCalibrationQuality;

static const varjo_GazeEyeCalibrationQuality varjo_GazeEyeCalibrationQuality_Invalid = 0;

static const varjo_GazeEyeCalibrationQuality varjo_GazeEyeCalibrationQuality_Low = 1;

static const varjo_GazeEyeCalibrationQuality varjo_GazeEyeCalibrationQuality_Medium = 2;

static const varjo_GazeEyeCalibrationQuality varjo_GazeEyeCalibrationQuality_High = 3;


typedef int64_t varjo_RotationReset;

static const varjo_RotationReset varjo_RotationReset_None = 0;

static const varjo_RotationReset varjo_RotationReset_Yaw = 1;

static const varjo_RotationReset varjo_RotationReset_All = 7;


typedef int64_t varjo_PropertyKey;

static const varjo_PropertyKey varjo_PropertyKey_Invalid = 0x0;

static const varjo_PropertyKey varjo_PropertyKey_UserPresence = 0x2000;

static const varjo_PropertyKey varjo_PropertyKey_GazeCalibrating = 0xA000;

static const varjo_PropertyKey varjo_PropertyKey_GazeCalibrated = 0xA001;

static const varjo_PropertyKey varjo_PropertyKey_GazeCalibrationQuality = 0xA002;

static const varjo_PropertyKey varjo_PropertyKey_GazeAllowed = 0xA003;

static const varjo_PropertyKey varjo_PropertyKey_GazeEyeCalibrationQuality_Left =

    0xA004;

static const varjo_PropertyKey varjo_PropertyKey_GazeEyeCalibrationQuality_Right =

    0xA005;

static const varjo_PropertyKey varjo_PropertyKey_GazeIPDEstimate = 0xA010;

static const varjo_PropertyKey varjo_PropertyKey_HMDConnected = 0xE001;

static const varjo_PropertyKey varjo_PropertyKey_HMDProductName = 0xE002;

static const varjo_PropertyKey varjo_PropertyKey_HMDSerialNumber = 0xE003;

static const varjo_PropertyKey varjo_PropertyKey_MRAvailable = 0xD000;


typedef int64_t varjo_PoseType;

static const varjo_PoseType varjo_PoseType_LeftEye = 0x1;

static const varjo_PoseType varjo_PoseType_Center = 0x2;

static const varjo_PoseType varjo_PoseType_RightEye = 0x3;


typedef int64_t varjo_DisplayType;

static const varjo_DisplayType varjo_DisplayType_Focus = 0x1;

static const varjo_DisplayType varjo_DisplayType_Context = 0x2;


typedef int64_t varjo_Eye;

static const varjo_Eye varjo_Eye_Left = 0x1;

static const varjo_Eye varjo_Eye_Right = 0x2;


typedef int64_t varjo_WindingOrder;

static const varjo_WindingOrder varjo_WindingOrder_Clockwise = 0x1;

static const varjo_WindingOrder varjo_WindingOrder_CounterClockwise = 0x2;


typedef int64_t varjo_TextureFormat;

static const varjo_TextureFormat varjo_TextureFormat_INVALID = 0;

static const varjo_TextureFormat varjo_TextureFormat_R8G8B8A8_SRGB = 1;

static const varjo_TextureFormat varjo_TextureFormat_B8G8R8A8_SRGB = 2;

static const varjo_TextureFormat varjo_DepthTextureFormat_D32_FLOAT = 3;

static const varjo_TextureFormat varjo_MaskTextureFormat_A8_UNORM = 4;

static const varjo_TextureFormat varjo_TextureFormat_YUV422 = 5;

static const varjo_TextureFormat varjo_TextureFormat_RGBA16_FLOAT = 6;

static const varjo_TextureFormat varjo_DepthTextureFormat_D24_UNORM_S8_UINT = 7;

static const varjo_TextureFormat varjo_DepthTextureFormat_D32_FLOAT_S8_UINT = 8;

static const varjo_TextureFormat varjo_TextureFormat_R8G8B8A8_UNORM = 9;

static const varjo_TextureFormat varjo_TextureFormat_R32_FLOAT = 10;

static const varjo_TextureFormat varjo_TextureFormat_R32_UINT = 11;

static const varjo_TextureFormat varjo_VelocityTextureFormat_R8G8B8A8_UINT = 12;

static const varjo_TextureFormat varjo_TextureFormat_NV12 =

    13;

static const varjo_TextureFormat varjo_TextureFormat_B8G8R8A8_UNORM = 14;

static const varjo_TextureFormat varjo_TextureFormat_Y8_UNORM = 15;


typedef int64_t varjo_RenderAPI;

static const varjo_RenderAPI varjo_RenderAPI_D3D11 = 0x1;

static const varjo_RenderAPI varjo_RenderAPI_GL = 0x2;

static const varjo_RenderAPI varjo_RenderAPI_D3D12 = 0x3;


typedef int64_t varjo_EulerOrder;

static const varjo_EulerOrder varjo_EulerOrder_XYZ = 0;

static const varjo_EulerOrder varjo_EulerOrder_ZYX = 1;

static const varjo_EulerOrder varjo_EulerOrder_XZY = 2;

static const varjo_EulerOrder varjo_EulerOrder_YZX = 3;

static const varjo_EulerOrder varjo_EulerOrder_YXZ = 4;

static const varjo_EulerOrder varjo_EulerOrder_ZXY = 5;


typedef int64_t varjo_RotationDirection;

static const varjo_RotationDirection varjo_RotationDirection_Clockwise = -1;

static const varjo_RotationDirection varjo_RotationDirection_CounterClockwise = 1;


typedef int64_t varjo_Handedness;

static const varjo_Handedness varjo_Handedness_RightHanded = 1;

static const varjo_Handedness varjo_Handedness_LeftHanded = -1;


typedef int64_t varjo_ClipRange;

static const varjo_ClipRange varjo_ClipRangeZeroToOne = 0;

static const varjo_ClipRange varjo_ClipRangeMinusOneToOne = 1;


typedef int64_t varjo_SubmitFlags;


static const char* varjo_GazeParametersKey_OutputFilterType = "OutputFilterType";

static const char* varjo_GazeParametersValue_OutputFilterStandard = "Standard";

static const char* varjo_GazeParametersValue_OutputFilterNone = "None";


static const char* varjo_GazeParametersKey_OutputFrequency = "OutputFrequency";

static const char* varjo_GazeParametersValue_OutputFrequency100Hz = "OutputFrequency100Hz";

static const char* varjo_GazeParametersValue_OutputFrequency200Hz = "OutputFrequency200Hz";

static const char* varjo_GazeParametersValue_OutputFrequencyMaximumSupported =

    "OutputFrequencyMaximumSupported";


static const char* varjo_GazeCalibrationParametersKey_CalibrationType = "GazeCalibrationType";

static const char* varjo_GazeCalibrationParametersValue_CalibrationLegacy = "Legacy";

static const char* varjo_GazeCalibrationParametersValue_CalibrationFast = "Fast";

static const char* varjo_GazeCalibrationParametersValue_CalibrationOneDot = "OneDot";


VARJORUNTIME_DEPRECATED static const char* varjo_GazeCalibrationParametersKey_OutputFilterType = "OutputFilterType";

VARJORUNTIME_DEPRECATED static const char* varjo_GazeCalibrationParametersValue_OutputFilterStandard = "Standard";

VARJORUNTIME_DEPRECATED static const char* varjo_GazeCalibrationParametersValue_OutputFilterNone = "None";


struct varjo_Session;


struct varjo_Matrix {

    double value[16];

};


struct varjo_Matrix3x3 {

    double value[9];

};


struct varjo_Ray {

    double origin[3];

    double forward[3];

};


struct varjo_Vector2Df {

    float x;

    float y;

};


/*

 * 64bit floating point 3D vector.

 */

struct varjo_Vector3D {

    double x;

    double y;

    double z;

};


/*

 * 32bit floating point 3D vector.

 */

struct varjo_Vector3Df {

    float x;

    float y;

    float z;

};


/*

 * 32bit integer point 3D vector.

 */

struct varjo_Vector3Di {

    int32_t x;

    int32_t y;

    int32_t z;

};


struct varjo_Size3D {

    double width;

    double height;

    double depth;

};


struct varjo_Mesh2Df {

    struct varjo_Vector2Df* vertices;

    int32_t vertexCount;

};


struct varjo_AlignedView {

    double projectionTop;

    double projectionBottom;

    double projectionLeft;

    double projectionRight;

};


struct varjo_ViewInfo {

    double projectionMatrix[16];

    double viewMatrix[16];

    int32_t preferredWidth;

    int32_t preferredHeight;

    varjo_Bool enabled;

    int32_t reserved;

};


struct varjo_FrameInfo {

    struct varjo_ViewInfo* views;

    varjo_Nanoseconds displayTime;

    int64_t frameNumber;

};


struct varjo_ViewDescription {

    int32_t width;

    int32_t height;

    varjo_DisplayType display;

    varjo_Eye eye;

};


struct varjo_Gaze {

    struct varjo_Ray leftEye;

    struct varjo_Ray rightEye;

    struct varjo_Ray gaze;

    double focusDistance;

    double stability;

    varjo_Nanoseconds captureTime;

    varjo_GazeEyeStatus leftStatus;

    varjo_GazeEyeStatus rightStatus;

    varjo_GazeStatus status;

    int64_t frameNumber;

    VARJORUNTIME_DEPRECATED double leftPupilSize;

    VARJORUNTIME_DEPRECATED double rightPupilSize;

};


struct varjo_EyeMeasurements {

    int64_t frameNumber;

    varjo_Nanoseconds captureTime;

    float interPupillaryDistanceInMM;

    float leftPupilIrisDiameterRatio;

    float rightPupilIrisDiameterRatio;

    float leftPupilDiameterInMM;

    float rightPupilDiameterInMM;

    float leftIrisDiameterInMM;

    float rightIrisDiameterInMM;

};


struct varjo_SwapChainLimits {

    int32_t minimumNumberOfTextures;

    int32_t maximumNumberOfTextures;

    int32_t minimumTextureWidth;

    int32_t minimumTextureHeight;

    int32_t maximumTextureWidth;

    int32_t maximumTextureHeight;

};


struct varjo_Viewport {

    int32_t x;

    int32_t y;

    int32_t width;

    int32_t height;

};


struct varjo_Texture {

    int64_t reserved[4];

};


struct varjo_GazeParameters {

    const char* key;

    const char* value;

};


struct varjo_GazeCalibrationParameters {

    const char* key;

    const char* value;

};


typedef int64_t varjo_TextureSize_Type;

VARJORUNTIME_DEPRECATED const varjo_TextureSize_Type varjo_TextureSize_Type_BestQuality = 0;

VARJORUNTIME_DEPRECATED const varjo_TextureSize_Type varjo_TextureSize_Type_Recommended =

    1;

const varjo_TextureSize_Type varjo_TextureSize_Type_Quad = 1;

const varjo_TextureSize_Type varjo_TextureSize_Type_DynamicFoveation = 2;

const varjo_TextureSize_Type varjo_TextureSize_Type_Stereo = 3;


typedef int64_t varjo_TextureSize_Type_Mask;

VARJORUNTIME_DEPRECATED const varjo_TextureSize_Type_Mask varjo_TextureSize_Type_BestQuality_Mask = 0x1;

VARJORUNTIME_DEPRECATED const varjo_TextureSize_Type_Mask varjo_TextureSize_Type_Recommended_Mask = 0x2;

const varjo_TextureSize_Type_Mask varjo_TextureSize_Type_Quad_Mask = 0x2;

const varjo_TextureSize_Type_Mask varjo_TextureSize_Type_DynamicFoveation_Mask = 0x4;

const varjo_TextureSize_Type_Mask varjo_TextureSize_Type_Stereo_Mask = 0x8;


struct varjo_FovTangents {

    double top;     // Signed tangent of the top FOV half angle

    double bottom;  // Signed tangent of the bottom FOV half angle

    double left;    // Signed tangent of the left FOV half angle

    double right;   // Signed tangent of the right FOV half angle

};


struct varjo_FoveatedFovTangents_Hints {

    int64_t reserved[128];

};


typedef int64_t varjo_VariableRateShadingFlags;

const varjo_VariableRateShadingFlags varjo_VariableRateShadingFlag_None = 0;

const varjo_VariableRateShadingFlags varjo_VariableRateShadingFlag_Stereo = 1;

const varjo_VariableRateShadingFlags varjo_VariableRateShadingFlag_Gaze = 2;

const varjo_VariableRateShadingFlags varjo_VariableRateShadingFlag_GazeCombined =

    4;

const varjo_VariableRateShadingFlags varjo_VariableRateShadingFlag_OcclusionMap =

    8;


typedef int varjo_ShadingRate;

static const varjo_ShadingRate varjo_ShadingRate_Cull = 0;

static const varjo_ShadingRate varjo_ShadingRate_X16PerPixel = 1;

static const varjo_ShadingRate varjo_ShadingRate_X8PerPixel = 2;

static const varjo_ShadingRate varjo_ShadingRate_X4PerPixel = 3;

static const varjo_ShadingRate varjo_ShadingRate_X2PerPixel = 4;

static const varjo_ShadingRate varjo_ShadingRate_1x1 = 5;

static const varjo_ShadingRate varjo_ShadingRate_1x2 = 6;

static const varjo_ShadingRate varjo_ShadingRate_2x1 = 7;

static const varjo_ShadingRate varjo_ShadingRate_2x2 = 8;

static const varjo_ShadingRate varjo_ShadingRate_2x4 = 9;

static const varjo_ShadingRate varjo_ShadingRate_4x2 = 10;

static const varjo_ShadingRate varjo_ShadingRate_4x4 = 11;


struct varjo_ShadingRateTable {

    varjo_ShadingRate shadingRates[16];

};


typedef int64_t varjo_StructureType;


struct varjo_StructureExtension {

    varjo_StructureType type;

    struct varjo_StructureExtension* next;

};


struct varjo_VariableRateShadingConfig {

    struct varjo_StructureExtension* next;

    struct varjo_Gaze gaze;

    int32_t viewIndex;

    struct varjo_Viewport viewport;

    varjo_VariableRateShadingFlags flags;

    float innerRadius;

    float outerRadius;

};


#if defined __cplusplus

}

#endif


#endif  // VARJO_TYPES_H