[−][src]Module oculussdk_sys::ovr_capi_vk
Re-exports
pub use self::ovrSuccessType_ as ovrSuccessType; |
pub use self::ovrSuccessTypes_ as ovrSuccessTypes; |
pub use self::ovrErrorType_ as ovrErrorType; |
pub use self::ovrHmdType_ as ovrHmdType; |
pub use self::ovrHmdCaps_ as ovrHmdCaps; |
pub use self::ovrTrackingCaps_ as ovrTrackingCaps; |
pub use self::ovrExtensions_ as ovrExtensions; |
pub use self::ovrEyeType_ as ovrEyeType; |
pub use self::ovrTrackingOrigin_ as ovrTrackingOrigin; |
pub use self::ovrStatusBits_ as ovrStatusBits; |
pub use self::ovrTrackerFlags_ as ovrTrackerFlags; |
pub use self::ovrTextureType_ as ovrTextureType; |
pub use self::ovrTextureBindFlags_ as ovrTextureBindFlags; |
pub use self::ovrTextureFormat_ as ovrTextureFormat; |
pub use self::ovrTextureMiscFlags_ as ovrTextureFlags; |
pub use self::ovrMirrorOptions_ as ovrMirrorOptions; |
pub use self::ovrFovStencilType_ as ovrFovStencilType; |
pub use self::ovrFovStencilFlags_ as ovrFovStencilFlags; |
pub use self::ovrButton_ as ovrButton; |
pub use self::ovrTouch_ as ovrTouch; |
pub use self::ovrControllerType_ as ovrControllerType; |
pub use self::ovrHapticsBufferSubmitMode_ as ovrHapticsBufferSubmitMode; |
pub use self::ovrTrackedDeviceType_ as ovrTrackedDeviceType; |
pub use self::ovrBoundaryType_ as ovrBoundaryType; |
pub use self::ovrHandType_ as ovrHandType; |
pub use self::ovrCameraStatusFlags_ as ovrCameraStatusFlags; |
pub use self::ovrInitFlags_ as ovrInitFlags; |
pub use self::ovrLogLevel_ as ovrLogLevel; |
pub use self::ovrLayerType_ as ovrLayerType; |
pub use self::ovrLayerFlags_ as ovrLayerFlags; |
pub use self::ovrTextureLayout_ as ovrTextureLayout; |
pub use self::ovrPerfHudMode_ as ovrPerfHudMode; |
pub use self::ovrLayerHudMode_ as ovrLayerHudMode; |
pub use self::ovrDebugHudStereoMode_ as ovrDebugHudStereoMode; |
pub use self::ovrProjectionModifier_ as ovrProjectionModifier; |
pub use self::ovrHapticsGenMode_ as ovrHapticsGenMode; |
Structs
VkDevice_T | |
VkImage_T | |
VkInstance_T | |
VkPhysicalDevice_T | |
VkQueue_T | |
_ovrTrackerPose | Specifies the pose for a single sensor. |
ovrAudioChannelData_ | Store audio PCM data (as 32b float samples) for an audio channel. Note: needs to be released with ovr_ReleaseAudioChannelData to avoid memory leak. |
ovrBoundaryLookAndFeel_ | Boundary system look and feel |
ovrBoundaryTestResult_ | Provides boundary test information |
ovrCameraExtrinsics_ | |
ovrCameraIntrinsics_ | |
ovrColorf_ | A RGBA color with normalized float components. |
ovrDetectResult_ | Return values for ovr_Detect. |
ovrErrorInfo_ | Provides information about the last error. \see ovr_GetLastErrorInfo |
ovrExtensionProperties_ | Describes the properties of an API extension. |
ovrExternalCamera_ | |
ovrEyeRenderDesc_ | Rendering information for each eye. Computed by ovr_GetRenderDesc() based on the specified FOV. Note that the rendering viewport is not included here as it can be specified separately and modified per frame by passing different Viewport values in the layer structure. |
ovrFovPort_ | Describes the up, down, left, and right angles of the field of view. |
ovrFovStencilDesc_ | Fov-stencil mesh descriptor passed into the function ovr_GetFovStencil \see ovr_GetFovStencil |
ovrFovStencilMeshBuffer_ | Contains the data for the fov-stencil mesh. Parts of the struct are filled by the caller while some parts are filled by the SDK. \see ovr_GetFovStencil |
ovrGraphicsLuid_ | Identifies a graphics device in a platform-specific way. For Windows this is a LUID type. |
ovrHapticsBuffer_ | Haptics buffer descriptor, contains amplitude samples used for Touch vibration |
ovrHapticsClip_ | Store a full Haptics clip, which can be used as data source for multiple ovrHapticsBuffers. |
ovrHapticsPlaybackState_ | State of the Haptics playback for Touch vibration |
ovrHmdDesc_ | This is a complete descriptor of the HMD. |
ovrHmdStruct | |
ovrInitParams_ | Parameters for ovr_Initialize. |
ovrInputState_ | ovrInputState describes the complete controller input state, including Oculus Touch, and XBox gamepad. If multiple inputs are connected and used at the same time, their inputs are combined. |
ovrLayerCube_ | Describes a layer of type ovrLayerType_Cube which is a single timewarped cubemap at infinity. When looking down the recentered origin's -Z axis, +X face is left and +Y face is up. Similarly, if headlocked the +X face is left, +Y face is up and -Z face is forward. Note that the coordinate system is left-handed. |
ovrLayerCylinder_ | Describes a layer of type ovrLayerType_Cylinder which is a single cylinder relative to the recentered origin. This type of layer represents a single object placed in the world and not a stereo view of the world itself. |
ovrLayerEyeFovDepth_ | Describes a layer that specifies a monoscopic or stereoscopic view, with depth textures in addition to color textures. This is typically used to support positional time warp. This struct is the same as ovrLayerEyeFov, but with the addition of DepthTexture and ProjectionDesc. |
ovrLayerEyeFovMultires_ | Describes a layer that specifies a monoscopic or stereoscopic view with support for optional multiresolution textures. This struct is the same as ovrLayerEyeFov plus texture layout parameters. |
ovrLayerEyeFov_ | Describes a layer that specifies a monoscopic or stereoscopic view. This is the kind of layer that's typically used as layer 0 to ovr_SubmitFrame, as it is the kind of layer used to render a 3D stereoscopic view. |
ovrLayerEyeMatrix_ | Describes a layer that specifies a monoscopic or stereoscopic view. This uses a direct 3x4 matrix to map from view space to the UV coordinates. It is essentially the same thing as ovrLayerEyeFov but using a much lower level. This is mainly to provide compatibility with specific apps. Unless the application really requires this flexibility, it is usually better to use ovrLayerEyeFov. |
ovrLayerHeader_ | |
ovrLayerQuad_ | Describes a layer of Quad type, which is a single quad in world or viewer space. It is used for ovrLayerType_Quad. This type of layer represents a single object placed in the world and not a stereo view of the world itself. |
ovrMatrix4f_ | A 4x4 matrix with float elements. |
ovrMirrorTextureData | |
ovrMirrorTextureDesc_ | Description used to create a mirror texture. |
ovrPerfStatsPerCompositorFrame_ | Contains the performance stats for a given SDK compositor frame |
ovrPerfStats_ | This is a complete descriptor of the performance stats provided by the SDK |
ovrPoseStatef_ | A full pose (rigid body) configuration with first and second derivatives. |
ovrPosef_ | Position and orientation together. The coordinate system used is right-handed Cartesian. |
ovrQuatf_ | A quaternion rotation. |
ovrRecti_ | A 2D rectangle with a position and size. All components are integers. |
ovrSessionStatus_ | Specifies status information for the current session. |
ovrSizei_ | A 2D size with integer components. |
ovrTextureLayoutOctilinear_ | Multiresolution descriptor for Octilinear. |
ovrTextureSwapChainData | |
ovrTextureSwapChainDesc_ | Description used to create a texture swap chain. |
ovrTimewarpProjectionDesc_ | Projection information for ovrLayerEyeFovDepth. |
ovrTouchHapticsDesc_ | Describes the Touch Haptics engine. Currently, those values will NOT change during a session. |
ovrTrackerDesc_ | Specifies the description of a single sensor. |
ovrTrackingState_ | Tracking state at a given absolute time (describes predicted HMD pose, etc.). Returned by ovr_GetTrackingState. |
ovrVector2i_ | A 2D vector with integer components. |
ovrVector2f_ | A 2D vector with float components. |
ovrVector3f_ | A 3D vector with float components. |
ovrVector4f_ | A 4D vector with float components. |
ovrViewScaleDesc_ | Contains the data necessary to properly calculate position info for various layer types. |
Constants
OVR_BUILD_NUMBER | |
OVR_DEBUG_HUD_STEREO_GUIDE_COLOR | |
OVR_DEBUG_HUD_STEREO_GUIDE_INFO_ENABLE | |
OVR_DEBUG_HUD_STEREO_GUIDE_POSITION | |
OVR_DEBUG_HUD_STEREO_GUIDE_SIZE | |
OVR_DEBUG_HUD_STEREO_GUIDE_YAWPITCHROLL | |
OVR_DEBUG_HUD_STEREO_MODE | |
OVR_DEFAULT_EYE_HEIGHT | |
OVR_DEFAULT_GENDER | |
OVR_DEFAULT_NECK_TO_EYE_HORIZONTAL | |
OVR_DEFAULT_NECK_TO_EYE_VERTICAL | |
OVR_DEFAULT_PLAYER_HEIGHT | |
OVR_DLL_COMPATIBLE_VERSION | |
OVR_EXTERNAL_CAMERA_NAME_SIZE | |
OVR_FEATURE_VERSION | |
OVR_FILE_DESCRIPTION_STRING | |
OVR_HAPTICS_BUFFER_SAMPLES_MAX | |
OVR_HMD_CONNECTED_EVENT_NAME | |
OVR_KEY_EYE_HEIGHT | |
OVR_KEY_EYE_TO_NOSE_DISTANCE | |
OVR_KEY_GENDER | |
OVR_KEY_NAME | |
OVR_KEY_NECK_TO_EYE_DISTANCE | |
OVR_KEY_PLAYER_HEIGHT | |
OVR_KEY_USER | |
OVR_LAYER_HUD_CURRENT_LAYER | |
OVR_LAYER_HUD_MODE | |
OVR_LAYER_HUD_SHOW_ALL_LAYERS | |
OVR_MAJOR_VERSION | |
OVR_MAX_EXTENSION_NAME_SIZE | |
OVR_MAX_EXTERNAL_CAMERA_COUNT | |
OVR_MINOR_VERSION | |
OVR_MIN_REQUESTABLE_MINOR_VERSION | |
OVR_PATCH_VERSION | |
OVR_PERF_HUD_MODE | |
OVR_PRODUCT_VERSION | |
OVR_PTR_SIZE | |
WCHAR_MAX | |
WCHAR_MIN | |
WINT_MAX | |
WINT_MIN | |
_CRT_PACKING | |
_HAS_EXCEPTIONS | |
_SAL_VERSION | |
_USE_ATTRIBUTES_FOR_SAL | |
_USE_DECLSPECS_FOR_SAL | |
__SAL_H_VERSION | |
ovrBoundaryType__ovrBoundary_Outer | Outer boundary - closely represents user setup walls |
ovrBoundaryType__ovrBoundary_PlayArea | Play area - safe rectangular area inside outer boundary which can optionally be used to restrict user interactions and motion. |
ovrButton__ovrButton_A | A button on XBox controllers and right Touch controller. Not present on Oculus Remote. |
ovrButton__ovrButton_B | B button on XBox controllers and right Touch controller. Not present on Oculus Remote. |
ovrButton__ovrButton_Back | Back on Xbox 360 controller and Oculus Remote. View button on XBox One controller. Not present on Touch controllers. |
ovrButton__ovrButton_Down | Down button on XBox controllers and Oculus Remote. Not present on Touch controllers. |
ovrButton__ovrButton_Enter | Start on XBox 360 controller. Menu on XBox One controller and Left Touch controller. Select button on Oculus Remote. Should be referred to as the Menu button in user-facing documentation. |
ovrButton__ovrButton_EnumSize | < \internal Force type int32_t. |
ovrButton__ovrButton_Home | Home button on XBox controllers. Oculus button on Touch controllers and Oculus Remote. |
ovrButton__ovrButton_LMask | Home button on XBox controllers. Oculus button on Touch controllers and Oculus Remote. |
ovrButton__ovrButton_LShoulder | Left shoulder button on XBox controllers. Not present on Touch controllers or Oculus Remote. |
ovrButton__ovrButton_LThumb | Left thumbstick on XBox controllers and Touch controllers. Not present on Oculus Remote. |
ovrButton__ovrButton_Left | Left button on XBox controllers and Oculus Remote. Not present on Touch controllers. |
ovrButton__ovrButton_Private | Home button on XBox controllers. Oculus button on Touch controllers and Oculus Remote. |
ovrButton__ovrButton_RMask | Home button on XBox controllers. Oculus button on Touch controllers and Oculus Remote. |
ovrButton__ovrButton_RShoulder | Right shoulder button on XBox controllers. Not present on Touch controllers or Oculus Remote. |
ovrButton__ovrButton_RThumb | Right thumbstick on XBox controllers and Touch controllers. Not present on Oculus Remote. |
ovrButton__ovrButton_Right | Right button on XBox controllers and Oculus Remote. Not present on Touch controllers. |
ovrButton__ovrButton_Up | Up button on XBox controllers and Oculus Remote. Not present on Touch controllers. |
ovrButton__ovrButton_VolDown | Volume button on Oculus Remote. Not present on XBox or Touch controllers. |
ovrButton__ovrButton_VolUp | Volume button on Oculus Remote. Not present on XBox or Touch controllers. |
ovrButton__ovrButton_X | X button on XBox controllers and left Touch controller. Not present on Oculus Remote. |
ovrButton__ovrButton_Y | Y button on XBox controllers and left Touch controller. Not present on Oculus Remote. |
ovrCameraStatusFlags__ovrCameraStatus_Calibrated | Bit set when the camera has tried & passed calibration |
ovrCameraStatusFlags__ovrCameraStatus_Calibrating | Bit set when the camera is undergoing calibration |
ovrCameraStatusFlags__ovrCameraStatus_CalibrationFailed | Bit set when the camera has tried & failed calibration |
ovrCameraStatusFlags__ovrCameraStatus_Capturing | Bit set when the camera is capturing |
ovrCameraStatusFlags__ovrCameraStatus_Connected | Bit set when the camera is connected to the system |
ovrCameraStatusFlags__ovrCameraStatus_EnumSize | < \internal Force type int32_t. |
ovrCameraStatusFlags__ovrCameraStatus_None | Initial state of camera |
ovrControllerType__ovrControllerType_Active | < Operate on or query whichever controller is active. |
ovrControllerType__ovrControllerType_EnumSize | < \internal Force type int32_t. |
ovrControllerType__ovrControllerType_LTouch | |
ovrControllerType__ovrControllerType_None | |
ovrControllerType__ovrControllerType_Object0 | |
ovrControllerType__ovrControllerType_Object1 | |
ovrControllerType__ovrControllerType_Object2 | |
ovrControllerType__ovrControllerType_Object3 | |
ovrControllerType__ovrControllerType_RTouch | |
ovrControllerType__ovrControllerType_Remote | |
ovrControllerType__ovrControllerType_Touch | |
ovrControllerType__ovrControllerType_XBox | |
ovrDebugHudStereoMode__ovrDebugHudStereo_Count | \internal Count of enumerated elements |
ovrDebugHudStereoMode__ovrDebugHudStereo_CrosshairAtInfinity | Renders screen-space crosshair at infinity for Stereo Debugging |
ovrDebugHudStereoMode__ovrDebugHudStereo_EnumSize | < \internal Force type int32_t |
ovrDebugHudStereoMode__ovrDebugHudStereo_Off | Turns off the Stereo Debug HUD. |
ovrDebugHudStereoMode__ovrDebugHudStereo_Quad | Renders Quad in world for Stereo Debugging. |
ovrDebugHudStereoMode__ovrDebugHudStereo_QuadWithCrosshair | Renders Quad+crosshair in world for Stereo Debugging |
ovrErrorType__ovrError_AccessDenied | The caller doesn't have permissions for the requested action. |
ovrErrorType__ovrError_ApplicationInvisible | Application declared itself as an invisible type and is not allowed to submit frames. |
ovrErrorType__ovrError_AudioComError | Generic COM error. |
ovrErrorType__ovrError_AudioDeviceNotFound | Failure to find the specified audio device. |
ovrErrorType__ovrError_BlacklistedGfxDriver | The graphics driver is black-listed. |
ovrErrorType__ovrError_ClientSkippedDestroy | The client failed to call ovr_Destroy on an active session before calling ovr_Shutdown. Or the client crashed. |
ovrErrorType__ovrError_ClientSkippedShutdown | The client failed to call ovr_Shutdown or the client crashed. |
ovrErrorType__ovrError_ClientVersion | Client version too old to connect to service |
ovrErrorType__ovrError_ContentProtectionNotAvailable | Content protection is not available for the display. |
ovrErrorType__ovrError_DeviceUnavailable | Specified device type isn't available. |
ovrErrorType__ovrError_DisabledOrDefaultAdapter | No supported VR display system found, but disabled or driverless adapter found. |
ovrErrorType__ovrError_Disallowed | The given request is disallowed under the current conditions. |
ovrErrorType__ovrError_DisplayInit | Unable to initialize the HMD display. |
ovrErrorType__ovrError_DisplayLimitReached | Returned in the event a virtual display system reaches a display limit |
ovrErrorType__ovrError_DisplayLost | In the event of a system-wide graphics reset or cable unplug this is returned to the app. |
ovrErrorType__ovrError_DisplayManagerInit | Initialization of the DisplayManager failed. |
ovrErrorType__ovrError_DisplayPluggedIncorrectly | Display portion of HMD is plugged into an incompatible port (ex: IGP) |
ovrErrorType__ovrError_DisplayRemoved | HMD removed from the display adapter |
ovrErrorType__ovrError_ExternalCameraCaptureFailed | There was a problem capturing external camera frames |
ovrErrorType__ovrError_ExternalCameraInitializedFailed | There was a problem initializing the external camera for capture |
ovrErrorType__ovrError_ExternalCameraNameListsBufferSize | The external camera friendly name list and the external camera name list are not the fixed size(OVR_MAX_EXTERNAL_CAMERA_NAME_BUFFER_SIZE). |
ovrErrorType__ovrError_ExternalCameraNameListsMistmatch | The external camera friendly name list is not the same size as the external camera name list. |
ovrErrorType__ovrError_ExternalCameraNameWrongSize | The external camera name is larger than OVR_EXTERNAL_CAMERA_NAME_SIZE-1 |
ovrErrorType__ovrError_ExternalCameraNotCalibrated | The external camera property has not been sent to OVRServer when the user tries to open the camera. |
ovrErrorType__ovrError_GraphicsDeviceReset | Graphics device has been reset (TDR, etc...) |
ovrErrorType__ovrError_HybridGraphicsNotSupported | The system is using hybrid graphics (Optimus, etc...), which is not support. |
ovrErrorType__ovrError_IncompatibleGPU | The graphics hardware is not supported |
ovrErrorType__ovrError_IncompatibleOS | The operating system version is incompatible. |
ovrErrorType__ovrError_Initialize | Generic initialization error. |
ovrErrorType__ovrError_InitializeVulkan | Vulkan initialization error. |
ovrErrorType__ovrError_InsufficientArraySize | |
ovrErrorType__ovrError_InvalidHeadsetOrientation | The headset was in an invalid orientation for the requested operation (e.g. vertically oriented during ovr_RecenterPose). |
ovrErrorType__ovrError_InvalidOperation | |
ovrErrorType__ovrError_InvalidParameter | Invalid parameter provided. See error info or log for details. |
ovrErrorType__ovrError_InvalidSession | Invalid ovrSession parameter provided. |
ovrErrorType__ovrError_LeakingResources | Calling application has leaked resources |
ovrErrorType__ovrError_LibLoad | Couldn't load LibOVRRT. |
ovrErrorType__ovrError_LibPath | LibOVRRT path failure. |
ovrErrorType__ovrError_LibSignCheck | LibOVRRT signature check failure. |
ovrErrorType__ovrError_LibSymbols | LibOVRRT symbol resolution failure. |
ovrErrorType__ovrError_LibVersion | LibOVRRT version incompatibility. |
ovrErrorType__ovrError_LostTracking | Tracking is lost when ovr_GetDevicePoses() is called. |
ovrErrorType__ovrError_MemoryAllocationFailure | Failure to allocate memory. |
ovrErrorType__ovrError_MisformattedBlock | Result of a bad calibration block due to lengths |
ovrErrorType__ovrError_MismatchedAdapters | Chosen rendering adapters between client and service do not match |
ovrErrorType__ovrError_NoCalibration | Result of a missing calibration block |
ovrErrorType__ovrError_NoExternalCameraInfo | There is not any external camera information stored by ovrServer. |
ovrErrorType__ovrError_NoHmd | The given HMD doesn't exist. |
ovrErrorType__ovrError_NoValidVRDisplaySystem | No valid VR display system found. |
ovrErrorType__ovrError_NotInitialized | The system or component has not been initialized. |
ovrErrorType__ovrError_Obsolete | Feature or API is obsolete and no longer supported. |
ovrErrorType__ovrError_OldVersion | Result of an old calibration block |
ovrErrorType__ovrError_OutOfDateGfxDriver | The graphics driver is out of date. |
ovrErrorType__ovrError_OutOfDateOS | The operating system is out of date. |
ovrErrorType__ovrError_Reinitialization | Attempting to re-initialize with a different version. |
ovrErrorType__ovrError_RemoteSession | Failed to connect to the service because remote connections to the service are not allowed. |
ovrErrorType__ovrError_RuntimeException | re-initialize it before this error state will be cleared. |
ovrErrorType__ovrError_ServerStart | Unable to start the server. Is it already running? |
ovrErrorType__ovrError_ServiceConnection | Couldn't connect to the OVR Service. |
ovrErrorType__ovrError_ServiceDeadlockDetected | |
ovrErrorType__ovrError_ServiceError | Generic service error. See error info or log for details. |
ovrErrorType__ovrError_ServiceVersion | OVR Service version incompatibility. |
ovrErrorType__ovrError_TextureSwapChainFull | ovr_CommitTextureSwapChain was called too many times on a texture swapchain without calling submit to use the chain. |
ovrErrorType__ovrError_TextureSwapChainInvalid | The ovrTextureSwapChain is in an incomplete or inconsistent state. Ensure ovr_CommitTextureSwapChain was called at least once first. |
ovrErrorType__ovrError_Timeout | The operation timed out. |
ovrErrorType__ovrError_TrackerDriverInit | Failed to get the interface for an attached tracker |
ovrErrorType__ovrError_Unsupported | Function call is not supported on this hardware/software |
ovrExtensions__ovrExtension_Count | < \internal Sanity checking |
ovrExtensions__ovrExtension_EnumSize | < \internal Force type int32_t. |
ovrExtensions__ovrExtension_TextureLayout_Octilinear | < Enable before first layer submission. |
ovrEyeType__ovrEye_Count | < \internal Count of enumerated elements. |
ovrEyeType__ovrEye_EnumSize | < \internal Force type int32_t. |
ovrEyeType__ovrEye_Left | < The left eye, from the viewer's perspective. |
ovrEyeType__ovrEye_Right | < The right eye, from the viewer's perspective. |
ovrFalse | |
ovrFovStencilFlags__ovrFovStencilFlag_EnumSize | < \internal Force type int32_t. |
ovrFovStencilFlags__ovrFovStencilFlag_MeshOriginAtBottomLeft | When used, flips the Y component of the provided 2D mesh coordinates, such that Y increases upwards. When not used, places mesh origin at top-left where Y increases downwards. |
ovrFovStencilType__ovrFovStencilType_EnumSize | < \internal Force type int32_t. |
ovrFovStencilType__ovrFovStencil_BorderLine | < Line list that draws the boundary visible to users |
ovrFovStencilType__ovrFovStencil_HiddenArea | < Triangle list covering parts that are hidden to users |
ovrFovStencilType__ovrFovStencil_VisibleArea | < Triangle list covering parts that are visible to users |
ovrFovStencilType__ovrFovStencil_VisibleRectangle | < Axis-aligned rectangle fit in visible region < 4x vertices: TopLeft, TopRight, BottomRight, BottomLeft |
ovrHandType__ovrHand_Count | |
ovrHandType__ovrHand_EnumSize | < \internal Force type int32_t. |
ovrHandType__ovrHand_Left | |
ovrHandType__ovrHand_Right | |
ovrHapticsBufferSubmitMode__ovrHapticsBufferSubmit_Enqueue | Enqueue buffer for later playback |
ovrHapticsGenMode__ovrHapticsGenMode_Count | Point sample original signal at Haptics frequency |
ovrHapticsGenMode__ovrHapticsGenMode_PointSample | Point sample original signal at Haptics frequency |
ovrHmdCaps__ovrHmdCap_DebugDevice | (read only) Specifies that the HMD is a virtual debug device. |
ovrHmdCaps__ovrHmdCap_EnumSize | < \internal Force type int32_t. |
ovrHmdType__ovrHmd_CB | |
ovrHmdType__ovrHmd_CV1 | |
ovrHmdType__ovrHmd_DK1 | |
ovrHmdType__ovrHmd_DK2 | |
ovrHmdType__ovrHmd_DKHD | |
ovrHmdType__ovrHmd_E3_2015 | |
ovrHmdType__ovrHmd_ES06 | |
ovrHmdType__ovrHmd_ES09 | |
ovrHmdType__ovrHmd_ES11 | |
ovrHmdType__ovrHmd_EnumSize | < \internal Force type int32_t. |
ovrHmdType__ovrHmd_None | |
ovrHmdType__ovrHmd_Other | |
ovrHmdType__ovrHmd_RiftS | |
ovrInitFlags__ovrInit_Debug | When a debug library is requested, a slower debugging version of the library will run which can be used to help solve problems in the library and debug application code. |
ovrInitFlags__ovrInit_EnumSize | < \internal Force type int32_t. |
ovrInitFlags__ovrInit_FocusAware | This client is aware of ovrSessionStatus focus states (e.g. ovrSessionStatus::HasInputFocus), and responds to them appropriately (e.g. pauses and stops drawing hands when lacking focus). |
ovrInitFlags__ovrInit_Invisible | This client will not be visible in the HMD. Typically set by diagnostic or debugging utilities. |
ovrInitFlags__ovrInit_MixedRendering | This client will alternate between VR and 2D rendering. Typically set by game engine editors and VR-enabled web browsers. |
ovrInitFlags__ovrInit_RequestVersion | When a version is requested, the LibOVR runtime respects the RequestedMinorVersion field and verifies that the RequestedMinorVersion is supported. Normally when you specify this flag you simply use OVR_MINOR_VERSION for ovrInitParams::RequestedMinorVersion, though you could use a lower version than OVR_MINOR_VERSION to specify previous version behavior. |
ovrInitFlags__ovrinit_WritableBits | These bits are writable by user code. |
ovrLayerFlags__ovrLayerFlag_HeadLocked | Mark this surface as "headlocked", which means it is specified relative to the HMD and moves with it, rather than being specified relative to sensor/torso space and remaining still while the head moves. What used to be ovrLayerType_QuadHeadLocked is now ovrLayerType_Quad plus this flag. However the flag can be applied to any layer type to achieve a similar effect. |
ovrLayerFlags__ovrLayerFlag_HighQuality | ovrLayerFlag_HighQuality enables 4x anisotropic sampling during the composition of the layer. The benefits are mostly visible at the periphery for high-frequency & high-contrast visuals. For best results consider combining this flag with an ovrTextureSwapChain that has mipmaps and instead of using arbitrary sized textures, prefer texture sizes that are powers-of-two. Actual rendered viewport and doesn't necessarily have to fill the whole texture. |
ovrLayerFlags__ovrLayerFlag_TextureOriginAtBottomLeft | ovrLayerFlag_TextureOriginAtBottomLeft: the opposite is TopLeft. Generally this is false for D3D, true for OpenGL. |
ovrLayerFlags__ovrLayerFlags_EnumSize | < \internal Force type int32_t. |
ovrLayerHudMode__ovrLayerHud_EnumSize | |
ovrLayerHudMode__ovrLayerHud_Info | < Shows info about a specific layer |
ovrLayerHudMode__ovrLayerHud_Off | < Turns off the layer HUD |
ovrLayerType__ovrLayerType_Cube | Described by ovrLayerCube |
ovrLayerType__ovrLayerType_Cylinder | Described by ovrLayerCylinder. |
ovrLayerType__ovrLayerType_Disabled | Layer is disabled. |
ovrLayerType__ovrLayerType_EnumSize | < Force type int32_t. |
ovrLayerType__ovrLayerType_EyeFov | Described by ovrLayerEyeFov. |
ovrLayerType__ovrLayerType_EyeFovDepth | Described by ovrLayerEyeFovDepth. |
ovrLayerType__ovrLayerType_EyeFovMultires | Described by ovrLayerEyeFovMultires. |
ovrLayerType__ovrLayerType_EyeMatrix | Described by ovrLayerEyeMatrix. |
ovrLayerType__ovrLayerType_Quad | Described by ovrLayerQuad. Previously called ovrLayerType_QuadInWorld. |
ovrLogLevel__ovrLogLevel_Debug | < Debug-level log event. |
ovrLogLevel__ovrLogLevel_EnumSize | < \internal Force type int32_t. |
ovrLogLevel__ovrLogLevel_Error | < Error-level log event. |
ovrLogLevel__ovrLogLevel_Info | < Info-level log event. |
ovrMaxLayerCount | |
ovrMaxProvidedFrameStats | |
ovrMirrorOptions__ovrMirrorOption_Default | By default the mirror texture will be: |
ovrMirrorOptions__ovrMirrorOption_EnumSize | < \internal Force type int32_t. |
ovrMirrorOptions__ovrMirrorOption_ForceSymmetricFov | Forces mirror output to use max symmetric FOV instead of asymmetric full FOV used by HMD. Only valid for rectilinear mirrors i.e. using ovrMirrorOption_PostDistortion with ovrMirrorOption_ForceSymmetricFov will result in ovrError_InvalidParameter error. |
ovrMirrorOptions__ovrMirrorOption_IncludeGuardian | Shows the boundary system aka Guardian on the mirror texture |
ovrMirrorOptions__ovrMirrorOption_IncludeNotifications | Shows system notifications the user receives on the mirror texture |
ovrMirrorOptions__ovrMirrorOption_IncludeSystemGui | Shows the system menu (triggered by hitting the Home button) on the mirror texture |
ovrMirrorOptions__ovrMirrorOption_LeftEyeOnly | Since ovrMirrorOption_Default renders both eyes into the mirror texture, these two flags are exclusive (i.e. cannot use them simultaneously) |
ovrMirrorOptions__ovrMirrorOption_PostDistortion | Retrieves the barrel distorted texture contents instead of the rectilinear one This is only recommended for debugging purposes, and not for final desktop presentation |
ovrMirrorOptions__ovrMirrorOption_RightEyeOnly | Since ovrMirrorOption_Default renders both eyes into the mirror texture, these two flags are exclusive (i.e. cannot use them simultaneously) |
ovrPerfHudMode__ovrPerfHud_AppRenderTiming | < Shows render timing info for application |
ovrPerfHudMode__ovrPerfHud_AswStats | < Shows Async Spacewarp-specific info |
ovrPerfHudMode__ovrPerfHud_CompRenderTiming | < Shows render timing info for OVR compositor |
ovrPerfHudMode__ovrPerfHud_Count | < \internal Count of enumerated elements. |
ovrPerfHudMode__ovrPerfHud_EnumSize | < \internal Force type int32_t. |
ovrPerfHudMode__ovrPerfHud_LatencyTiming | < Shows latency related timing info |
ovrPerfHudMode__ovrPerfHud_Off | < Turns off the performance HUD |
ovrPerfHudMode__ovrPerfHud_PerfSummary | < Shows performance summary and headroom |
ovrPerfHudMode__ovrPerfHud_VersionInfo | < Shows SDK & HMD version Info |
ovrProjectionModifier__ovrProjection_ClipRangeOpenGL | Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL. |
ovrProjectionModifier__ovrProjection_FarClipAtInfinity | When this flag is used, the zfar value pushed into ovrMatrix4f_Projection() will be ignored NOTE: Enable only if ovrProjection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity. |
ovrProjectionModifier__ovrProjection_FarLessThanNear | After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision. |
ovrProjectionModifier__ovrProjection_LeftHanded | Enable if using left-handed transformations in your application. |
ovrProjectionModifier__ovrProjection_None | Use for generating a default projection matrix that is: |
ovrStatusBits__ovrStatus_OrientationTracked | |
ovrStatusBits__ovrStatus_OrientationValid | |
ovrStatusBits__ovrStatus_PositionTracked | |
ovrStatusBits__ovrStatus_PositionValid | |
ovrSuccessType__ovrSuccess | This is a general success result. Use OVR_SUCCESS to test for success. |
ovrSuccessTypes__ovrSuccess_BoundaryInvalid | Boundary is invalid due to sensor change or was not setup. |
ovrSuccessTypes__ovrSuccess_DeviceUnavailable | Device is not available for the requested operation. |
ovrSuccessTypes__ovrSuccess_NotVisible | Returned from a call to SubmitFrame. The call succeeded, but what the app rendered will not be visible on the HMD. Ideally the app should continue calling SubmitFrame, but not do any rendering. When the result becomes ovrSuccess, rendering should continue as usual. |
ovrTextureBindFlags__ovrTextureBind_DX_DepthStencil | The chain buffers can be bound as depth and/or stencil buffers. This flag cannot be combined with ovrTextureBind_DX_RenderTarget. |
ovrTextureBindFlags__ovrTextureBind_DX_RenderTarget | The application can write into the chain with pixel shader. |
ovrTextureBindFlags__ovrTextureBind_DX_UnorderedAccess | The application can write to the chain with compute shader. |
ovrTextureBindFlags__ovrTextureBind_EnumSize | < \internal Force type int32_t. |
ovrTextureBindFlags__ovrTextureBind_None | |
ovrTextureFormat__OVR_FORMAT_B4G4R4A4_UNORM | < Not currently supported on PC. Requires a DirectX 11.1 device. |
ovrTextureFormat__OVR_FORMAT_B5G5R5A1_UNORM | < Not currently supported on PC. Requires a DirectX 11.1 device. |
ovrTextureFormat__OVR_FORMAT_B5G6R5_UNORM | < Not currently supported on PC. Requires a DirectX 11.1 device. |
ovrTextureFormat__OVR_FORMAT_B8G8R8_UNORM | |
ovrTextureFormat__OVR_FORMAT_B8G8R8A8_UNORM | |
ovrTextureFormat__OVR_FORMAT_B8G8R8A8_UNORM_SRGB | < Not supported for OpenGL applications |
ovrTextureFormat__OVR_FORMAT_B8G8R8X8_UNORM | < Not supported for OpenGL applications |
ovrTextureFormat__OVR_FORMAT_B8G8R8X8_UNORM_SRGB | < Not supported for OpenGL applications |
ovrTextureFormat__OVR_FORMAT_BC1_UNORM | |
ovrTextureFormat__OVR_FORMAT_BC1_UNORM_SRGB | |
ovrTextureFormat__OVR_FORMAT_BC2_UNORM | |
ovrTextureFormat__OVR_FORMAT_BC2_UNORM_SRGB | |
ovrTextureFormat__OVR_FORMAT_BC3_UNORM | |
ovrTextureFormat__OVR_FORMAT_BC3_UNORM_SRGB | |
ovrTextureFormat__OVR_FORMAT_BC7_UNORM | |
ovrTextureFormat__OVR_FORMAT_BC7_UNORM_SRGB | |
ovrTextureFormat__OVR_FORMAT_BC6H_SF16 | |
ovrTextureFormat__OVR_FORMAT_BC6H_UF16 | |
ovrTextureFormat__OVR_FORMAT_D16_UNORM | |
ovrTextureFormat__OVR_FORMAT_D32_FLOAT | |
ovrTextureFormat__OVR_FORMAT_D24_UNORM_S8_UINT | |
ovrTextureFormat__OVR_FORMAT_D32_FLOAT_S8X24_UINT | |
ovrTextureFormat__OVR_FORMAT_ENUMSIZE | < \internal Force type int32_t. |
ovrTextureFormat__OVR_FORMAT_LAST | |
ovrTextureFormat__OVR_FORMAT_R11G11B10_FLOAT | < Not supported for D3D12 applications. Introduced in v1.10 |
ovrTextureFormat__OVR_FORMAT_R16G16B16A16_FLOAT | |
ovrTextureFormat__OVR_FORMAT_R8G8B8A8_UNORM | |
ovrTextureFormat__OVR_FORMAT_R8G8B8A8_UNORM_SRGB | |
ovrTextureFormat__OVR_FORMAT_UNKNOWN | |
ovrTextureLayout__ovrTextureLayout_EnumSize | < \internal Force type int32_t. |
ovrTextureLayout__ovrTextureLayout_Octilinear | < Octilinear extension must be enabled. |
ovrTextureLayout__ovrTextureLayout_Rectilinear | < Regular eyeFov layer. |
ovrTextureMiscFlags__ovrTextureMisc_AllowGenerateMips | DX only: Allow generation of the mip chain on the GPU via the GenerateMips call. This flag requires that RenderTarget binding also be specified. |
ovrTextureMiscFlags__ovrTextureMisc_AutoGenerateMips | Automatically generate and use the mip chain in composition on each submission. Mips are regenerated from highest quality level, ignoring other pre-existing mip levels. Not supported for depth or compressed (BC) formats. |
ovrTextureMiscFlags__ovrTextureMisc_DX_Typeless | Vulkan and DX only: The underlying texture is created with a TYPELESS equivalent of the format specified in the texture desc. The SDK will still access the texture using the format specified in the texture desc, but the app can create views with different formats if this is specified. |
ovrTextureMiscFlags__ovrTextureMisc_EnumSize | < \internal Force type int32_t. |
ovrTextureMiscFlags__ovrTextureMisc_None | |
ovrTextureMiscFlags__ovrTextureMisc_ProtectedContent | Texture swap chain contains protected content, and requires HDCP connection in order to display to HMD. Also prevents mirroring or other redirection of any frame containing this contents |
ovrTextureType__ovrTexture_2D | < 2D textures. |
ovrTextureType__ovrTexture_2D_External | < Application-provided 2D texture. Not supported on PC. |
ovrTextureType__ovrTexture_Count | |
ovrTextureType__ovrTexture_Cube | < Cube maps. ovrTextureSwapChainDesc::ArraySize must be 6 for this type. |
ovrTextureType__ovrTexture_EnumSize | < \internal Force type int32_t. |
ovrTouch__ovrTouch_A | |
ovrTouch__ovrTouch_B | |
ovrTouch__ovrTouch_EnumSize | < \internal Force type int32_t. |
ovrTouch__ovrTouch_LButtonMask | |
ovrTouch__ovrTouch_LIndexPointing | |
ovrTouch__ovrTouch_LIndexTrigger | |
ovrTouch__ovrTouch_LPoseMask | |
ovrTouch__ovrTouch_LThumb | |
ovrTouch__ovrTouch_LThumbRest | |
ovrTouch__ovrTouch_LThumbUp | |
ovrTouch__ovrTouch_RButtonMask | |
ovrTouch__ovrTouch_RIndexPointing | |
ovrTouch__ovrTouch_RIndexTrigger | |
ovrTouch__ovrTouch_RPoseMask | |
ovrTouch__ovrTouch_RThumb | |
ovrTouch__ovrTouch_RThumbRest | |
ovrTouch__ovrTouch_RThumbUp | |
ovrTouch__ovrTouch_X | |
ovrTouch__ovrTouch_Y | |
ovrTrackedDeviceType__ovrTrackedDevice_All | |
ovrTrackedDeviceType__ovrTrackedDevice_HMD | |
ovrTrackedDeviceType__ovrTrackedDevice_LTouch | |
ovrTrackedDeviceType__ovrTrackedDevice_None | |
ovrTrackedDeviceType__ovrTrackedDevice_Object0 | |
ovrTrackedDeviceType__ovrTrackedDevice_Object1 | |
ovrTrackedDeviceType__ovrTrackedDevice_Object2 | |
ovrTrackedDeviceType__ovrTrackedDevice_Object3 | |
ovrTrackedDeviceType__ovrTrackedDevice_RTouch | |
ovrTrackedDeviceType__ovrTrackedDevice_Touch | |
ovrTrackerFlags__ovrTracker_Connected | The sensor is present, else the sensor is absent or offline. |
ovrTrackerFlags__ovrTracker_PoseTracked | The sensor has a valid pose, else the pose is unavailable. This will only be set if ovrTracker_Connected is set. |
ovrTrackingCaps__ovrTrackingCap_EnumSize | < \internal Force type int32_t. |
ovrTrackingCaps__ovrTrackingCap_MagYawCorrection | < Supports yaw drift correction. |
ovrTrackingCaps__ovrTrackingCap_Orientation | < Supports orientation tracking (IMU). |
ovrTrackingCaps__ovrTrackingCap_Position | < Supports positional tracking. |
ovrTrackingOrigin__ovrTrackingOrigin_Count | < \internal Count of enumerated elements. |
ovrTrackingOrigin__ovrTrackingOrigin_EnumSize | < \internal Force type int32_t. |
ovrTrackingOrigin__ovrTrackingOrigin_EyeLevel | \brief Tracking system origin reported at eye (HMD) height \details Prefer using this origin when your application requires matching user's current physical head pose to a virtual head pose without any regards to a the height of the floor. Cockpit-based, or 3rd-person experiences are ideal candidates. When used, all poses in ovrTrackingState are reported as an offset transform from the profile calibrated or recentered HMD pose. It is recommended that apps using this origin type call ovr_RecenterTrackingOrigin prior to starting the VR experience, but notify the user before doing so to make sure the user is in a comfortable pose, facing a comfortable direction. |
ovrTrackingOrigin__ovrTrackingOrigin_FloorLevel | \brief Tracking system origin reported at floor height \details Prefer using this origin when your application requires the physical floor height to match the virtual floor height, such as standing experiences. When used, all poses in ovrTrackingState are reported as an offset transform from the profile calibrated floor pose. Calling ovr_RecenterTrackingOrigin will recenter the X & Z axes as well as yaw, but the Y-axis (i.e. height) will continue to be reported using the floor height as the origin for all poses. |
ovrTrue |
Statics
__security_cookie |
Functions
__report_gsfailure⚠ | |
__security_check_cookie⚠ | |
__security_init_cookie⚠ | |
__va_start⚠ | |
ovrMatrix4f_Projection⚠ | Used to generate projection from ovrEyeDesc::Fov. |
ovrMatrix4f_OrthoSubProjection⚠ | Generates an orthographic sub-projection. |
ovrPosef_FlipHandedness⚠ | Tracking poses provided by the SDK come in a right-handed coordinate system. If an application is passing in ovrProjection_LeftHanded into ovrMatrix4f_Projection, then it should also use this function to flip the HMD tracking poses to be left-handed. |
ovrTimewarpProjectionDesc_FromProjection⚠ | Extracts the required data from the result of ovrMatrix4f_Projection. |
ovr_BeginFrame⚠ | Called from render thread before application begins rendering. Must be called after ovr_WaitToBeginFrame and before ovr_EndFrame, but not necessarily from the same threads. |
ovr_CalcEyePoses⚠ | |
ovr_CalcEyePoses2⚠ | |
ovr_ClearShouldRecenterFlag⚠ | Clears the ShouldRecenter status bit in ovrSessionStatus. |
ovr_CommitTextureSwapChain⚠ | Commits any pending changes to an ovrTextureSwapChain, and advances its current index |
ovr_Create⚠ | Creates a handle to a VR session. |
ovr_CreateMirrorTextureWithOptionsVk⚠ | Create Mirror Texture which is auto-refreshed to mirror Rift contents produced by this application. |
ovr_CreateTextureSwapChainVk⚠ | Create Texture Swap Chain suitable for use with Vulkan |
ovr_Destroy⚠ | Destroys the session. |
ovr_DestroyMirrorTexture⚠ | Destroys a mirror texture previously created by one of the mirror texture creation functions. |
ovr_DestroyTextureSwapChain⚠ | Destroys an ovrTextureSwapChain and frees all the resources associated with it. |
ovr_Detect⚠ | Detects Oculus Runtime and Device Status |
ovr_EnableExtension⚠ | Enable extension. Extensions must be enabled after ovr_Create is called. |
ovr_EndFrame⚠ | Called from render thread after application has finished rendering. Must be called after ovr_BeginFrame, but not necessarily from the same thread. Submits layers for distortion and display, which will happen asynchronously. |
ovr_GenHapticsFromAudioData⚠ | Generates playable Touch Haptics data from an audio channel. |
ovr_GetBool⚠ | Reads a boolean property. |
ovr_GetBoundaryDimensions⚠ | Gets the dimension of the Boundary System's "play area" or "outer boundary". |
ovr_GetBoundaryGeometry⚠ | Gets the geometry of the Boundary System's "play area" or "outer boundary" as 3D floor points. |
ovr_GetBoundaryVisible⚠ | Returns if the boundary is currently visible. Note: visibility is false if the user has turned off boundaries, otherwise, it's true if the app has requested boundaries to be visible or if any tracked device is currently triggering it. This may not exactly match rendering due to fade-in and fade-out effects. |
ovr_GetConnectedControllerTypes⚠ | Returns controller types connected to the system OR'ed together. |
ovr_GetControllerVibrationState⚠ | Gets the Haptics engine playback state of a specific Touch controller. |
ovr_GetDeviceExtensionsVk⚠ | Get a list of Vulkan vkDevice extensions required for VR. |
ovr_GetDevicePoses⚠ | Returns an array of poses, where each pose matches a device type provided by the deviceTypes array parameter. If any pose cannot be retrieved, it will return a reason for the missing pose and the device pose will be zeroed out with a pose quaternion [x=0, y=0, z=0, w=1]. |
ovr_GetExternalCameras⚠ | Returns the number of camera properties of all cameras \param[in] session Specifies an ovrSession previously returned by ovr_Create. \param[in, out] cameras Pointer to the array. If null and the provided array capacity is sufficient, will return ovrError_NullArrayPointer. \param[in, out] inoutCameraCount Supply the array capacity, will return the actual # of cameras defined. If *inoutCameraCount is too small, will return ovrError_InsufficientArraySize. \return Returns the list of external cameras the system knows about. Returns ovrError_NoExternalCameraInfo if there is not any eternal camera information. |
ovr_GetEyePoses⚠ | |
ovr_GetEyePoses2⚠ | |
ovr_GetFloat⚠ | Reads a float property. |
ovr_GetFloatArray⚠ | Reads a float array property. |
ovr_GetFovStencil⚠ | Returns a viewport stencil mesh to be used for defining the area or outline the user can see through the lens on an area defined by a given ovrFovPort. |
ovr_GetFovTextureSize⚠ | Calculates the recommended viewport size for rendering a given eye within the HMD with a given FOV cone. |
ovr_GetHmdDesc⚠ | Returns information about the current HMD. |
ovr_GetInputState⚠ | Returns the most recent input state for controllers, without positional tracking info. |
ovr_GetInstanceExtensionsVk⚠ | Get a list of Vulkan vkInstance extensions required for VR. |
ovr_GetInt⚠ | Reads an integer property. |
ovr_GetLastErrorInfo⚠ | Returns information about the most recent failed return value by the current thread for this library. |
ovr_GetMirrorTextureBufferVk⚠ | Get a the underlying mirror VkImage |
ovr_GetPerfStats⚠ | Retrieves performance stats for the VR app as well as the SDK compositor. |
ovr_GetPredictedDisplayTime⚠ | Gets the time of the specified frame midpoint. |
ovr_GetRenderDesc⚠ | Computes the distortion viewport, view adjust, and other rendering parameters for the specified eye. |
ovr_GetSessionPhysicalDeviceVk⚠ | Find VkPhysicalDevice matching ovrGraphicsLuid |
ovr_GetSessionStatus⚠ | Returns status information for the application. |
ovr_GetString⚠ | Reads a string property. Strings are UTF8-encoded and null-terminated. |
ovr_GetTextureSwapChainBufferVk⚠ | Get a specific VkImage within the chain |
ovr_GetTextureSwapChainCurrentIndex⚠ | Gets the current index in an ovrTextureSwapChain. |
ovr_GetTextureSwapChainDesc⚠ | Gets the description of the buffers in an ovrTextureSwapChain |
ovr_GetTextureSwapChainLength⚠ | Gets the number of buffers in an ovrTextureSwapChain. |
ovr_GetTimeInSeconds⚠ | Returns global, absolute high-resolution time in seconds. |
ovr_GetTouchHapticsDesc⚠ | Gets information about Haptics engine for the specified Touch controller. |
ovr_GetTrackerCount⚠ | Returns the number of attached trackers. |
ovr_GetTrackerDesc⚠ | Returns a given attached tracker description. |
ovr_GetTrackerPose⚠ | Returns the ovrTrackerPose for the given attached tracker. |
ovr_GetTrackingOriginType⚠ | Gets the tracking origin state |
ovr_GetTrackingState⚠ | Returns tracking state reading based on the specified absolute system time. |
ovr_GetVersionString⚠ | Returns the version string representing the LibOVRRT version. |
ovr_IdentifyClient⚠ | Identify client application info. |
ovr_Initialize⚠ | Initializes LibOVR |
ovr_IsExtensionSupported⚠ | Query extension support status. |
ovr_ReadWavFromBuffer⚠ | Reads an audio channel from Wav (Waveform Audio File) data. Input must be a byte buffer representing a valid Wav file. Audio samples from the specified channel are read, converted to float [-1.0f, 1.0f] and returned through ovrAudioChannelData. |
ovr_RecenterTrackingOrigin⚠ | Re-centers the sensor position and orientation. |
ovr_ReleaseAudioChannelData⚠ | Releases memory allocated for ovrAudioChannelData. Must be called to avoid memory leak. \param[in] audioChannel pointer to an audio channel |
ovr_ReleaseHapticsClip⚠ | Releases memory allocated for ovrHapticsClip. Must be called to avoid memory leak. \param[in] hapticsClip pointer to a haptics clip |
ovr_RequestBoundaryVisible⚠ | Requests boundary to be visible. |
ovr_ResetBoundaryLookAndFeel⚠ | Resets the look and feel of the Boundary System to its default state. |
ovr_ResetPerfStats⚠ | Resets the accumulated stats reported in each ovrPerfStatsPerCompositorFrame back to zero. |
ovr_SetBool⚠ | Writes or creates a boolean property. If the property wasn't previously a boolean property, it is changed to a boolean property. |
ovr_SetBoundaryLookAndFeel⚠ | Compatibility stub. |
ovr_SetControllerVibration⚠ | Sets constant vibration (with specified frequency and amplitude) to a controller. Note: ovr_SetControllerVibration cannot be used interchangeably with ovr_SubmitControllerVibration. |
ovr_SetExternalCameraProperties⚠ | Sets the camera intrinsics and/or extrinsics stored for the cameraName camera Names must be < 32 characters and null-terminated. |
ovr_SetFloat⚠ | Writes or creates a float property. If the property wasn't previously a float property, it's changed to a float property. |
ovr_SetFloatArray⚠ | Writes or creates a float array property. |
ovr_SetInt⚠ | Writes or creates an integer property. |
ovr_SetString⚠ | Writes or creates a string property. Strings are UTF8-encoded and null-terminated. |
ovr_SetSynchronizationQueueVk⚠ | Select VkQueue to block on till rendering is complete |
ovr_SetTrackingOriginType⚠ | Sets the tracking origin type |
ovr_Shutdown⚠ | Shuts down LibOVR |
ovr_SpecifyTrackingOrigin⚠ | Allows manually tweaking the sensor position and orientation. |
ovr_SubmitControllerVibration⚠ | Submits a Haptics buffer (used for vibration) to Touch (only) controllers. Note: ovr_SubmitControllerVibration cannot be used interchangeably with ovr_SetControllerVibration. |
ovr_SubmitFrame⚠ | Submits layers for distortion and display. |
ovr_TestBoundary⚠ | Tests collision/proximity of position tracked devices (e.g. HMD and/or Touch) against the Boundary System. Note: this method is similar to ovr_BoundaryTestPoint but can be more precise as it may take into account device acceleration/momentum. |
ovr_TestBoundaryPoint⚠ | Tests collision/proximity of a 3D point against the Boundary System. |
ovr_TraceMessage⚠ | Writes a message string to the LibOVR tracing mechanism (if enabled). |
ovr_WaitToBeginFrame⚠ | Waits until surfaces are available and it is time to begin rendering the frame. Must be called before ovr_BeginFrame, but not necessarily from the same thread. |
Type Definitions
PFN_ovrVoidFunction | Defines a generic function pointer. |
VkDevice | |
VkImage | |
VkInstance | |
VkPhysicalDevice | |
VkQueue | |
__vcrt_bool | |
_bindgen_ty_1 | Specifies the maximum number of layers supported by ovr_SubmitFrame. |
_bindgen_ty_2 | Maximum number of frames of performance stats provided back to the caller of ovr_GetPerfStats |
int_fast8_t | |
int_fast16_t | |
int_fast32_t | |
int_fast64_t | |
int_least8_t | |
int_least16_t | |
int_least32_t | |
int_least64_t | |
intmax_t | |
ovrAudioChannelData | |
ovrBool | |
ovrBoundaryLookAndFeel | |
ovrBoundaryTestResult | |
ovrBoundaryType_ | Boundary types that specified while using the boundary system |
ovrButton_ | Describes button input types. Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices. The ovrButton_Up/Down/Left/Right map to both XBox D-Pad and directional buttons. The ovrButton_Enter and ovrButton_Return map to Start and Back controller buttons, respectively. |
ovrCameraExtrinsics | |
ovrCameraIntrinsics | |
ovrCameraStatusFlags_ | |
ovrColorf | |
ovrControllerType_ | Specifies which controller is connected; multiple can be connected at once. |
ovrDebugHudStereoMode_ | Debug HUD is provided to help developers gauge and debug the fidelity of their app's stereo rendering characteristics. Using the provided quad and crosshair guides, the developer can verify various aspects such as VR tracking units (e.g. meters), stereo camera-parallax properties (e.g. making sure objects at infinity are rendered with the proper separation), measuring VR geometry sizes and distances and more. |
ovrDetectResult | |
ovrErrorInfo | |
ovrErrorType_ | |
ovrExtensionProperties | |
ovrExtensions_ | Optional extensions |
ovrExternalCamera | |
ovrEyeRenderDesc | |
ovrEyeType_ | Specifies which eye is being used for rendering. This type explicitly does not include a third "NoStereo" monoscopic option, as such is not required for an HMD-centered API. |
ovrFovPort | |
ovrFovStencilDesc | |
ovrFovStencilFlags_ | Identifies flags used by ovrFovStencilDesc and which are passed to ovr_GetFovStencil. \see ovrFovStencilDesc |
ovrFovStencilMeshBuffer | |
ovrFovStencilType_ | Viewport stencil types provided by the ovr_GetFovStencil call. \see ovr_GetFovStencil |
ovrGraphicsLuid | |
ovrHandType_ | Provides names for the left and right hand array indexes. |
ovrHapticsBuffer | |
ovrHapticsBufferSubmitMode_ | Haptics buffer submit mode |
ovrHapticsClip | |
ovrHapticsGenMode_ | Modes used to generate Touch Haptics from audio PCM buffer. |
ovrHapticsPlaybackState | |
ovrHmdCaps_ | HMD capability bits reported by device. |
ovrHmdDesc | |
ovrHmdType_ | Enumerates all HMD types that we support. |
ovrInitFlags_ | Initialization flags. |
ovrInitParams | |
ovrInputState | |
ovrLayerCube | |
ovrLayerCylinder | |
ovrLayerEyeFov | |
ovrLayerEyeFovDepth | |
ovrLayerEyeFovMultires | |
ovrLayerEyeMatrix | |
ovrLayerFlags_ | Identifies flags used by ovrLayerHeader and which are passed to ovr_SubmitFrame. |
ovrLayerHeader | Defines properties shared by all ovrLayer structs, such as ovrLayerEyeFov. |
ovrLayerHudMode_ | Layer HUD enables the HMD user to see information about a layer |
ovrLayerQuad | |
ovrLayerType_ | Describes layer types that can be passed to ovr_SubmitFrame. Each layer type has an associated struct, such as ovrLayerEyeFov. |
ovrLayer_Union | |
ovrLogCallback | Signature of the logging callback function pointer type. |
ovrLogLevel_ | Logging levels |
ovrMatrix4f | |
ovrMirrorOptions_ | Bit flags used as part of ovrMirrorTextureDesc's MirrorOptions field. |
ovrMirrorTexture | |
ovrMirrorTextureDesc | |
ovrPerfHudMode_ | Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics |
ovrPerfStats | |
ovrPerfStatsPerCompositorFrame | |
ovrPoseStatef | |
ovrPosef | |
ovrProcessId | |
ovrProjectionModifier_ | Enumerates modifications to the projection matrix based on the application's needs. |
ovrQuatf | |
ovrRecti | |
ovrResult | API call results are represented at the highest level by a single ovrResult. |
ovrSession | Used as an opaque pointer to an OVR session. |
ovrSessionStatus | |
ovrSizei | |
ovrStatusBits_ | Bit flags describing the current status of sensor tracking. The values must be the same as in enum StatusBits |
ovrSuccessType_ | |
ovrSuccessTypes_ | |
ovrTextureBindFlags_ | The bindings required for texture swap chain. |
ovrTextureFormat_ | The format of a texture. |
ovrTextureLayoutDesc_Union | |
ovrTextureLayoutOctilinear | |
ovrTextureLayout_ | Describes eye texture layouts. Used with ovrLayerEyeFovMultires. |
ovrTextureMiscFlags_ | Misc flags overriding particular behaviors of a texture swap chain |
ovrTextureSwapChain | |
ovrTextureSwapChainDesc | |
ovrTextureType_ | The type of texture resource. |
ovrTimewarpProjectionDesc | |
ovrTouchHapticsDesc | |
ovrTouch_ | Describes touch input types. These values map to capacitive touch values reported ovrInputState::Touch. Some of these values are mapped to button bits for consistency. |
ovrTrackedDeviceType_ | Position tracked devices |
ovrTrackerDesc | |
ovrTrackerFlags_ | Specifies sensor flags. |
ovrTrackerPose | |
ovrTrackingCaps_ | Tracking capability bits reported by the device. Used with ovr_GetTrackingCaps. |
ovrTrackingOrigin_ | Specifies the coordinate system ovrTrackingState returns tracking poses in. Used with ovr_SetTrackingOriginType() |
ovrTrackingState | |
ovrVector2i | |
ovrVector2f | |
ovrVector3f | |
ovrVector4f | |
ovrViewScaleDesc | |
size_t | |
staticAssert0 | |
staticAssert1 | |
uint_fast8_t | |
uint_fast16_t | |
uint_fast32_t | |
uint_fast64_t | |
uint_least8_t | |
uint_least16_t | |
uint_least32_t | |
uint_least64_t | |
uintmax_t | |
va_list | |
wchar_t |
Unions
ovrLayer_Union_ | Union that combines ovrLayer types in a way that allows them to be used in a polymorphic way. |
ovrTextureLayoutDesc_Union_ | Combines texture layout descriptors. |