 |
Fove SDK
v1.3.1
|
|
Fove SDK
v1.3.1
|
This file contains the entire FOVE API, no other headers are needed. More...
#include <exception>#include <string>#include <utility>#include <vector>#include <stdbool.h>#include <stddef.h>#include <stdint.h>
Classes | |
| class | Fove::Compositor |
| Compositor API. More... | |
| struct | Fove::Details::ConfigHelperStruct< T > |
| struct | Fove::Details::ConfigHelperStruct< bool > |
| struct | Fove::Details::ConfigHelperStruct< float > |
| struct | Fove::Details::ConfigHelperStruct< int > |
| struct | Fove::Exception |
| Exception type that is thrown when an error is ignored in the FOVE API. More... | |
| class | Fove::Headset |
| Main API for using headsets. More... | |
| struct | Fove::HeadsetHardwareInfo |
| Struct Contains hardware information for the headset. More... | |
| class | Fove::Object< CType > |
| Base class for classes in the FOVE C++ API. More... | |
| class | Fove::Result< Value > |
| Class for return values from the C++ API. More... | |
| struct | Fove::Stereo< Type > |
| Class to hold two copies of something, one for each left and right respectively. More... | |
| struct | Fove_AdapterId |
| Struct used to identify a GPU adapter (Windows only) More... | |
| struct | Fove_BitmapImage |
| A 2D bitmap image. More... | |
| struct | Fove_BoundingBox |
| A bounding box. More... | |
| struct | Fove_Buffer |
| A generic memory buffer. More... | |
| struct | Fove_CalibrationData |
| Provide all the calibration data needed to render the current state of the calibration process. More... | |
| struct | Fove_CalibrationOptions |
| Parameters specifying how to run a calibration process. More... | |
| struct | Fove_CalibrationTarget |
| Represent a calibration target of the calibration process. More... | |
| struct | Fove_CameraObject |
| Represents a camera in a 3D world. More... | |
| struct | Fove_ColliderCube |
| Define a cube collider shape. More... | |
| struct | Fove_ColliderMesh |
| Define a mesh collider shape. More... | |
| struct | Fove_ColliderSphere |
| Define a sphere collider shape. More... | |
| struct | Fove_CompositorLayer |
| Struct used to store information about an existing compositor layer (after it is created) More... | |
| struct | Fove_CompositorLayerCreateInfo |
| Struct used to define the settings for a compositor client. More... | |
| struct | Fove_CompositorLayerEyeSubmitInfo |
| Struct used to conglomerate the texture settings for a single eye, when submitting a given layer. More... | |
| struct | Fove_CompositorLayerSubmitInfo |
| Struct used to conglomerate the texture settings when submitting a given layer. More... | |
| struct | Fove_CompositorTexture |
| Base class of API-specific texture classes. More... | |
| struct | Fove_DX11Texture |
| Struct used to submit a DirectX 11 texture. More... | |
| struct | Fove_DX12Texture |
| Struct used to submit a DirectX 12 texture. More... | |
| struct | Fove_EyeShape |
| Specify the shape of an eye. More... | |
| struct | Fove_FrameTimestamp |
| A frame timestamp information. More... | |
| struct | Fove_GazableObject |
| Represents an object in a 3D world. More... | |
| struct | Fove_GLTexture |
| Struct used to submit an OpenGL texture. More... | |
| struct | Fove_HeadsetHardwareInfo |
| Struct Contains hardware information for the headset. More... | |
| struct | Fove_HmdAdjustmentData |
| Provide all the HMD positioning data needed to render the current state of the HMD adjustment process. More... | |
| struct | Fove_LicenseInfo |
| Struct with details about a FOVE license. More... | |
| struct | Fove_Matrix44 |
| Struct to hold a rectangular array. More... | |
| struct | Fove_MetalTexture |
| Struct used to submit a texture using the Apple Metal API. More... | |
| struct | Fove_ObjectCollider |
| Represents a colliding part of a gazable object. More... | |
| struct | Fove_ObjectPose |
| Represents the pose of an object of the scene. More... | |
| struct | Fove_Pose |
| Struct to represent a combination of position and orientation of Fove Headset. More... | |
| struct | Fove_ProjectionParams |
| Struct holding information about projection frustum planes. More... | |
| struct | Fove_PupilShape |
| Specity the shape of a pupil as an ellipse. More... | |
| struct | Fove_Quaternion |
| Struct representation on a quaternion. More... | |
| struct | Fove_Ray |
| Struct to represent a Ray. More... | |
| struct | Fove_TextureBounds |
| Specify a region of a texture in normalized space. More... | |
| struct | Fove_Vec2 |
| Struct to represent a 2D-vector. More... | |
| struct | Fove_Vec2i |
| Struct to represent a 2D-vector of integers. More... | |
| struct | Fove_Vec3 |
| Struct to represent a 3D-vector. More... | |
| struct | Fove_Versions |
| Struct to list various version info about the FOVE software. More... | |
| struct | Fove_VulkanContext |
| Struct to represent a suite of vulkan components to be used for texture submission. More... | |
| struct | Fove_VulkanTexture |
| struct | Fove_VulkanTextureResources |
| Struct to hold handles to resources for a texture. More... | |
Macros | |
| #define | FOVE_CALLBACK |
| Defines any needed modifiers to function pointers for callbacks, e.g. to use a different calling convention. | |
| #define | FOVE_CONSTEXPR const |
| Helper for declaring a compile time constant. | |
| #define | FOVE_CXX_NAMESPACE Fove |
| #define | FOVE_DEFINE_CXX_API 0 |
| Macro that controls whether the C++ API will be defined. More... | |
| #define | FOVE_DEPRECATED(func, rem) func |
| Helper for declaring deprecated functions. | |
| #define | FOVE_ENUM(enumName) enum class Fove_ ## enumName |
| Helper to start an API enum. | |
| #define | FOVE_ENUM_END(enumName) ; namespace FOVE_CXX_NAMESPACE { using enumName = Fove_ ## enumName; } |
| Helper to finish an API enum. | |
| #define | FOVE_ENUM_VAL(enumName, valueName) valueName |
| Helper to add a value to an API enum. | |
| #define | FOVE_EXCEPTIONS 1 |
| #define | FOVE_EXPORT FOVE_EXTERN_C |
| Helper for declaring the public visibility of a function. | |
| #define | FOVE_EXTERN_C |
| Helper for disabling name mangling, etc. | |
| #define | FOVE_NOEXCEPT |
| Define this to empty to remove noexcept specifiers from the API. | |
| #define | FOVE_STRUCT(structName) struct Fove_ ## structName |
| Helper to start an API struct. | |
| #define | FOVE_STRUCT_ARRAY(Type, size, memberName, defaultVal) Type FOVE_STRUCT_VAL(memberName[size], defaultVal) |
| Helper to add a member array to an API struct. | |
| #define | FOVE_STRUCT_ARRAY_CPTR(member) member |
| Helper to get the c pointer from an item defined via FOVE_STRUCT_ARRAY. | |
| #define | FOVE_STRUCT_END(structName) ; namespace FOVE_CXX_NAMESPACE { using structName = Fove_ ## structName; } |
| Helper to complete an API struct. | |
| #define | FOVE_STRUCT_END_NO_CXX_ALIAS(structName) |
| Helper to complete an API struct without aliasing it in C++. | |
| #define | FOVE_STRUCT_VAL(memberName, defaultVal) memberName = defaultVal |
| Helper to add a member to an API struct. | |
| #define | FOVE_USE_STD_ARRAY 0 |
| Define this to use std::array instead of C arrays. | |
Typedefs | |
| using | Fove::AdapterId = Fove_AdapterId |
| using | Fove::AlphaMode = Fove_AlphaMode |
| using | Fove::BitmapImage = Fove_BitmapImage |
| using | Fove::BoundingBox = Fove_BoundingBox |
| using | Fove::Buffer = Fove_Buffer |
| using | Fove::CalibrationData = Fove_CalibrationData |
| using | Fove::CalibrationMethod = Fove_CalibrationMethod |
| using | Fove::CalibrationOptions = Fove_CalibrationOptions |
| using | Fove::CalibrationState = Fove_CalibrationState |
| using | Fove::CalibrationTarget = Fove_CalibrationTarget |
| using | Fove::CameraObject = Fove_CameraObject |
| using | Fove::ClientCapabilities = Fove_ClientCapabilities |
| using | Fove::ColliderCube = Fove_ColliderCube |
| using | Fove::ColliderMesh = Fove_ColliderMesh |
| using | Fove::ColliderSphere = Fove_ColliderSphere |
| using | Fove::ColliderType = Fove_ColliderType |
| using | Fove::CompositorLayer = Fove_CompositorLayer |
| using | Fove::CompositorLayerCreateInfo = Fove_CompositorLayerCreateInfo |
| using | Fove::CompositorLayerEyeSubmitInfo = Fove_CompositorLayerEyeSubmitInfo |
| using | Fove::CompositorLayerSubmitInfo = Fove_CompositorLayerSubmitInfo |
| using | Fove::CompositorLayerType = Fove_CompositorLayerType |
| using | Fove::CompositorTexture = Fove_CompositorTexture |
| using | Fove::DX11Texture = Fove_DX11Texture |
| using | Fove::DX12Texture = Fove_DX12Texture |
| using | Fove::ErrorCode = Fove_ErrorCode |
| using | Fove::Eye = Fove_Eye |
| using | Fove::EyeByEyeCalibration = Fove_EyeByEyeCalibration |
| using | Fove::EyeShape = Fove_EyeShape |
| using | Fove::EyeState = Fove_EyeState |
| using | Fove::EyeTorsionCalibration = Fove_EyeTorsionCalibration |
| typedef struct Fove_Compositor_ * | Fove_Compositor |
| Opaque type representing a compositor connection. | |
| typedef struct Fove_Headset_ * | Fove_Headset |
| Opaque type representing a headset object. | |
| typedef struct VkDevice_T * | Fove_VkDevice |
| Opaque type representing a vulkan logical device (It must have VK_KHR_external_memory and VK_KHR_external_memory_fd enabled) | |
| typedef struct VkDeviceMemory_T * | Fove_VkDeviceMemory |
| Opaque type representing a vulkan device memory region. | |
| typedef struct VkImage_T * | Fove_VkImage |
| Opaque type representing a vulkan image. | |
| typedef struct VkImageView_T * | Fove_VkImageView |
| Opaque type representing a vulkan image view. | |
| typedef struct VkInstance_T * | Fove_VkInstance |
| Opaque type representing a vulkan instance. | |
| typedef struct VkPhysicalDevice_T * | Fove_VkPhysicalDevice |
| Opaque type representing a vulkan physical device. | |
| typedef struct VkQueue_T * | Fove_VkQueue |
| Opaque type representing a vulkan queue. | |
| using | Fove::FrameTimestamp = Fove_FrameTimestamp |
| using | Fove::GazableObject = Fove_GazableObject |
| using | Fove::GLTexture = Fove_GLTexture |
| using | Fove::GraphicsAPI = Fove_GraphicsAPI |
| using | Fove::HmdAdjustmentData = Fove_HmdAdjustmentData |
| using | Fove::LicenseInfo = Fove_LicenseInfo |
| using | Fove::LogLevel = Fove_LogLevel |
| using | Fove::Matrix44 = Fove_Matrix44 |
| using | Fove::MetalTexture = Fove_MetalTexture |
| using | Fove::ObjectCollider = Fove_ObjectCollider |
| using | Fove::ObjectGroup = Fove_ObjectGroup |
| using | Fove::ObjectPose = Fove_ObjectPose |
| using | Fove::Pose = Fove_Pose |
| using | Fove::ProjectionParams = Fove_ProjectionParams |
| using | Fove::PupilShape = Fove_PupilShape |
| using | Fove::Quaternion = Fove_Quaternion |
| using | Fove::Ray = Fove_Ray |
| using | Fove::TextureBounds = Fove_TextureBounds |
| using | Fove::Vec2 = Fove_Vec2 |
| using | Fove::Vec2i = Fove_Vec2i |
| using | Fove::Vec3 = Fove_Vec3 |
| using | Fove::Versions = Fove_Versions |
| using | Fove::VulkanContext = Fove_VulkanContext |
| using | Fove::VulkanTexture = Fove_VulkanTexture |
| using | Fove::VulkanTextureResources = Fove_VulkanTextureResources |
Enumerations | |
| enum class | Fove_AlphaMode { Auto = 0 , One = 1 , Sample = 2 } |
| Enum to help interpret the alpha of texture. More... | |
| enum class | Fove_CalibrationMethod { Default , OnePoint , Spiral , OnePointWithNoGlassesSpiralWithGlasses , ZeroPoint , DefaultCalibration } |
| Indicate the calibration method to use. More... | |
| enum class | Fove_CalibrationState { NotStarted , HeadsetAdjustment , WaitingForUser , CollectingData , ProcessingData , Successful_HighQuality , Successful_MediumQuality , Successful_LowQuality , Failed_Unknown , Failed_InaccurateData , Failed_NoRenderer , Failed_NoUser , Failed_Aborted } |
| Indicate the state of a calibration process. More... | |
| enum class | Fove_ClientCapabilities { None = 0 , OrientationTracking = 1 << 0 , PositionTracking = 1 << 1 , PositionImage = 1 << 2 , EyeTracking = 1 << 3 , GazeDepth = 1 << 4 , UserPresence = 1 << 5 , UserAttentionShift = 1 << 6 , UserIOD = 1 << 7 , UserIPD = 1 << 8 , EyeTorsion = 1 << 9 , EyeShape = 1 << 10 , EyesImage = 1 << 11 , EyeballRadius = 1 << 12 , IrisRadius = 1 << 13 , PupilRadius = 1 << 14 , GazedObjectDetection = 1 << 15 , DirectScreenAccess = 1 << 16 , PupilShape = 1 << 17 , EyeBlink = 1 << 18 } |
| List of capabilities usable by clients. More... | |
| enum class | Fove_ColliderType { Cube = 0 , Sphere = 1 , Mesh = 2 } |
| Specify the different collider shape types. More... | |
| enum class | Fove_CompositorLayerType { Base = 0 , Overlay = 0x10000 , Diagnostic = 0x20000 } |
| Compositor layer type, which defines how clients are composited. More... | |
| enum class | Fove_ErrorCode { None = 0 , Connect_NotConnected = 7 , Connect_RuntimeVersionTooOld = 4 , Connect_ClientVersionTooOld = 6 , API_InvalidArgument = 103 , API_NotRegistered = 104 , API_NullInPointer = 110 , API_InvalidEnumValue = 111 , API_NullOutPointersOnly = 120 , API_OverlappingOutPointers = 121 , API_MissingArgument = 123 , API_AlreadyInTheDesiredState = 124 , API_Timeout = 130 , Data_Unreadable = 1002 , Data_NoUpdate = 1003 , Data_Uncalibrated = 1004 , Data_Unreliable = 1006 , Data_LowAccuracy = 1007 , Hardware_Disconnected = 2006 , Hardware_WrongFirmwareVersion = 2007 , Code_NotImplementedYet = 4000 , Code_FunctionDeprecated = 4001 , Position_ObjectNotTracked = 5008 , Compositor_NotSwapped = 122 , Compositor_UnableToCreateDeviceAndContext = 8000 , Compositor_UnableToUseTexture = 8001 , Compositor_DeviceMismatch = 8002 , Compositor_DisconnectedFromRuntime = 8006 , Compositor_ErrorCreatingTexturesOnDevice = 8008 , Compositor_NoEyeSpecifiedForSubmit = 8009 , UnknownError = 9000 , Object_AlreadyRegistered = 10000 , Render_OtherRendererPrioritized = 11000 , License_FeatureAccessDenied = 12000 , License_Expired = 12001 , License_ClockError = 12003 , License_TooManyActivations = 12004 , Profile_DoesntExist = 13000 , Profile_NotAvailable = 13001 , Profile_InvalidName = 13002 , Config_DoesntExist = 14000 , Config_TypeMismatch = 14001 , System_UnknownError = 15000 , System_PathNotFound = 15001 , System_AccessDenied = 15002 } |
| The error codes that the Fove system may return. More... | |
| enum class | Fove_Eye { Left = 0 , Right = 1 } |
| Enum specifying the left or right eye. More... | |
| enum class | Fove_EyeByEyeCalibration { Default , Disabled , Enabled } |
| Indicate whether each eye should be calibrated separately or not. More... | |
| enum class | Fove_EyeState { NotDetected = 0 , Opened = 1 , Closed = 2 } |
| Enum specifying the state of an eye. More... | |
| enum class | Fove_EyeTorsionCalibration { Default , IfEnabled , Always } |
| Indicate whether eye torsion calibration should be run or not. More... | |
| enum class | Fove_GraphicsAPI { DirectX = 0 , OpenGL = 1 , Metal = 2 , Vulkan = 3 , DirectX12 = 4 } |
| Enum for type of Graphics API. More... | |
| enum class | Fove_LogLevel { Debug = 0 , Warning = 1 , Error = 2 } |
| Severity level of log messages. More... | |
| enum class | Fove_ObjectGroup { Group0 = 1 << 0 , Group1 = 1 << 1 , Group2 = 1 << 2 , Group3 = 1 << 3 , Group4 = 1 << 4 , Group5 = 1 << 5 , Group6 = 1 << 6 , Group7 = 1 << 7 , Group8 = 1 << 8 , Group9 = 1 << 9 , Group10 = 1 << 10 , Group11 = 1 << 11 , Group12 = 1 << 12 , Group13 = 1 << 13 , Group14 = 1 << 14 , Group15 = 1 << 15 , Group16 = 1 << 16 , Group17 = 1 << 17 , Group18 = 1 << 18 , Group19 = 1 << 19 , Group20 = 1 << 20 , Group21 = 1 << 21 , Group22 = 1 << 22 , Group23 = 1 << 23 , Group24 = 1 << 24 , Group25 = 1 << 25 , Group26 = 1 << 26 , Group27 = 1 << 27 , Group28 = 1 << 28 , Group29 = 1 << 29 , Group30 = 1 << 30 , Group31 = 1 << 31 } |
| The groups of objects of the scene. | |
Functions | |
| Result | Fove::clearConfigValue (const std::string &key) |
| Fove_ErrorCode | fove_Compositor_createLayer (Fove_Compositor *, const Fove_CompositorLayerCreateInfo *layerInfo, Fove_CompositorLayer *outLayer) |
| Creates a new layer within the compositor. More... | |
| Fove_ErrorCode | fove_Compositor_destroy (Fove_Compositor *) |
| Frees resources used by the compositor object, including memory and sockets. More... | |
| Fove_ErrorCode | fove_Compositor_getLastRenderPose (Fove_Compositor *, Fove_Pose *outPose) |
| Get the last cached pose for rendering purposes. | |
| Fove_ErrorCode | fove_Compositor_getMirrorTexture (Fove_Compositor *, Fove_CompositorTexture *outTexture, int *outWidth, int *outHeight) |
| Fetches the GPU-side mirror texture for the compositor. More... | |
| Fove_ErrorCode | fove_Compositor_isReady (Fove_Compositor *, bool *outIsReady) |
| Returns true if we are connected to a running compositor and ready to submit frames for compositing. | |
| Fove_ErrorCode | fove_Compositor_queryAdapterId (Fove_Compositor *, Fove_AdapterId *outAdapterId) |
| Returns the ID of the GPU currently attached to the headset. More... | |
| Fove_ErrorCode | fove_Compositor_submit (Fove_Compositor *, const Fove_CompositorLayerSubmitInfo *submitInfo, size_t layerCount) |
| Submit a frame to the compositor. More... | |
| Fove_ErrorCode | fove_Compositor_waitForRenderPose (Fove_Compositor *, Fove_Pose *outPose) |
| Wait for the next pose to use for rendering purposes. More... | |
| Fove_ErrorCode | fove_Config_clearValue (const char *key) |
| Reset the value of the provided key to its default value. More... | |
| Fove_ErrorCode | fove_Config_getValue_bool (const char *key, bool *outValue) |
| Get the value of the provided key from the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_getValue_float (const char *key, float *outValue) |
| Get the value of the provided key from the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_getValue_int (const char *key, int *outValue) |
| Get the value of the provided key from the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_getValue_string (const char *key, void(*callback)(const char *value, void *callbackData), void *callbackData) |
| Get the value of the provided key from the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_setValue_bool (const char *key, bool value) |
| Set the value of the provided key to the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_setValue_float (const char *key, float value) |
| Set the value of the provided key to the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_setValue_int (const char *key, int value) |
| Set the value of the provided key to the FOVE config. More... | |
| Fove_ErrorCode | fove_Config_setValue_string (const char *key, const char *value) |
| Set the value of the provided key to the FOVE config. More... | |
| Fove_ErrorCode | fove_createHeadset (Fove_ClientCapabilities capabilities, Fove_Headset **outHeadset) |
| Creates and returns an Fove_Headset object, which is the entry point to the entire API. More... | |
| Fove_ErrorCode | fove_Headset_activateLicense (Fove_Headset *, const char *licenseKey) |
| Activates a license. More... | |
| Fove_ErrorCode | fove_Headset_checkSoftwareVersions (Fove_Headset *) |
| Checks whether the client can run against the installed version of the FOVE SDK. More... | |
| Fove_ErrorCode | fove_Headset_createCompositor (Fove_Headset *, Fove_Compositor **outCompositor) |
| Returns a compositor interface from the given headset. More... | |
| Fove_ErrorCode | fove_Headset_createProfile (Fove_Headset *, const char *newName) |
| Creates a new profile. More... | |
| Fove_ErrorCode | fove_Headset_deactivateLicense (Fove_Headset *, const char *licenseData) |
| Deactivates a previously activated license. More... | |
| Fove_ErrorCode | fove_Headset_deleteProfile (Fove_Headset *, const char *profileName) |
| Deletes an existing profile. More... | |
| Fove_ErrorCode | fove_Headset_destroy (Fove_Headset *) |
| Frees resources used by a headset object, including memory and sockets. More... | |
| Fove_ErrorCode | fove_Headset_fetchEyesImage (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Fetch the latest eyes camera image from the runtime service. More... | |
| Fove_ErrorCode | fove_Headset_fetchEyeTrackingData (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Fetch the latest eye tracking data from the runtime service. More... | |
| Fove_ErrorCode | fove_Headset_fetchPoseData (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Fetch the latest pose data, and cache it locally. More... | |
| Fove_ErrorCode | fove_Headset_fetchPositionImage (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Fetch the latest position camera image, and cache it locally. More... | |
| Fove_ErrorCode | fove_Headset_getCombinedGazeDepth (Fove_Headset *, float *outDepth) |
| Writes out eyes gaze depth resulting from the two eye gazes combined together. More... | |
| Fove_ErrorCode | fove_Headset_getCombinedGazeRay (Fove_Headset *, Fove_Ray *outRay) |
| Writes out eyes gaze ray resulting from the two eye gazes combined together. More... | |
| Fove_ErrorCode | fove_Headset_getEyeballRadius (Fove_Headset *, Fove_Eye eye, float *outRadius) |
| Returns the user eyeballs radius, in meters. More... | |
| Fove_ErrorCode | fove_Headset_getEyeBlinkCount (Fove_Headset *, Fove_Eye eye, int *outBlinkCount) |
| Writes out the number of blink performed for the given eye since the eye tracking service started. More... | |
| Fove_ErrorCode | fove_Headset_getEyeShape (Fove_Headset *, Fove_Eye eye, Fove_EyeShape *outShape) |
| Returns the outline shape of the specified user eye in the Eyes camera image. More... | |
| Fove_ErrorCode | fove_Headset_getEyesImage (Fove_Headset *, Fove_BitmapImage *outImage) |
| Returns the eyes camera image. More... | |
| Fove_ErrorCode | fove_Headset_getEyesImageTimestamp (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Writes out the eye frame timestamp of the cached eyes image. More... | |
| Fove_ErrorCode | fove_Headset_getEyeState (Fove_Headset *, Fove_Eye eye, Fove_EyeState *outState) |
| Writes out the state of an individual eye. More... | |
| Fove_ErrorCode | fove_Headset_getEyeToHeadMatrices (Fove_Headset *, Fove_Matrix44 *outLeft, Fove_Matrix44 *outRight) |
| Writes out the matrices to convert from eye to head space coordinates. More... | |
| Fove_ErrorCode | fove_Headset_getEyeTorsion (Fove_Headset *, Fove_Eye eye, float *outAngle) |
| Returns the user eye torsion, in degrees. More... | |
| Fove_ErrorCode | fove_Headset_getEyeTrackingCalibrationState (Fove_Headset *, Fove_CalibrationState *outCalibrationState) |
| Get the state of the currently running calibration process. | |
| Fove_ErrorCode | fove_Headset_getEyeTrackingCalibrationStateDetails (Fove_Headset *, void(*callback)(const Fove_CalibrationData *detailsData, void *callbackData), void *callbackData) |
| Get the detailed information about the state of the currently running calibration process. More... | |
| Fove_ErrorCode | fove_Headset_getEyeTrackingDataTimestamp (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Writes out the eye frame timestamp of the cached eye tracking data. More... | |
| Fove_ErrorCode | fove_Headset_getGazedObjectId (Fove_Headset *, int *const outObjectId) |
| Get the id of the object gazed by the user. More... | |
| Fove_ErrorCode | fove_Headset_getGazeScreenPosition (Fove_Headset *, Fove_Eye eye, Fove_Vec2 *outPos) |
| Writes out the user's 2D gaze position on the screens seen through the HMD's lenses. More... | |
| Fove_ErrorCode | fove_Headset_getGazeScreenPositionCombined (Fove_Headset *, Fove_Vec2 *outPos) |
| Writes out the user's 2D gaze position. More... | |
| Fove_ErrorCode | fove_Headset_getGazeVector (Fove_Headset *, Fove_Eye eye, Fove_Vec3 *outVector) |
| Writes out the gaze vector of an individual eye. More... | |
| Fove_ErrorCode | fove_Headset_getGazeVectorRaw (Fove_Headset *, Fove_Eye eye, Fove_Vec3 *outVector) |
| Writes out the raw gaze vector of an individual eye. More... | |
| Fove_ErrorCode | fove_Headset_getIrisRadius (Fove_Headset *, Fove_Eye eye, float *outRadius) |
| Returns the user iris radius, in meters. More... | |
| Fove_ErrorCode | fove_Headset_getPose (Fove_Headset *, Fove_Pose *outPose) |
| Writes out the pose of the head-mounted display. More... | |
| Fove_ErrorCode | fove_Headset_getPoseDataTimestamp (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Writes out the frame timestamp of the cached pose data. More... | |
| Fove_ErrorCode | fove_Headset_getPositionImage (Fove_Headset *, Fove_BitmapImage *outImage) |
| Returns the position camera image. More... | |
| Fove_ErrorCode | fove_Headset_getPositionImageTimestamp (Fove_Headset *, Fove_FrameTimestamp *outTimestamp) |
| Writes out the frame timestamp of the cached position image. More... | |
| Fove_ErrorCode | fove_Headset_getProjectionMatricesLH (Fove_Headset *, float zNear, float zFar, Fove_Matrix44 *outLeftMat, Fove_Matrix44 *outRightMat) |
| Writes out the values of passed-in left-handed 4x4 projection matrices. More... | |
| Fove_ErrorCode | fove_Headset_getProjectionMatricesRH (Fove_Headset *, float zNear, float zFar, Fove_Matrix44 *outLeftMat, Fove_Matrix44 *outRightMat) |
| Writes out the values of passed-in right-handed 4x4 projection matrices. More... | |
| Fove_ErrorCode | fove_Headset_getPupilRadius (Fove_Headset *, Fove_Eye eye, float *outRadius) |
| Returns the user pupils radius, in meters. More... | |
| Fove_ErrorCode | fove_Headset_getPupilShape (Fove_Headset *, Fove_Eye eye, Fove_PupilShape *outShape) |
| Returns the pupil shape of the specified user eye in the Eyes camera image. More... | |
| Fove_ErrorCode | fove_Headset_getRawProjectionValues (Fove_Headset *, Fove_ProjectionParams *outLeft, Fove_ProjectionParams *outRight) |
| Writes out values for the view frustum of the specified eye at 1 unit away. More... | |
| Fove_ErrorCode | fove_Headset_getRenderIOD (Fove_Headset *, float *outIOD) |
| Interocular distance to use for rendering in meters. More... | |
| Fove_ErrorCode | fove_Headset_getUserIOD (Fove_Headset *, float *outIOD) |
| Returns the user IOD (Inter Occular Distance), in meters. More... | |
| Fove_ErrorCode | fove_Headset_getUserIPD (Fove_Headset *, float *outIPD) |
| Returns the user IPD (Inter Pupillary Distance), in meters. More... | |
| Fove_ErrorCode | fove_Headset_hasAccessToFeature (Fove_Headset *, const char *inFeatureName, bool *outHasAccess) |
| Returns whether the Headset has access to the given feature. More... | |
| Fove_ErrorCode | fove_Headset_hasHmdAdjustmentGuiTimeout (Fove_Headset *, bool *outTimeout) |
| Writes out whether the GUI that asks the user to adjust their headset was hidden by timeout. More... | |
| Fove_ErrorCode | fove_Headset_isEyeBlinking (Fove_Headset *, Fove_Eye eye, bool *outIsBlinking) |
| Writes out whether the user is currently performing a blink for the given eye. More... | |
| Fove_ErrorCode | fove_Headset_isEyeTrackingCalibrated (Fove_Headset *, bool *outEyeTrackingCalibrated) |
| Writes out whether eye tracking has been calibrated. More... | |
| Fove_ErrorCode | fove_Headset_isEyeTrackingCalibratedForGlasses (Fove_Headset *, bool *outGlasses) |
| Writes out whether the eye tracking system is currently calibrated for glasses. More... | |
| Fove_ErrorCode | fove_Headset_isEyeTrackingCalibrating (Fove_Headset *, bool *outEyeTrackingCalibrating) |
| Writes out whether eye tracking is in the process of performing a calibration. More... | |
| Fove_ErrorCode | fove_Headset_isEyeTrackingEnabled (Fove_Headset *, bool *outEyeTrackingEnabled) |
| Writes out whether the eye tracking hardware has started. More... | |
| Fove_ErrorCode | fove_Headset_isEyeTrackingReady (Fove_Headset *, bool *outEyeTrackingReady) |
| Writes out whether eye tracking is actively tracking eyes. More... | |
| Fove_ErrorCode | fove_Headset_isHardwareConnected (Fove_Headset *, bool *outHardwareConnected) |
| Writes out whether an HMD is connected or not. More... | |
| Fove_ErrorCode | fove_Headset_isHmdAdjustmentGuiVisible (Fove_Headset *, bool *outHmdAdjustmentGuiVisible) |
| Writes out whether or not the GUI that asks the user to adjust their headset is being displayed. More... | |
| Fove_ErrorCode | fove_Headset_isMotionReady (Fove_Headset *, bool *outMotionReady) |
| Writes out whether motion tracking hardware has started. More... | |
| Fove_ErrorCode | fove_Headset_isPositionReady (Fove_Headset *, bool *outPositionReady) |
| Writes out whether position tracking hardware has started and returns whether it was successful. More... | |
| Fove_ErrorCode | fove_Headset_isUserPresent (Fove_Headset *, bool *outUserPresent) |
| Writes out whether the user is wearing the headset or not. More... | |
| Fove_ErrorCode | fove_Headset_isUserShiftingAttention (Fove_Headset *, bool *outIsShiftingAttention) |
| Writes out whether the user is shifting its attention between objects or looking at something specific (fixation or pursuit) More... | |
| Fove_ErrorCode | fove_Headset_listProfiles (Fove_Headset *, void(*callback)(const char *callbackProfileName, void *callbackData), void *callbackData) |
| Lists all existing profiles. More... | |
| Fove_ErrorCode | fove_Headset_queryCurrentProfile (Fove_Headset *, void(*callback)(const char *callbackProfileName, void *callbackData), void *callbackData) |
| Gets the current profile. More... | |
| Fove_ErrorCode | fove_Headset_queryHardwareInfo (Fove_Headset *, Fove_HeadsetHardwareInfo *outHardwareInfo) |
| Writes out the hardware information. More... | |
| Fove_ErrorCode | fove_Headset_queryLicenses (Fove_Headset *, Fove_LicenseInfo *outLicenseInfos, size_t *inOutArraySize) |
| Returns information about any licenses currently activated. More... | |
| Fove_ErrorCode | fove_Headset_queryProfileDataPath (Fove_Headset *, const char *profileName, void(*callback)(const char *callbackProfileName, void *callbackData), void *callbackData) |
| Gets the data folder for a given profile. More... | |
| Fove_ErrorCode | fove_Headset_querySoftwareVersions (Fove_Headset *, Fove_Versions *outSoftwareVersions) |
| Writes out the current software versions. More... | |
| Fove_ErrorCode | fove_Headset_registerCameraObject (Fove_Headset *, const Fove_CameraObject *camera) |
| Registers an camera in the 3D world. More... | |
| Fove_ErrorCode | fove_Headset_registerCapabilities (Fove_Headset *, Fove_ClientCapabilities caps) |
| Registers capabilities needed by this client. More... | |
| Fove_ErrorCode | fove_Headset_registerGazableObject (Fove_Headset *, const Fove_GazableObject *object) |
| Registers an object in the 3D world. More... | |
| Fove_ErrorCode | fove_Headset_removeCameraObject (Fove_Headset *, int cameraId) |
| Removes a previously registered camera from the scene. More... | |
| Fove_ErrorCode | fove_Headset_removeGazableObject (Fove_Headset *, int objectId) |
| Removes a previously registered 3D object from the scene. More... | |
| Fove_ErrorCode | fove_Headset_renameProfile (Fove_Headset *, const char *oldName, const char *newName) |
| Renames an existing profile. More... | |
| Fove_ErrorCode | fove_Headset_setCurrentProfile (Fove_Headset *, const char *profileName) |
| Sets the current profile. More... | |
| Fove_ErrorCode | fove_Headset_startEyeTrackingCalibration (Fove_Headset *, const Fove_CalibrationOptions *options) |
| Starts eye tracking calibration. More... | |
| Fove_ErrorCode | fove_Headset_startHmdAdjustmentProcess (Fove_Headset *, bool lazy) |
| Start the HMD adjustment process. Doing this will display the HMD adjustment GUI. More... | |
| Fove_ErrorCode | fove_Headset_stopEyeTrackingCalibration (Fove_Headset *) |
| Stops eye tracking calibration if it's running, does nothing if it's not running. | |
| Fove_ErrorCode | fove_Headset_tareOrientationSensor (Fove_Headset *) |
| Tares the orientation of the headset. More... | |
| Fove_ErrorCode | fove_Headset_tarePositionSensors (Fove_Headset *) |
| Tares the position of the headset. More... | |
| Fove_ErrorCode | fove_Headset_tickEyeTrackingCalibration (Fove_Headset *, float deltaTime, bool isVisible, void(*callback)(const Fove_CalibrationData *calibrationData, void *callbackData), void *callbackData) |
| Tick the current calibration process and retrieve data information to render the current calibration state. More... | |
| Fove_ErrorCode | fove_Headset_tickHmdAdjustmentProcess (Fove_Headset *, float deltaTime, bool isVisible, Fove_HmdAdjustmentData *outData) |
| Tick the current HMD adjustment process and retrieve data information to render the current HMD positioning state. More... | |
| Fove_ErrorCode | fove_Headset_unregisterCapabilities (Fove_Headset *, Fove_ClientCapabilities caps) |
| Unregisters capabilities previously registered by this client. More... | |
| Fove_ErrorCode | fove_Headset_updateCameraObject (Fove_Headset *, int cameraId, const Fove_ObjectPose *pose) |
| Update the pose of a registered camera. More... | |
| Fove_ErrorCode | fove_Headset_updateGazableObject (Fove_Headset *, int objectId, const Fove_ObjectPose *pose) |
| Update a previously registered 3D object pose. More... | |
| Fove_ErrorCode | fove_Headset_waitForProcessedEyeFrame (Fove_Headset *) |
| Waits for next eye camera frame to be processed. More... | |
| Fove_ErrorCode | fove_logText (Fove_LogLevel level, const char *utf8Text) |
| Writes some text to the FOVE log. More... | |
| template<typename T > | |
| Result< T > | Fove::getConfigValue (const std::string &key) |
| template<> | |
| Result< std::string > | Fove::getConfigValue (const std::string &key) |
| bool | Fove::isValid (const ErrorCode err) |
| Helper function to determine which errors can coexist with values. | |
| Result | Fove::logText (const LogLevel level, const std::string &utf8Text) |
| Wraps fove_logText() | |
| template<> | |
| Result | Fove::setConfigValue (const std::string &key, const std::string &value) |
| template<typename T > | |
| Result | Fove::setConfigValue (const std::string &key, const T &value) |
Variables | |
| const int | fove_ObjectIdInvalid = -1 |
| Predefined object ID to signify "no object". | |
This file contains the entire FOVE API, no other headers are needed.
| #define FOVE_CXX_NAMESPACE Fove |
Since the C++ API is header-only, the functions in it do not need to be in any particular namespace.
By default, everything is put in the Fove namespace, but this can be customized if the user prefers.
| #define FOVE_DEFINE_CXX_API 0 |
Macro that controls whether the C++ API will be defined.
The C API is always defined after including this header, but the C++ API is optional. In C++ mode, the C API is extended (for example, with default values for struct members) automatically.
User can set this macro to 0 or 1, either in code before including this, or via compile-flag to choose.
Defaults to 0 if the compiler is a C compiler, 1 if the compiler is a C++ compiler.
| #define FOVE_EXCEPTIONS 1 |
Exceptions are enabled by default in the C++ API, because they are a core C++ feature. However, they are only used in specific functions, not everywhere. If you are working in a code base that bans exceptions, define FOVE_EXCEPTIONS to zero. Exceptions are automatically disabled for the unreal engine.
|
strong |
|
strong |
Indicate the calibration method to use.
|
strong |
Indicate the state of a calibration process.
A calibration process always starts from the NotStarted state, then it goes to the HeadsetAdjustment step if improving the position of the HMD is necessary, then it can go back and forth between the WaitingForUser & CollectingData states, then it goes to the ProcessingData state and finishes with the Successful state.
A failure can happen any time during the process, and stops the process where it was.
From the ProcessingData state the calibration process do not require any rendering and gameplay can be started if wanted but new calibration won't be effective before reaching the Successful state.
|
strong |
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 API_NotRegistered will be returned. After a new capability registration the Data_NoUpdate error may be returned for a few frames while the service is bootstrapping the new capability.
This enum is designed to be used as a flag set, so items may be binary logic operators like |.
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.
|
strong |
|
strong |
|
strong |
The error codes that the Fove system may return.
|
strong |
|
strong |
|
strong |
|
strong |
Indicate whether eye torsion calibration should be run or not.
|
strong |
|
strong |
| Fove_ErrorCode fove_Compositor_createLayer | ( | Fove_Compositor * | , |
| const Fove_CompositorLayerCreateInfo * | layerInfo, | ||
| Fove_CompositorLayer * | outLayer | ||
| ) |
Creates a new layer within the compositor.
This function create a layer upon which frames may be submitted to the compositor by this client.
A connection to the compositor must exist for this to pass. This means you need to wait for fove_Compositor_isReady before calling this function. However, if connection to the compositor is lost and regained, this layer will persist. For this reason, you should not recreate your layers upon reconnection, simply create them once.
There is no way to delete a layer once created, other than to destroy the Fove_Compositor object. This is a feature we would like to add in the future.
| layerInfo | The settings for the layer to be created |
| outLayer | A struct where the defaults of the newly created layer will be written |
| Fove_ErrorCode fove_Compositor_destroy | ( | Fove_Compositor * | ) |
Frees resources used by the compositor object, including memory and sockets.
Upon return, this compositor pointer should no longer be used.
| Fove_ErrorCode fove_Compositor_getMirrorTexture | ( | Fove_Compositor * | , |
| Fove_CompositorTexture * | outTexture, | ||
| int * | outWidth, | ||
| int * | outHeight | ||
| ) |
Fetches the GPU-side mirror texture for the compositor.
This texture is updated by the compositor each frame and is intended to be used for mirroring the HMD display to the PC screen. It contains the left and right side in one texture, and should be called every frame.
You must invoke fove_Compositor_submit() once and wait a frame before this can function. This is required to attach to your graphics content and setup resources. You must also pass the correct type for outTexture, based on the API passed to the submit function.
| outTexture | A pointer to the texture to write the mirror texture to |
| outWidth | The width of the mirror texture |
| outHeight | The height of the mirror texture |
| Fove_ErrorCode fove_Compositor_queryAdapterId | ( | Fove_Compositor * | , |
| Fove_AdapterId * | outAdapterId | ||
| ) |
Returns the ID of the GPU currently attached to the headset.
For systems with multiple GPUs, submitted textures to the compositor must from the same GPU that the compositor is using
A connection to the compositor must exist for this to pass. This means you need to wait for fove_Compositor_isReady before calling this function.
| Fove_ErrorCode fove_Compositor_submit | ( | Fove_Compositor * | , |
| const Fove_CompositorLayerSubmitInfo * | submitInfo, | ||
| size_t | layerCount | ||
| ) |
Submit a frame to the compositor.
This function takes the feed from your game engine to the compositor for output.
Before submitting frames to the compositor you need to create render layers using the fove_Compositor_createLayer function. The fove_Compositor_createLayer function returns an unique layer id for each layer created. Referencing these ids in submitInfo you can specify which layer to submit a frame to
A connection to the compositor must have been established for this to pass. If the connection hasn't completed yet, fove_ErrorCode_Compositor_DisconnectedFromRuntime is returned. In this case you should retry calling this function periodically until it succeeds.
In case of disconnection or crash of the compositor, the created layers persist. For this reason, you don't need to recreate the layers when it happens. Just keep submitting until the compositor restarts and connection is recovered.
| submitInfo | An array of layerCount Fove_CompositorLayerSubmitInfo structs, each of which provides texture data for a unique layer |
| layerCount | The number of layers you are submitting |
| Fove_ErrorCode fove_Compositor_waitForRenderPose | ( | Fove_Compositor * | , |
| Fove_Pose * | outPose | ||
| ) |
Wait for the next pose to use for rendering purposes.
All compositor clients should use this function as the sole means of limiting their frame rate. This allows the client to render at the correct frame rate for the HMD display and with the most adequate HMD pose. Upon this function returning, the client should proceed directly to rendering, to reduce the chance of missing the frame.
If outPose is not null, this function returns the pose that should be use to render the current frame. If outPose is null, fove_Compositor_getLastRenderPose will return the same pose as the last call, or oherwise a default pose if never called with non-null. This pose can also be get later using the fove_Compositor_getLastRenderPose function.
In general, a client's main loop should look like: { Update(); // Run AI, physics, etc, for the next frame compositor.WaitForRenderPose(&pose); // Wait for the next frame, and get the pose Draw(pose); // Render the scene using the new pose }
| outPose | The latest pose of the headset. |
| Fove_ErrorCode fove_Config_clearValue | ( | const char * | key | ) |
Reset the value of the provided key to its default value.
| key | The key name of the value to reset, null-terminated and in UTF-8 |
| Fove_ErrorCode fove_Config_getValue_bool | ( | const char * | key, |
| bool * | outValue | ||
| ) |
Get the value of the provided key from the FOVE config.
| key | The key name of the value to retrieve, null-terminated and in UTF-8 |
| outValue | The value associated to the key if found. |
| Fove_ErrorCode fove_Config_getValue_float | ( | const char * | key, |
| float * | outValue | ||
| ) |
Get the value of the provided key from the FOVE config.
| key | The key name of the value to retrieve, null-terminated and in UTF-8 |
| outValue | The value associated to the key if found. |
| Fove_ErrorCode fove_Config_getValue_int | ( | const char * | key, |
| int * | outValue | ||
| ) |
Get the value of the provided key from the FOVE config.
| key | The key name of the value to retrieve, null-terminated and in UTF-8 |
| outValue | The value associated to the key if found. |
| Fove_ErrorCode fove_Config_getValue_string | ( | const char * | key, |
| void(*)(const char *value, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Get the value of the provided key from the FOVE config.
| key | The key name of the value to retrieve, null-terminated and in UTF-8 |
| callback | A function pointer to a function that will be called once if the key is present |
| callbackData | An arbitrary pointer passed to the callback |
| Fove_ErrorCode fove_Config_setValue_bool | ( | const char * | key, |
| bool | value | ||
| ) |
Set the value of the provided key to the FOVE config.
| key | The key name of the value to set, null-terminated and in UTF-8 |
| value | The new value to set as the key value. |
| Fove_ErrorCode fove_Config_setValue_float | ( | const char * | key, |
| float | value | ||
| ) |
Set the value of the provided key to the FOVE config.
| key | The key name of the value to set, null-terminated and in UTF-8 |
| value | The new value to set as the key value. |
| Fove_ErrorCode fove_Config_setValue_int | ( | const char * | key, |
| int | value | ||
| ) |
Set the value of the provided key to the FOVE config.
| key | The key name of the value to set, null-terminated and in UTF-8 |
| value | The new value to set as the key value. |
| Fove_ErrorCode fove_Config_setValue_string | ( | const char * | key, |
| const char * | value | ||
| ) |
Set the value of the provided key to the FOVE config.
| key | The key name of the value to set, null-terminated and in UTF-8 |
| value | The new value to set as the key value. |
| Fove_ErrorCode fove_createHeadset | ( | Fove_ClientCapabilities | capabilities, |
| Fove_Headset ** | outHeadset | ||
| ) |
Creates and returns an Fove_Headset object, which is the entry point to the entire API.
The result headset should be destroyed using fove_Headset_destroy when no longer needed.
| capabilities | The desired capabilities (Gaze, Orientation, Position), for multiple capabilities, use bitwise-or input such as Fove_ClientCapabilities::Gaze | Fove_ClientCapabilities::Position |
| outHeadset | A pointer where the address of the newly created headset will be written upon success |
| Fove_ErrorCode fove_Headset_activateLicense | ( | Fove_Headset * | , |
| const char * | licenseKey | ||
| ) |
Activates a license.
A license must be activated before using most features of the FOVE system.
Since FOVE provides default means (GUI/CLI) to activate licenses, this is not strictly required for most applications.
However, this function provides a programmatic means for the application to handle license key entry itself. An application may fully script license activation, so that the end user doesn't need to enter anything, or the application may display a prompt the user in it's own GUI to enter a license key, depending on the use case.
Once a license is activated it is persisted to disk, so this does not need to be called repeatedly.
If there is an existing license, it will be deactivated automatically. Currently only one license at a time is supported, but this may change in the future.
If the license has a PC limit, this will take one slot within that limit.
Because this makes a remote server call, this function will sometimes block a little while. It is not recommended to call this from your GUI thread, or other realtime threads.
Activating a license multiple times from the same machine is a no-op, and will return Fove_ErrorCode_API_AlreadyInTheDesiredState.
| licenseKey | Full text of the license key to be activated |
| Fove_ErrorCode fove_Headset_checkSoftwareVersions | ( | Fove_Headset * | ) |
Checks whether the client can run against the installed version of the FOVE SDK.
This makes a blocking call to the runtime.
| Fove_ErrorCode fove_Headset_createCompositor | ( | Fove_Headset * | , |
| Fove_Compositor ** | outCompositor | ||
| ) |
Returns a compositor interface from the given headset.
Each call to this function creates a new object. The object should be destroyed with fove_Compositor_destroy It is fine to call this function multiple times with the same headset, the same pointer will be returned. It is ok for the compositor to outlive the headset passed in.
| Fove_ErrorCode fove_Headset_createProfile | ( | Fove_Headset * | , |
| const char * | newName | ||
| ) |
Creates a new profile.
The FOVE system keeps a set of profiles so that different users on the same system can store data, such as calibrations, separately. Profiles persist to disk and survive restart. Third party applications can control the profile system and store data within it.
This function creates a new profile, but does not add any data or switch to it.
| newName | Null-terminated UTF-8 unique name of the profile to create |
| Fove_ErrorCode fove_Headset_deactivateLicense | ( | Fove_Headset * | , |
| const char * | licenseData | ||
| ) |
Deactivates a previously activated license.
Due to caching, features of the license may become unavailable shortly after this call, not necessarily immediately.
If the license has a PC limit, this PC will no longer count against it.
Because this makes a remote server call, this function will sometimes block a little while. It is not recommended to call this from your GUI thread, or other realtime threads.
| licenseData | A GUID of license to be deactivated, or the full text of a license key to be deactivated, or an empty string if all licenses need to be deactivated. |
| Fove_ErrorCode fove_Headset_deleteProfile | ( | Fove_Headset * | , |
| const char * | profileName | ||
| ) |
Deletes an existing profile.
This function deletes an existing profile.
If the deleted profile is the current profile, then no current profile is set after this returns. In such a case, it is undefined whether any existing profile data loaded into memory may be kept around.
| profileName | Null-terminated UTF-8 name of the profile to be deleted |
| Fove_ErrorCode fove_Headset_destroy | ( | Fove_Headset * | ) |
Frees resources used by a headset object, including memory and sockets.
Upon return, this headset pointer should no longer be used.
| Fove_ErrorCode fove_Headset_fetchEyesImage | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Fetch the latest eyes camera image from the runtime service.
This function updates a local cache of eyes image, that can be retrieved through fove_Headset_getEyesImage.
A cache is used to ensure that multiple calls to fove_Headset_getEyesImage return exactly the same data until we request an explicit data update through the next fetch call.
This function never blocks the thread. If no new data is available, no operation is performed. The timestamp can be used to know if the data has been updated or not.
Usually, you want to call this function in conjunction with fove_Headset_fetchEyeTrackingData either at the beginning of your update loop of just after fove_Headset_waitForProcessedEyeFrame depending on your thread synchronization.
Eyes image capability should be enabled by registering Fove_ClientCapabilities_EyesImage before calling this function.
| outTimestamp | A pointer to write the frame timestamp of fetched data. If null, the timestamp is not written. |
| Fove_ErrorCode fove_Headset_fetchEyeTrackingData | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Fetch the latest eye tracking data from the runtime service.
This function updates a local cache of eye tracking data, which other getters will fetch from.
A cache is used as a means to ensure that multiple getters can be called without a frame update in between. Everything in the cache is from the same frame, thus you can make sequential queries for data, and you will get data from the same frame as long as you do not refetch in between.
This function never blocks the thread. If no new data is available, no operation is performed. The timestamp can be used to know if the data has been updated or not.
Usually, you want to call this function at the beginning of your update loop if your thread is synchronized with the HMD display. On the other hand, if your thread is synchronized with the eye tracker thread, you usually want to call it just after fove_Headset_waitForProcessedEyeFrame.
Eye tracking should be enabled by registering the Fove_ClientCapabilities_EyeTracking before calling this function.
| outTimestamp | A pointer to write the frame timestamp of fetched data. If null, the timestamp is not written. |
| Fove_ErrorCode fove_Headset_fetchPoseData | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Fetch the latest pose data, and cache it locally.
This function caches the headset pose for later retrieval by fove_Headset_getPose.
This function never blocks the thread. If no new data is available, no operation is performed. The timestamp can be used to know if the data has been updated or not.
The HMD pose is updated at much higher frame rate than the eye tracking data and there is no equivalent to fove_Headset_waitForProcessedEyeFrame for the pose. For rendering purposes you should use the pose returned by fove_Compositor_waitForRenderPose which provides the best render pose estimate for the current frame. For other purposes, just fetch the HMD pose once at the beginning of your update loop. This will ensure consistent data throughout all your update loop code.
| outTimestamp | A pointer to write the frame timestamp of fetched data. If null, the timestamp is not written. |
| Fove_ErrorCode fove_Headset_fetchPositionImage | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Fetch the latest position camera image, and cache it locally.
This function caches the position camera image for later retrieval by fove_Headset_getPositionImage.
This function never blocks the thread. If no new data is available, no operation is performed. The timestamp can be used to know if the data has been updated or not.
There is no equivalent to fove_Headset_waitForProcessedEyeFrame for the position image that allow you to synchronize with the position image update. We recommend you to fetch the position image only once every beginning of update loop if needed to ensure consistent data throughout the update loop code.
| outTimestamp | A pointer to the timestamp of fetched data. If null, the timestamp is not written. |
| Fove_ErrorCode fove_Headset_getCombinedGazeDepth | ( | Fove_Headset * | , |
| float * | outDepth | ||
| ) |
Writes out eyes gaze depth resulting from the two eye gazes combined together.
Fove_ClientCapabilities_GazeDepth should be registered to use this function.
| outDepth | A pointer to the gaze depth variable to write to |
outDepth is nullptr 
| Fove_ErrorCode fove_Headset_getCombinedGazeRay | ( | Fove_Headset * | , |
| Fove_Ray * | outRay | ||
| ) |
Writes out eyes gaze ray resulting from the two eye gazes combined together.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
To get individual eye rays use fove_Headset_getGazeVector instead
| outRay | A pointer to the gaze ray struct to write to |
outRay is nullptr 
| Fove_ErrorCode fove_Headset_getEyeballRadius | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| float * | outRadius | ||
| ) |
Returns the user eyeballs radius, in meters.
Fove_ClientCapabilities_EyeballRadius should be registered to use this function.
| eye | Specify which eye to get the value for |
| outRadius | A pointer to the output variable to write the user eyeball radius to. |
outRadius is nullptr 
| Fove_ErrorCode fove_Headset_getEyeBlinkCount | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| int * | outBlinkCount | ||
| ) |
Writes out the number of blink performed for the given eye since the eye tracking service started.
To count the number blinks performed during a given period of time call this function at the beginning and at the end of the period and make the subtraction of the two values.
Fove_ClientCapabilities_EyeBlink should be registered to use this function.
| eye | Specify which eye to get the value for |
| outBlinkCount | A pointer to the output variable to write the blink count to |
outIsBlinking is nullptr 
| Fove_ErrorCode fove_Headset_getEyeShape | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_EyeShape * | outShape | ||
| ) |
Returns the outline shape of the specified user eye in the Eyes camera image.
Fove_ClientCapabilities_EyeShape should be registered to use this function.
| eye | Specify which eye to get the value for |
| outShape | A pointer to the EyeShape struct to write eye shape to |
outShape is nullptr
| Fove_ErrorCode fove_Headset_getEyesImage | ( | Fove_Headset * | , |
| Fove_BitmapImage * | outImage | ||
| ) |
Returns the eyes camera image.
Returns the most recent eye tracking camera image cached in the last call to fove_Headset_fetchEyeTrackingData.
The image data buffer is invalidated upon the next call to fove_Headset_fetchEyeTrackingData.
Fove_ClientCapabilities_EyesImage should be registered to use this function.
| outImage | the raw image data buffer to write the eyes image data to. |
outImage is nullptr 
| Fove_ErrorCode fove_Headset_getEyesImageTimestamp | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Writes out the eye frame timestamp of the cached eyes image.
Basically returns the timestamp returned by the last call to fove_Headset_fetchEyesImage.
Fove_ClientCapabilities_EyesImage should be registered to use this function.
| outTimestamp | A pointer to write the frame timestamp of the currently cached data. |
| Fove_ErrorCode fove_Headset_getEyeState | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_EyeState * | outState | ||
| ) |
Writes out the state of an individual eye.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| eye | Specify which eye to get the value for |
| outState | A pointer to the output variable to write the eye state to |
outState is nullptr 
| Fove_ErrorCode fove_Headset_getEyeToHeadMatrices | ( | Fove_Headset * | , |
| Fove_Matrix44 * | outLeft, | ||
| Fove_Matrix44 * | outRight | ||
| ) |
Writes out the matrices to convert from eye to head space coordinates.
This is simply a translation matrix that returns +/- IOD/2
| outLeft | A pointer to the matrix where left-eye transform data will be written |
| outRight | A pointer to the matrix where right-eye transform data will be written |
outLeft and outRight are nullptr 
| Fove_ErrorCode fove_Headset_getEyeTorsion | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| float * | outAngle | ||
| ) |
Returns the user eye torsion, in degrees.
Fove_ClientCapabilities_EyeTorsion should be registered to use this function.
| eye | Specify which eye to get the value for |
| outAngle | A pointer to the output variable to write the user eye torsion to. |
outAngle is nullptr
| Fove_ErrorCode fove_Headset_getEyeTrackingCalibrationStateDetails | ( | Fove_Headset * | , |
| void(*)(const Fove_CalibrationData *detailsData, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Get the detailed information about the state of the currently running calibration process.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
When the calibration process is not running, this returns the final state of the previously run calibration process. Value is undefined if no calibration process has begun since the service was started.
| callback | A function pointer to a function that will be called up if successful |
| callbackData | An arbitrary user pointer to pass to the callback |
callback is nullptr 
| Fove_ErrorCode fove_Headset_getEyeTrackingDataTimestamp | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Writes out the eye frame timestamp of the cached eye tracking data.
Basically returns the timestamp returned by the last call to fove_Headset_fetchEyeTrackingData.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outTimestamp | A pointer to write the frame timestamp of the currently cached data. |
| Fove_ErrorCode fove_Headset_getGazedObjectId | ( | Fove_Headset * | , |
| int *const | outObjectId | ||
| ) |
Get the id of the object gazed by the user.
In order to be detected an object first need to be registered using the fove_Headset_registerGazableObject function. If the user is currently not looking at any specific object the fove_ObjectIdInvalid value is returned. To use this function, you need to register the Fove_ClientCapabilities_GazedObjectDetection first.
This function returns data cached in the last call to fove_Headset_fetchEyeTrackingData().
| outObjectId | A pointer to the output id identifying the object the user is currently looking at |
outObjectId is nullptr
| Fove_ErrorCode fove_Headset_getGazeScreenPosition | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_Vec2 * | outPos | ||
| ) |
Writes out the user's 2D gaze position on the screens seen through the HMD's lenses.
The use of lenses and distortion correction creates a screen in front of each eye. This function returns 2D vectors representing where on each eye's screen the user is looking. The vectors are normalized in the range [-1, 1] along both X and Y axes such that the following points are true:
Center: (0, 0) Bottom-Left: (-1, -1) Top-Right: (1, 1)
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| eye | Specify which eye to get the value for |
| outPos | A pointer to the eye gaze point in the HMD's virtual screen space |
nullptr 
| Fove_ErrorCode fove_Headset_getGazeScreenPositionCombined | ( | Fove_Headset * | , |
| Fove_Vec2 * | outPos | ||
| ) |
Writes out the user's 2D gaze position.
This is a 2D equivalent of fove_Headset_getCombinedGazeRay, and is perhaps the simplest gaze estimation function.
It returns an X/Y coordinate of where on the screen the user is looking.
While in reality each eye is looking in a different direction at a different [portion of the] screen, they mostly agree, and this function returns effectively an average to get you a simple X/Y value.
Center: (0, 0) Bottom-Left: (-1, -1) Top-Right: (1, 1)
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outPos | A pointer to the eye gaze point in the HMD's virtual screen space |
nullptr 
| Fove_ErrorCode fove_Headset_getGazeVector | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_Vec3 * | outVector | ||
| ) |
Writes out the gaze vector of an individual eye.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| eye | Specify which eye to get the value for |
| outVector | A pointer to the eye gaze vector to write to |
| Fove_ErrorCode fove_Headset_getGazeVectorRaw | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_Vec3 * | outVector | ||
| ) |
Writes out the raw gaze vector of an individual eye.
Returns the rawest gaze vector that the eye tracker provides.
An eye tracker is, at it's core, a complex data processing algorithm, so there is no truly "raw" vector. However, any final smoothing is removed to give the most raw data possible.
fove_Headset_getGazeVector is recommended for UI control, drawing gaze cursors on screen, and the like. fove_Headset_getGazeVectorRaw is recommended for raw data collection for later data analysis.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| eye | Specify which eye to get the value for |
| outVector | A pointer to the raw eye gaze vector to write to |
| Fove_ErrorCode fove_Headset_getIrisRadius | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| float * | outRadius | ||
| ) |
Returns the user iris radius, in meters.
Fove_ClientCapabilities_IrisRadius should be registered to use this function.
| eye | Specify which eye to get the value for |
| outRadius | A pointer to the output variable to write the user iris radius to. |
outRadius is nullptr 
| Fove_ErrorCode fove_Headset_getPose | ( | Fove_Headset * | , |
| Fove_Pose * | outPose | ||
| ) |
Writes out the pose of the head-mounted display.
| outPose | A pointer to the variable to be written |
outPose is nullptr 
| Fove_ErrorCode fove_Headset_getPoseDataTimestamp | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Writes out the frame timestamp of the cached pose data.
Basically returns the timestamp returned by the last call to fove_Headset_fetchPoseData.
| outTimestamp | A pointer to write the frame timestamp of the currently cached data. |
| Fove_ErrorCode fove_Headset_getPositionImage | ( | Fove_Headset * | , |
| Fove_BitmapImage * | outImage | ||
| ) |
Returns the position camera image.
Returns the most recent position tracking image cached in the last call to fove_Headset_fetchPoseData.
The image data buffer is invalidated upon the next call to fove_Headset_fetchPoseData.
Fove_ClientCapabilities_PositionImage should be registered to use this function.
| outImage | the raw image data buffer to write the position image data to. |
outImage is nullptr 
| Fove_ErrorCode fove_Headset_getPositionImageTimestamp | ( | Fove_Headset * | , |
| Fove_FrameTimestamp * | outTimestamp | ||
| ) |
Writes out the frame timestamp of the cached position image.
Basically returns the timestamp returned by the last call to fove_Headset_fetchPositionImage.
| outTimestamp | A pointer to write the frame timestamp of the currently cached data. |
| Fove_ErrorCode fove_Headset_getProjectionMatricesLH | ( | Fove_Headset * | , |
| float | zNear, | ||
| float | zFar, | ||
| Fove_Matrix44 * | outLeftMat, | ||
| Fove_Matrix44 * | outRightMat | ||
| ) |
Writes out the values of passed-in left-handed 4x4 projection matrices.
Writes 4x4 projection matrices for both eyes using near and far planes in a left-handed coordinate system. Either outLeftMat or outRightMat may be nullptr to only write the other matrix, however setting both to nullptr is considered invalid and will return Fove_ErrorCode::API_NullOutPointersOnly.
| zNear | The near plane in float, Range: from 0 to zFar |
| zFar | The far plane in float, Range: from zNear to infinity |
| outLeftMat | A pointer to the matrix you want written |
| outRightMat | A pointer to the matrix you want written |
outLeftMat and outRightMat are nullptr 
| Fove_ErrorCode fove_Headset_getProjectionMatricesRH | ( | Fove_Headset * | , |
| float | zNear, | ||
| float | zFar, | ||
| Fove_Matrix44 * | outLeftMat, | ||
| Fove_Matrix44 * | outRightMat | ||
| ) |
Writes out the values of passed-in right-handed 4x4 projection matrices.
Writes 4x4 projection matrices for both eyes using near and far planes in a right-handed coordinate system. Either outLeftMat or outRightMat may be nullptr to only write the other matrix, however setting both to nullptr is considered invalid and will return Fove_ErrorCode::API_NullOutPointersOnly.
| zNear | The near plane in float, Range: from 0 to zFar |
| zFar | The far plane in float, Range: from zNear to infinity |
| outLeftMat | A pointer to the matrix you want written |
| outRightMat | A pointer to the matrix you want written |
outLeftMat and outRightMat are nullptr 
| Fove_ErrorCode fove_Headset_getPupilRadius | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| float * | outRadius | ||
| ) |
Returns the user pupils radius, in meters.
Fove_ClientCapabilities_PupilRadius should be registered to use this function.
| eye | Specify which eye to get the value for |
| outRadius | A pointer to the output variable to write the user pupil radius to |
outRadius is nullptr 
| Fove_ErrorCode fove_Headset_getPupilShape | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| Fove_PupilShape * | outShape | ||
| ) |
Returns the pupil shape of the specified user eye in the Eyes camera image.
Fove_ClientCapabilities_PupilShape should be registered to use this function.
| eye | Specify which eye to get the value for |
| outShape | A pointer to the PupilShape struct to write pupil shape to |
outShape is nullptr
| Fove_ErrorCode fove_Headset_getRawProjectionValues | ( | Fove_Headset * | , |
| Fove_ProjectionParams * | outLeft, | ||
| Fove_ProjectionParams * | outRight | ||
| ) |
Writes out values for the view frustum of the specified eye at 1 unit away.
Writes out values for the view frustum of the specified eye at 1 unit away. Please multiply them by zNear to convert to your correct frustum near-plane. Either outLeft or outRight may be nullptr to only write the other struct, however setting both to nullptr is considered and error and the function will return Fove_ErrorCode::API_NullOutPointersOnly.
| outLeft | A pointer to the struct describing the left camera projection parameters |
| outRight | A pointer to the struct describing the right camera projection parameters |
outLeft and outRight are nullptr 
| Fove_ErrorCode fove_Headset_getRenderIOD | ( | Fove_Headset * | , |
| float * | outIOD | ||
| ) |
Interocular distance to use for rendering in meters.
This may or may not reflect the actual IOD of the user (see getUserIOD), but is the value used by the rendering system for the distance to split the left/right cameras for stereoscopic rendering. We recommend calling this each frame when doing stereoscopic rendering.
| outIOD | A pointer to the render IOD variable to write to |
outIOD is nullptr 
| Fove_ErrorCode fove_Headset_getUserIOD | ( | Fove_Headset * | , |
| float * | outIOD | ||
| ) |
Returns the user IOD (Inter Occular Distance), in meters.
Fove_ClientCapabilities_UserIOD should be registered to use this function.
| outIOD | A pointer to the output variable to write the user IOD to. |
outIOD is nullptr 
| Fove_ErrorCode fove_Headset_getUserIPD | ( | Fove_Headset * | , |
| float * | outIPD | ||
| ) |
Returns the user IPD (Inter Pupillary Distance), in meters.
Fove_ClientCapabilities_UserIPD should be registered to use this function.
| outIPD | A pointer to the output variable to write the user IPD to. |
outIPD is nullptr 
| Fove_ErrorCode fove_Headset_hasAccessToFeature | ( | Fove_Headset * | , |
| const char * | inFeatureName, | ||
| bool * | outHasAccess | ||
| ) |
Returns whether the Headset has access to the given feature.
If the provided feature name doesn't exist, then false and #Fove_ErrorCode_None are returned.
| inFeatureName | A null-terminated UTF-8 string with the name of the feature to query |
| outHasAccess | Output variable set to true if the headset can access the given feature |
| Fove_ErrorCode fove_Headset_hasHmdAdjustmentGuiTimeout | ( | Fove_Headset * | , |
| bool * | outTimeout | ||
| ) |
Writes out whether the GUI that asks the user to adjust their headset was hidden by timeout.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outTimeout | A pointer to the output variable to write the timeout status to |
outTimeout is nullptr 
| Fove_ErrorCode fove_Headset_isEyeBlinking | ( | Fove_Headset * | , |
| Fove_Eye | eye, | ||
| bool * | outIsBlinking | ||
| ) |
Writes out whether the user is currently performing a blink for the given eye.
Fove_ClientCapabilities_EyeBlink should be registered to use this function.
| eye | Specify which eye to get the value for |
| outIsBlinking | A pointer to the output variable to write the blinking state to |
outIsBlinking is nullptr 
| Fove_ErrorCode fove_Headset_isEyeTrackingCalibrated | ( | Fove_Headset * | , |
| bool * | outEyeTrackingCalibrated | ||
| ) |
Writes out whether eye tracking has been calibrated.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outEyeTrackingCalibrated | A pointer to the output variable to write the eye tracking calibrated status to |
outEyeTrackingCalibrated is nullptr 
| Fove_ErrorCode fove_Headset_isEyeTrackingCalibratedForGlasses | ( | Fove_Headset * | , |
| bool * | outGlasses | ||
| ) |
Writes out whether the eye tracking system is currently calibrated for glasses.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
This basically indicates if the user was wearing glasses during the calibration or not. This function returns 'Data_Uncalibrated' if the eye tracking system has not been calibrated yet
| outGlasses | A pointer to the variable to be written |
outGlasses is nullptr 
| Fove_ErrorCode fove_Headset_isEyeTrackingCalibrating | ( | Fove_Headset * | , |
| bool * | outEyeTrackingCalibrating | ||
| ) |
Writes out whether eye tracking is in the process of performing a calibration.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outEyeTrackingCalibrating | A pointer to the output variable to write the eye tracking calibrating status to |
outEyeTrackingCalibrating is nullptr 
| Fove_ErrorCode fove_Headset_isEyeTrackingEnabled | ( | Fove_Headset * | , |
| bool * | outEyeTrackingEnabled | ||
| ) |
Writes out whether the eye tracking hardware has started.
| outEyeTrackingEnabled | A pointer to the output variable to write the eye tracking status to |
outEyeTrackingEnabled is nullptr 
| Fove_ErrorCode fove_Headset_isEyeTrackingReady | ( | Fove_Headset * | , |
| bool * | outEyeTrackingReady | ||
| ) |
Writes out whether eye tracking is actively tracking eyes.
In other words, it returns true only when the hardware is ready and eye tracking is calibrated.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outEyeTrackingReady | A pointer to the output variable to write the eye tracking ready status to |
outEyeTrackingReady is nullptr 
| Fove_ErrorCode fove_Headset_isHardwareConnected | ( | Fove_Headset * | , |
| bool * | outHardwareConnected | ||
| ) |
Writes out whether an HMD is connected or not.
| outHardwareConnected | A pointer to the value to be written |
| Fove_ErrorCode fove_Headset_isHmdAdjustmentGuiVisible | ( | Fove_Headset * | , |
| bool * | outHmdAdjustmentGuiVisible | ||
| ) |
Writes out whether or not the GUI that asks the user to adjust their headset is being displayed.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
| outHmdAdjustmentGuiVisible | A pointer to the output variable to write the GUI visibility status to |
outHmdAdjustmentGuiVisible is nullptr 
| Fove_ErrorCode fove_Headset_isMotionReady | ( | Fove_Headset * | , |
| bool * | outMotionReady | ||
| ) |
Writes out whether motion tracking hardware has started.
| outMotionReady | A pointer to the variable to be written |
| Fove_ErrorCode fove_Headset_isPositionReady | ( | Fove_Headset * | , |
| bool * | outPositionReady | ||
| ) |
Writes out whether position tracking hardware has started and returns whether it was successful.
Fove_ClientCapabilities_PositionTracking should be registered to use this function.
| outPositionReady | A pointer to the variable to be written |
outPositionReady is nullptr 
| Fove_ErrorCode fove_Headset_isUserPresent | ( | Fove_Headset * | , |
| bool * | outUserPresent | ||
| ) |
Writes out whether the user is wearing the headset or not.
When user is not present Eye tracking values shouldn't be used, as invalid.
Fove_ClientCapabilities_UserPresence should be registered to use this function.
| outUserPresent | A pointer to the output variable to write the user presence status to |
outUserPresent is nullptr 
| Fove_ErrorCode fove_Headset_isUserShiftingAttention | ( | Fove_Headset * | , |
| bool * | outIsShiftingAttention | ||
| ) |
Writes out whether the user is shifting its attention between objects or looking at something specific (fixation or pursuit)
This can be used to ignore eye data during large eye motions when the user is not looking at anything specific.
Fove_ClientCapabilities_UserAttentionShift should be registered to use this function.
| outIsShiftingAttention | A pointer to a output variable to write the user attention shift status to |
outIsShiftingAttention is nullptr 
| Fove_ErrorCode fove_Headset_listProfiles | ( | Fove_Headset * | , |
| void(*)(const char *callbackProfileName, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Lists all existing profiles.
Invoking any other function on this headset from the callback will yield undefined behavior.
callbackProfileName is a non-null, null-terminated UTF-8 string containing the name of a profile.
| callback | A function pointer to a function that will be called once for each profile, in no particular order |
| callbackData | An arbitrary user pointer to pass to the callback |
| Fove_ErrorCode fove_Headset_queryCurrentProfile | ( | Fove_Headset * | , |
| void(*)(const char *callbackProfileName, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Gets the current profile.
The callback is not invoked if there is no current profile.
callbackProfileName is a non-null, null-terminated UTF-8 string with the name of the current profile.
Invoking any other function on this headset from the callback will yield undefined behavior.
| callback | A function pointer to a function that will be called up to onces if successful, or an empty string if no profile is set. |
| callbackData | An arbitrary user pointer to pass to the callback |
| Fove_ErrorCode fove_Headset_queryHardwareInfo | ( | Fove_Headset * | , |
| Fove_HeadsetHardwareInfo * | outHardwareInfo | ||
| ) |
Writes out the hardware information.
Allows you to get serial number, manufacturer, and model name of the headset.
| Fove_ErrorCode fove_Headset_queryLicenses | ( | Fove_Headset * | , |
| Fove_LicenseInfo * | outLicenseInfos, | ||
| size_t * | inOutArraySize | ||
| ) |
Returns information about any licenses currently activated.
There is the possibility of having more than one license, or none at all, so an array is provided.
This will only return valid, activated, licenses. As soon as a license expires or is otherwise deactivated, it will no longer be returned from this.
Usually you do not need to call this function directly. To check if a feature is available, simply use the feature, and see if you get a License_FeatureAccessDenied error.
| outLicenseInfos | An array of LicenseInfo objects to write info to. If null, nothing is written and only inOutArraySize is updated |
| inOutArraySize | On input, this is the size of the array of pointers, and on output is the number of elements written to the array |
| Fove_ErrorCode fove_Headset_queryProfileDataPath | ( | Fove_Headset * | , |
| const char * | profileName, | ||
| void(*)(const char *callbackProfileName, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Gets the data folder for a given profile.
Allows you to retrieve a filesytem directory where third party apps can write data associated with this profile. This directory will be created before return.
Since multiple applications may write stuff to a profile, please prefix any files you create with something unique to your application.
There are no special protections on profile data, and it may be accessible to any other app on the system. Do not write sensitive data here.
This is intended for simple uses. For advanced uses that have security concerns, or want to sync to a server, etc, third party applications are encouraged to use their own separate data store keyed by profile name. They will need to test for profile name changes and deletions manually in that case.
Invoking any other function on this headset from the callback will yield undefined behavior.
callbackProfileName is a non-null, null-terminated UTF-8 string with the path.
| callback | A function pointer to a function that will be called once if successful. Not invoked in the event of error |
| callbackData | An arbitrary user pointer to pass to the callback |
| profileName | A null-terminated UTF-8 string with the name of the profile to be queried, or an empty string if no profile is set |
| Fove_ErrorCode fove_Headset_querySoftwareVersions | ( | Fove_Headset * | , |
| Fove_Versions * | outSoftwareVersions | ||
| ) |
Writes out the current software versions.
Allows you to get detailed information about the client and runtime versions.
Instead of comparing software versions directly, you should simply call CheckSoftwareVersions to ensure that the client and runtime are compatible.
This makes a blocking call to the runtime.
| Fove_ErrorCode fove_Headset_registerCameraObject | ( | Fove_Headset * | , |
| const Fove_CameraObject * | camera | ||
| ) |
Registers an camera in the 3D world.
Registering 3D world objects and camera allows FOVE software to identify which objects are being gazed at. We recommend that clients opt-in to this functionality rather than doing it themselves, as our algorithm may improve over time. Clients of course may do their own detection if they have special needs, such as performance needs, or just want to use their own algorithm.
At least 1 camera needs to be registered for automatic object gaze recognition to work. Use the object group mask of the camera to specify which objects the camera is capturing. The camera view pose determine the gaze raycast direction and position. The camera view pose should include any and all offsets from position tracking. No transforms from the headset are added in automatically.
Connection to the service is not required for object registration, thus you can register your world objects at will and not worry about connection or reconnection status.
| camera | A description of the camera. Data is copied and no reference is kept to this memory after return. |
| Fove_ErrorCode fove_Headset_registerCapabilities | ( | Fove_Headset * | , |
| Fove_ClientCapabilities | caps | ||
| ) |
Registers capabilities needed by this client.
Usually you provide the required capabilities at the creation of the headset in fove_createHeadset. But you can add and remove capabilities anytime while the object is alive.
This is useful if you only have certain sections of your app that require extra capabilities. Fo example, if your app doesn't use eye tracking all the time, you can disable it temporarily to reduce CPU usage & power consumption.
Because this may enable software or hardware components, turn on cameras, etc, it may take up to a few seconds before the associated data is available. In the meantime, typically Fove_ErrorCode_Data_NoUpdate is returned from related data getters.
The service enables/disables software and hardware based on the needs of all connected clients, so it's possible that some other client already has the given capability registered, and thus the associated data may become available very quickly in these cases.
This function makes a request to the service and waits for response (with a small timeout). This means it will block the thread temporarily. However, the capability set is recorded locally, so even if the connection to the service fails, no error will be returned. Later, upon the next connection to the server, the capability set will be sent automatically.
It is completely safe to register capabilities while the service is down. No error will be returned.
| caps | A set of capabilities to register. Registering an existing capability is a no-op |
| Fove_ErrorCode fove_Headset_registerGazableObject | ( | Fove_Headset * | , |
| const Fove_GazableObject * | object | ||
| ) |
Registers an object in the 3D world.
Registering 3D world objects allows FOVE software to identify which objects are being gazed at. We recommend that clients opt-in to this functionality rather than doing it themselves, as our algorithm may improve over time. Clients of course may do their own detection if they have special needs, such as performance needs, or just want to use their own algorithm.
Use fove_Headset_registerCameraObject to set the pose of the corresponding camera in the 3D world.
Connection to the service is not required for object registration, thus you can register your world objects at will and not worry about connection or reconnection status.
| object | A description of the object in the 3D world. Data is copied and no reference is kept to this memory after return. |
| Fove_ErrorCode fove_Headset_removeCameraObject | ( | Fove_Headset * | , |
| int | cameraId | ||
| ) |
Removes a previously registered camera from the scene.
| cameraId | Id of the camera passed to fove_Headset_registerCameraObject() |
| Fove_ErrorCode fove_Headset_removeGazableObject | ( | Fove_Headset * | , |
| int | objectId | ||
| ) |
Removes a previously registered 3D object from the scene.
Because of the asynchronous nature of the FOVE system, this object may still be referenced in future frames for a very short period of time.
| objectId | Id of the object passed to fove_Headset_registerGazableObject() |
| Fove_ErrorCode fove_Headset_renameProfile | ( | Fove_Headset * | , |
| const char * | oldName, | ||
| const char * | newName | ||
| ) |
Renames an existing profile.
This function renames an existing profile. This works on the current profile as well.
| oldName | Null-terminated UTF-8 name of the profile to be renamed |
| newName | Null-terminated UTF-8 unique new name of the profile |
| Fove_ErrorCode fove_Headset_setCurrentProfile | ( | Fove_Headset * | , |
| const char * | profileName | ||
| ) |
Sets the current profile.
When changing profile, the FOVE system will load up data, such as calibration data, if it is available. If loading a profile with no calibration data, whether or not the FOVE system keeps old data loaded into memory is undefined.
Please note that no-ops are OK but you should check for #Fove_ErrorCode_Profile_NotAvailable.
| profileName | Name of the profile to make current, in UTF-8 |
| Fove_ErrorCode fove_Headset_startEyeTrackingCalibration | ( | Fove_Headset * | , |
| const Fove_CalibrationOptions * | options | ||
| ) |
Starts eye tracking calibration.
Fove_ClientCapabilities_EyeTracking should be registered to use this function
| options | The calibration options to use, or null to use default options |
| Fove_ErrorCode fove_Headset_startHmdAdjustmentProcess | ( | Fove_Headset * | , |
| bool | lazy | ||
| ) |
Start the HMD adjustment process. Doing this will display the HMD adjustment GUI.
Fove_ClientCapabilities_EyeTracking should be registered to use this function
| lazy | If true, the headset adjustment GUI doesn't show if the headset position is already perfect. |
| Fove_ErrorCode fove_Headset_tareOrientationSensor | ( | Fove_Headset * | ) |
Tares the orientation of the headset.
Any or both of Fove_ClientCapabilities_OrientationTracking and Fove_ClientCapabilities_PositionTracking should be registered to use this function.
| Fove_ErrorCode fove_Headset_tarePositionSensors | ( | Fove_Headset * | ) |
Tares the position of the headset.
Fove_ClientCapabilities_PositionTracking should be registered to use this function.
| Fove_ErrorCode fove_Headset_tickEyeTrackingCalibration | ( | Fove_Headset * | , |
| float | deltaTime, | ||
| bool | isVisible, | ||
| void(*)(const Fove_CalibrationData *calibrationData, void *callbackData) | callback, | ||
| void * | callbackData | ||
| ) |
Tick the current calibration process and retrieve data information to render the current calibration state.
| deltaTime | The time elapsed since the last rendered frame |
| isVisible | Indicate to the calibration system that something is being drawn to the screen. This allows the calibration renderer to take as much time as it wants to display success/failure messages and animate away before the calibration processes is marked as completed by the IsEyeTrackingCalibrating function. |
| callback | A function pointer to a function that will be called up if successful |
| callbackData | An arbitrary user pointer to pass to the callback |
This function is how the client declares to the calibration system that it is available to render calibration. The calibration system determines which of the available renderers has the highest priority, and returns to that renderer the information needed to render calibration via the outCalibrationData parameter. Even while ticking this, you may get no result because either no calibration is running, or a calibration is running but some other higher priority renderer is doing the rendering.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
Note that it is perfectly fine not to call this function, in which case the Fove service will automatically render the calibration process for you.
callback is nullptr 
| Fove_ErrorCode fove_Headset_tickHmdAdjustmentProcess | ( | Fove_Headset * | , |
| float | deltaTime, | ||
| bool | isVisible, | ||
| Fove_HmdAdjustmentData * | outData | ||
| ) |
Tick the current HMD adjustment process and retrieve data information to render the current HMD positioning state.
| deltaTime | The time elapsed since the last rendered frame |
| isVisible | Indicate to the FOVE system that GUI for HMD adjustment is being drawn to the screen. This allows the HMD adjustment renderer to take as much time as it wants to display fade-in/out or other animations before the HMD adjustment processes is marked as completed by the IsHmdAdjustmentGUIVisible function. |
| outData | The current HMD positioning information |
This function is how the client declares to the FOVE system that it is available to render the HMD adjustment process. The FOVE system determines which of the available renderers has the highest priority, and returns to that renderer the information needed to render HMD adjustment process via the outData parameter. Even while ticking this, you may get no result because either no HMD adjustment is running, or a HMD adjustment process is running but some other higher priority renderer is doing the rendering.
Fove_ClientCapabilities_EyeTracking should be registered to use this function.
Note that it is perfectly fine not to call this function, in which case the Fove service will automatically render the HMD adjustment process for you.
| Fove_ErrorCode fove_Headset_unregisterCapabilities | ( | Fove_Headset * | , |
| Fove_ClientCapabilities | caps | ||
| ) |
Unregisters capabilities previously registered by this client.
Removes capabilities previously added by fove_createHeadset or fove_Headset_registerCapabilities.
See fove_Headset_registerCapabilities for details on registration / unregistration.
| caps | A set of capabilities to unregister. Unregistering an not-existing capability is a no-op |
| Fove_ErrorCode fove_Headset_updateCameraObject | ( | Fove_Headset * | , |
| int | cameraId, | ||
| const Fove_ObjectPose * | pose | ||
| ) |
Update the pose of a registered camera.
| cameraId | Id of the camera passed to fove_Headset_registerCameraObject() |
| pose | the updated pose of the camera |
| Fove_ErrorCode fove_Headset_updateGazableObject | ( | Fove_Headset * | , |
| int | objectId, | ||
| const Fove_ObjectPose * | pose | ||
| ) |
Update a previously registered 3D object pose.
| objectId | Id of the object passed to fove_Headset_registerGazableObject() |
| pose | the updated pose of the object |
| Fove_ErrorCode fove_Headset_waitForProcessedEyeFrame | ( | Fove_Headset * | ) |
Waits for next eye camera frame to be processed.
Allows you to sync your eye tracking loop to the actual eye-camera loop. On each loop, you would first call this blocking function to wait for the next eye frame to be processed, then update the local cache of eye tracking data using the fetch functions, and finally get the desired eye tracking data using the getters.
Eye tracking should be enabled by registering the Fove_ClientCapabilities_EyeTracking before calling this function.
| Fove_ErrorCode fove_logText | ( | Fove_LogLevel | level, |
| const char * | utf8Text | ||
| ) |
Writes some text to the FOVE log.
| level | What severity level the log will use |
| utf8Text | Null-terminated text string in UTF-8 |
1.9.1