Modules§
Structs§
- Compositor_
Benchmark Results - Provides compositor benchmark results to the app
- Compositor_
Cumulative Stats - Cumulative stats for current application. These are not cleared until a new app connects, but they do stop accumulating once the associated app disconnects.
- Compositor_
Frame Timing - Provides a single frame’s timing information to the app
- Compositor_
Stage Render Settings - Distortion
Coordinates_ t - Used to return the post-distortion UVs for each color channel. UVs range from 0 to 1 with 0,0 in the upper left corner of the source render target. The 0,0 to 1,1 range covers a single eye.
- Hidden
Area Mesh_ t - The mesh to draw into the stencil (or depth) buffer to perform early stencil (or depth) kills of pixels that will never appear on the HMD. This mesh draws on all the pixels that will be hidden after distortion.
- HmdColor_
t - HmdMatrix34_
t - HmdMatrix44_
t - HmdRect2_
t - HmdVector2_
t - HmdVector3_
t - IVRCompositor
- Allows the application to interact with the compositor
- IVRInput
- IVROverlay
- IVRSystem
- Input
Analog Action Data_ t - Input
Binding Info_ t - Input
Digital Action Data_ t - Input
Origin Info_ t - Input
Pose Action Data_ t - Input
Skeletal Action Data_ t - Render
Model_ Component State_ t - Describes state information about a render-model component, including transforms and other dynamic properties
- Texture_
t - Tracked
Device Pose_ t - describes a single pose for a tracked object
- VRActive
Action Set_ t - VRBone
Transform_ t - Holds the transform for a single bone
- VRController
State001_ t - Holds all the state of a controller at one moment in time.
- VREvent_
Application Launch_ t - VREvent_
Chaperone_ t - VREvent_
Controller_ t - used for controller button events
- VREvent_
Editing Camera Surface_ t - VREvent_
HDCP Error_ t - VREvent_
Haptic Vibration_ t - VREvent_
Input Action Manifest Load_ t - VREvent_
Input Binding Load_ t - VREvent_
Ipd_ t - VREvent_
Keyboard_ t - Used for keyboard events
- VREvent_
Message Overlay_ t - VREvent_
Mouse_ t - used for simulated mouse events in overlay space
- VREvent_
Notification_ t - notification related events. Details will still change at this point
- VREvent_
Overlay_ t - Used for a few events about overlays
- VREvent_
Performance Test_ t - VREvent_
Process_ t - Used for events about processes
- VREvent_
Progress Update_ t - VREvent_
Property_ t - VREvent_
Reserved_ t - Not actually used for any events
- VREvent_
Screenshot Progress_ t - VREvent_
Screenshot_ t - VREvent_
Scroll_ t - used for simulated mouse wheel scroll
- VREvent_
Seated Zero Pose Reset_ t - VREvent_
Show DevTools_ t - VREvent_
ShowUI_ t - VREvent_
Spatial Anchor_ t - VREvent_
Status_ t - Used for a few events about overlays
- VREvent_
Touch PadMove_ t - when in mouse input mode you can receive data from the touchpad, these events are only sent if the users finger is on the touchpad (or just released from it). These events are sent to overlays with the VROverlayFlags_SendVRTouchpadEvents flag set.
- VREvent_
WebConsole_ t - VREvent_
t - VREvent_
t - An event posted by the server to all running applications
- VROverlay
Intersection Mask Primitive_ t - VROverlay
Intersection Params_ t - VROverlay
Intersection Results_ t - VROverlay
Projection_ t - Defines the project used in an overlay that is using SetOverlayTransformProjection
- VRSkeletal
Summary Data_ t - Contains summary information about the current skeletal pose
- VRTexture
Bounds_ t - Allows the application to control what part of the provided texture will be used in the frame buffer.
- VRVulkan
Texture Data_ t - Data required for passing Vulkan textures to IVRCompositor::Submit. Be sure to call OpenVR_Shutdown before destroying these resources. Please see https://github.com/ValveSoftware/openvr/wiki/Vulkan for Vulkan-specific documentation
- VkDevice_
T - VkInstance_
T - VkPhysical
Device_ T - VkQueue_
T
Enums§
- EColor
Space - EDevice
Activity Level - Level of Hmd activity
- EGamepad
Text Input Line Mode - EGamepad
Text Input Mode - EHDCP
Error - EHidden
Area Mesh Type - EShowUI
Type - ETexture
Type - ETracked
Controller Role - Describes what specific role associated with a tracked device
- ETracked
Device Class - Describes what kind of object is being tracked at a given ID
- ETracked
Device Property - Each entry in this enum represents a property that can be retrieved about a tracked device. Many fields are only valid for one ETrackedDeviceClass.
- ETracked
Property Error - Used to return errors that occur when reading properties.
- ETracking
Result - ETracking
Universe Origin - Identifies which style of tracking origin the application wants to use for the poses it is requesting
- EVRApplication
Type - enum values to pass in to VR_Init to identify whether the application will draw a 3D scene.
- EVRButton
Id - VR controller button and axis IDs
- EVRCompositor
Error - Errors that can occur with the VR compositor
- EVRCompositor
Timing Mode - Timing mode passed to SetExplicitTimingMode(); see that function for documentation
- EVRController
Axis Type - Identifies what kind of axis is on the controller at index n. Read this type with pVRSystem->Get( nControllerDeviceIndex, Prop_Axis0Type_Int32 + n );
- EVREvent
Type - The types of events that could be posted (and what the parameters mean for each event type)
- EVREye
- EVRFirmware
Error - error codes for firmware
- EVRInit
Error - error codes returned by Vr_Init
- EVRInput
Error - EVROverlay
Error - Errors that can occur around VR overlays
- EVRSkeletal
Motion Range - EVRSkeletal
Reference Pose - EVRSkeletal
Tracking Level - EVRSkeletal
Transform Space - EVRSubmit
Flags - Allows the application to control how scene textures are used by the compositor when calling Submit.
- EVRSummary
Type - VRMessage
Overlay Response - VROverlay
Flags - Overlay control settings
- VROverlay
Input Method - Types of input supported by VR Overlays
- VROverlay
Transform Type - Allows the caller to figure out which overlay transform getter to call.
Constants§
Traits§
Functions§
- VRCompositor
- VRInput
- VROverlay
- VR_Init⚠
- Finds the active installation of the VR API and initializes it. The provided path must be absolute or relative to the current working directory. These are the local install versions of the equivalent functions in steamvr.h and will work without a local Steam install.
- VR_
IsHmd Present - Returns true if there is an HMD attached. This check is as lightweight as possible and can be called outside of VR_Init/VR_Shutdown. It should be used when an application wants to know if initializing VR is a possibility but isn’t ready to take that step yet.
- VR_
Shutdown - unloads vrclient.dll. Any interface pointers from the interface are invalid after this point
- make_
string
Type Aliases§
- Bone
Index_ t - Type used for referring to bones by their index
- Property
Container Handle_ t - Property
Type Tag_ t - Spatial
Anchor Handle_ t - A handle for a spatial anchor. This handle is only valid during the session it was created in. Anchors that live beyond one session should be saved by their string descriptors.
- Tracked
Device Index_ t - Used to pass device IDs to API calls
- VRAction
Handle_ t - VRAction
SetHandle_ t - VRController
State_ t - Holds all the state of a controller at one moment in time.
- VRInput
Value Handle_ t - VROverlay
Handle_ t - used to refer to a single VR overlay
- WebConsole
Handle_ t - glShared
Texture Handle_ t - glUInt_
t