openvr.helper

Members

Classes

COpenVRContext

class COpenVRContext

Undocumented in source but is binding to C++. You might be able to learn more by searching the web for its name.

Enums

VR_COMPOSITOR_ADDITIONAL_PREDICTED_FRAMES

eponymoustemplate VR_COMPOSITOR_ADDITIONAL_PREDICTED_FRAMES(alias timing)

Undocumented in source.

VR_COMPOSITOR_NUMBER_OF_THROTTLED_FRAMES

eponymoustemplate VR_COMPOSITOR_NUMBER_OF_THROTTLED_FRAMES(alias timing)

Undocumented in source.

Functions

ButtonMaskFromId

ulong ButtonMaskFromId(EVRButtonId id)

Undocumented in source. Be warned that the author may not have intended to support it.

IsRoleAllowedAsHand

bool IsRoleAllowedAsHand(ETrackedControllerRole eRole)

Returns true if the tracked controller role is allowed to be a hand

OpenVRInternal_ModuleContext

COpenVRContext OpenVRInternal_ModuleContext()

Undocumented in source. Be warned that the author may not have intended to support it.

VRApplications

IVRApplications VRApplications()

Undocumented in source. Be warned that the author may not have intended to support it.

VRChaperone

IVRChaperone VRChaperone()

Undocumented in source. Be warned that the author may not have intended to support it.

VRChaperoneSetup

IVRChaperoneSetup VRChaperoneSetup()

Undocumented in source. Be warned that the author may not have intended to support it.

VRCompositor

IVRCompositor VRCompositor()

Undocumented in source. Be warned that the author may not have intended to support it.

VRDebug

IVRDebug VRDebug()

Undocumented in source. Be warned that the author may not have intended to support it.

VRDriverManager

IVRDriverManager VRDriverManager()

Undocumented in source. Be warned that the author may not have intended to support it.

VRExtendedDisplay

IVRExtendedDisplay VRExtendedDisplay()

Undocumented in source. Be warned that the author may not have intended to support it.

VRHeadsetView

IVRHeadsetView VRHeadsetView()

Returns the current IVRHeadsetView pointer or NULL the interface could not be found.

VRHeadsetView

IVRHeadsetView VRHeadsetView()

Undocumented in source. Be warned that the author may not have intended to support it.

VRIOBuffer

IVRIOBuffer VRIOBuffer()

Undocumented in source. Be warned that the author may not have intended to support it.

VRInput

IVRInput VRInput()

Undocumented in source. Be warned that the author may not have intended to support it.

VRNotifications

IVRNotifications VRNotifications()

Undocumented in source. Be warned that the author may not have intended to support it.

VROverlay

IVROverlay VROverlay()

Undocumented in source. Be warned that the author may not have intended to support it.

VROverlayView

IVROverlayView VROverlayView()

Undocumented in source. Be warned that the author may not have intended to support it.

VRRenderModels

IVRRenderModels VRRenderModels()

Undocumented in source. Be warned that the author may not have intended to support it.

VRResources

IVRResources VRResources()

Undocumented in source. Be warned that the author may not have intended to support it.

VRScreenshots

IVRScreenshots VRScreenshots()

Undocumented in source. Be warned that the author may not have intended to support it.

VRSettings

IVRSettings VRSettings()

Undocumented in source. Be warned that the author may not have intended to support it.

VRSpatialAnchors

IVRSpatialAnchors VRSpatialAnchors()

Undocumented in source. Be warned that the author may not have intended to support it.

VRSystem

IVRSystem VRSystem()

Undocumented in source. Be warned that the author may not have intended to support it.

VRToken

uint VRToken()

Undocumented in source. Be warned that the author may not have intended to support it.

VRTrackedCamera

IVRTrackedCamera VRTrackedCamera()

Undocumented in source. Be warned that the author may not have intended to support it.

VR_GetGenericInterface

void* VR_GetGenericInterface(const(char)* pchInterfaceVersion, EVRInitError* peError)

Returns the interface of the specified version. This method must be called after VR_Init. The pointer returned is valid until VR_Shutdown is called.

VR_GetInitToken

uint VR_GetInitToken()

Returns a token that represents whether the VR interface handles need to be reloaded

VR_GetRuntimePath

bool VR_GetRuntimePath(char* pchPathBuffer, uint unBufferSize, uint* punRequiredBufferSize)

Returns where the OpenVR runtime is installed.

VR_GetVRInitErrorAsEnglishDescription

const(char)* VR_GetVRInitErrorAsEnglishDescription(EVRInitError error)

Returns an English string for an EVRInitError. Applications should call VR_GetVRInitErrorAsSymbol instead and use that as a key to look up their own localized error message. This function may be called outside of VR_Init()/VR_Shutdown().

VR_GetVRInitErrorAsSymbol

const(char)* VR_GetVRInitErrorAsSymbol(EVRInitError error)

Returns the name of the enum value for an EVRInitError. This function may be called outside of VR_Init()/VR_Shutdown().

VR_Init

IVRSystem VR_Init(EVRInitError* peError, EVRApplicationType eApplicationType, const(char)* pStartupInfo)

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_Init

IVRSystem VR_Init(EVRInitError* peError, EVRApplicationType eApplicationType, const(char)* pStartupInfo)

Finds the active installation of vrclient.dll and initializes it

VR_InitInternal2

uint VR_InitInternal2(EVRInitError* peError, EVRApplicationType eApplicationType, const(char)* pStartupInfo)

Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

VR_IsHmdPresent

bool VR_IsHmdPresent()

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_IsInterfaceVersionValid

bool VR_IsInterfaceVersionValid(const(char)* pchInterfaceVersion)

Returns whether the interface of the specified version exists.

VR_IsRuntimeInstalled

bool VR_IsRuntimeInstalled()

Returns true if the OpenVR runtime is installed.

VR_Shutdown

void VR_Shutdown()

unloads vrclient.dll. Any interface pointers from the interface are invalid after this point

VR_Shutdown

void VR_Shutdown()

unloads vrclient.dll. Any interface pointers from the interface are invalid after this point

VR_ShutdownInternal

void VR_ShutdownInternal()

Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Variables

VRCompositor_PredictionMask

enum uint VRCompositor_PredictionMask;

The runtime may predict more than one frame (up to four) ahead if it detects the application is taking too long to render. These two bits will contain the count of additional frames (normally zero). Use the VR_COMPOSITOR_ADDITIONAL_PREDICTED_FRAMES macro to read from the latest frame timing entry.

VRCompositor_ReprojectionAsync

enum uint VRCompositor_ReprojectionAsync;

Undocumented in source.

VRCompositor_ReprojectionMotion

enum uint VRCompositor_ReprojectionMotion;

This flag indicates whether or not motion smoothing was triggered for this frame

VRCompositor_ReprojectionMotion_AppThrottled

enum uint VRCompositor_ReprojectionMotion_AppThrottled;

Application is requesting throttling via ForceInterleavedReprojectionOn

VRCompositor_ReprojectionMotion_Enabled

enum uint VRCompositor_ReprojectionMotion_Enabled;

These flags will be set on DriverDirectMode_FrameTiming::m_nReprojectionFlags when IVRDriverDirectModeComponent::GetFrameTiming is called for drivers to optionally respond to. *//// Motion Smoothing is enabled in the UI for the currently running applicatio

VRCompositor_ReprojectionMotion_ForcedOn

enum uint VRCompositor_ReprojectionMotion_ForcedOn;

Motion Smoothing is forced on in the UI for the currently running application

VRCompositor_ReprojectionReason_Cpu

enum uint VRCompositor_ReprojectionReason_Cpu;

Compositor frame timing reprojection flags. This flag indicates the async reprojection mode is active, but does not indicate if reprojection actually happened or not. Use the ReprojectionReason flags above to check if reprojection was actually applied (i.e. scene texture was reused). NumFramePresents > 1 also indicates the scene texture was reused, and also the number of times that it was presented in total.

VRCompositor_ReprojectionReason_Gpu

enum uint VRCompositor_ReprojectionReason_Gpu;

Undocumented in source.

VRCompositor_ThrottleMask

enum uint VRCompositor_ThrottleMask;

Number of frames the compositor is throttling the application. Use the VR_COMPOSITOR_NUMBER_OF_THROTTLED_FRAMES macro to read from the latest frame timing entry.

• api
• dx_stub
• helper
• vk_stub