- ClearOverlayCursorPositionOverride
EVROverlayError ClearOverlayCursorPositionOverride(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- ClearOverlayTexture
EVROverlayError ClearOverlayTexture(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- CloseMessageOverlay
void CloseMessageOverlay()
Undocumented in source.
- ComputeOverlayIntersection
bool ComputeOverlayIntersection(VROverlayHandle_t ulOverlayHandle, const(VROverlayIntersectionParams_t)* pParams, VROverlayIntersectionResults_t* pResults)
Undocumented in source.
- CreateDashboardOverlay
EVROverlayError CreateDashboardOverlay(const(char)* pchOverlayKey, const(char)* pchOverlayFriendlyName, VROverlayHandle_t* pMainHandle, VROverlayHandle_t* pThumbnailHandle)
Undocumented in source.
- CreateOverlay
EVROverlayError CreateOverlay(const(char)* pchOverlayKey, const(char)* pchOverlayName, VROverlayHandle_t* pOverlayHandle)
Undocumented in source.
- DestroyOverlay
EVROverlayError DestroyOverlay(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- FindOverlay
EVROverlayError FindOverlay(const(char)* pchOverlayKey, VROverlayHandle_t* pOverlayHandle)
Undocumented in source.
- GetDashboardOverlaySceneProcess
EVROverlayError GetDashboardOverlaySceneProcess(VROverlayHandle_t ulOverlayHandle, uint* punProcessId)
Undocumented in source.
- GetKeyboardText
uint GetKeyboardText(char* pchText, uint cchText)
Undocumented in source.
- GetOverlayAlpha
EVROverlayError GetOverlayAlpha(VROverlayHandle_t ulOverlayHandle, float* pfAlpha)
Undocumented in source.
- GetOverlayColor
EVROverlayError GetOverlayColor(VROverlayHandle_t ulOverlayHandle, float* pfRed, float* pfGreen, float* pfBlue)
Undocumented in source.
- GetOverlayCurvature
EVROverlayError GetOverlayCurvature(VROverlayHandle_t ulOverlayHandle, float* pfCurvature)
Undocumented in source.
- GetOverlayErrorNameFromEnum
const(char)* GetOverlayErrorNameFromEnum(EVROverlayError error)
Undocumented in source.
- GetOverlayFlag
EVROverlayError GetOverlayFlag(VROverlayHandle_t ulOverlayHandle, VROverlayFlags eOverlayFlag, bool* pbEnabled)
Undocumented in source.
- GetOverlayFlags
EVROverlayError GetOverlayFlags(VROverlayHandle_t ulOverlayHandle, uint* pFlags)
Undocumented in source.
- GetOverlayImageData
EVROverlayError GetOverlayImageData(VROverlayHandle_t ulOverlayHandle, void* pvBuffer, uint unBufferSize, uint* punWidth, uint* punHeight)
Undocumented in source.
- GetOverlayInputMethod
EVROverlayError GetOverlayInputMethod(VROverlayHandle_t ulOverlayHandle, VROverlayInputMethod* peInputMethod)
Undocumented in source.
- GetOverlayKey
uint GetOverlayKey(VROverlayHandle_t ulOverlayHandle, char* pchValue, uint unBufferSize, EVROverlayError* pError)
Undocumented in source.
- GetOverlayMouseScale
EVROverlayError GetOverlayMouseScale(VROverlayHandle_t ulOverlayHandle, HmdVector2_t* pvecMouseScale)
Undocumented in source.
- GetOverlayName
uint GetOverlayName(VROverlayHandle_t ulOverlayHandle, char* pchValue, uint unBufferSize, EVROverlayError* pError)
Undocumented in source.
- GetOverlayRenderingPid
uint GetOverlayRenderingPid(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- GetOverlaySortOrder
EVROverlayError GetOverlaySortOrder(VROverlayHandle_t ulOverlayHandle, uint* punSortOrder)
Undocumented in source.
- GetOverlayTexelAspect
EVROverlayError GetOverlayTexelAspect(VROverlayHandle_t ulOverlayHandle, float* pfTexelAspect)
Undocumented in source.
- GetOverlayTexture
EVROverlayError GetOverlayTexture(VROverlayHandle_t ulOverlayHandle, void** pNativeTextureHandle, void* pNativeTextureRef, uint* pWidth, uint* pHeight, uint* pNativeFormat, ETextureType* pAPIType, EColorSpace* pColorSpace, VRTextureBounds_t* pTextureBounds)
Get the native texture handle/device for an overlay you have created. On windows this handle will be a ID3D11ShaderResourceView with a ID3D11Texture2D bound.
The texture will always be sized to match the backing texture you supplied in SetOverlayTexture above.
You MUST call ReleaseNativeOverlayHandle() with pNativeTextureHandle once you are done with this texture.
pNativeTextureHandle is an OUTPUT, it will be a pointer to a ID3D11ShaderResourceView *. pNativeTextureRef is an INPUT and should be a ID3D11Resource *. The device used by pNativeTextureRef will be used to bind pNativeTextureHandle.
- GetOverlayTextureBounds
EVROverlayError GetOverlayTextureBounds(VROverlayHandle_t ulOverlayHandle, VRTextureBounds_t* pOverlayTextureBounds)
Undocumented in source.
- GetOverlayTextureColorSpace
EVROverlayError GetOverlayTextureColorSpace(VROverlayHandle_t ulOverlayHandle, EColorSpace* peTextureColorSpace)
Undocumented in source.
- GetOverlayTextureSize
EVROverlayError GetOverlayTextureSize(VROverlayHandle_t ulOverlayHandle, uint* pWidth, uint* pHeight)
Undocumented in source.
- GetOverlayTransformAbsolute
EVROverlayError GetOverlayTransformAbsolute(VROverlayHandle_t ulOverlayHandle, ETrackingUniverseOrigin* peTrackingOrigin, HmdMatrix34_t* pmatTrackingOriginToOverlayTransform)
Undocumented in source.
- GetOverlayTransformCursor
EVROverlayError GetOverlayTransformCursor(VROverlayHandle_t ulOverlayHandle, HmdVector2_t* pvHotspot)
Undocumented in source.
- GetOverlayTransformOverlayRelative
EVROverlayError GetOverlayTransformOverlayRelative(VROverlayHandle_t ulOverlayHandle, VROverlayHandle_t* ulOverlayHandleParent, HmdMatrix34_t* pmatParentOverlayToOverlayTransform)
Undocumented in source.
- GetOverlayTransformTrackedDeviceComponent
EVROverlayError GetOverlayTransformTrackedDeviceComponent(VROverlayHandle_t ulOverlayHandle, TrackedDeviceIndex_t* punDeviceIndex, char* pchComponentName, uint unComponentNameSize)
Undocumented in source.
- GetOverlayTransformTrackedDeviceRelative
EVROverlayError GetOverlayTransformTrackedDeviceRelative(VROverlayHandle_t ulOverlayHandle, TrackedDeviceIndex_t* punTrackedDevice, HmdMatrix34_t* pmatTrackedDeviceToOverlayTransform)
Undocumented in source.
- GetOverlayTransformType
EVROverlayError GetOverlayTransformType(VROverlayHandle_t ulOverlayHandle, VROverlayTransformType* peTransformType)
Undocumented in source.
- GetOverlayWidthInMeters
EVROverlayError GetOverlayWidthInMeters(VROverlayHandle_t ulOverlayHandle, float* pfWidthInMeters)
Undocumented in source.
- GetPrimaryDashboardDevice
TrackedDeviceIndex_t GetPrimaryDashboardDevice()
Undocumented in source.
- GetTransformForOverlayCoordinates
EVROverlayError GetTransformForOverlayCoordinates(VROverlayHandle_t ulOverlayHandle, ETrackingUniverseOrigin eTrackingOrigin, HmdVector2_t coordinatesInOverlay, HmdMatrix34_t* pmatTransform)
Undocumented in source.
- HideKeyboard
void HideKeyboard()
Undocumented in source.
- HideOverlay
EVROverlayError HideOverlay(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- IsActiveDashboardOverlay
bool IsActiveDashboardOverlay(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- IsDashboardVisible
bool IsDashboardVisible()
Undocumented in source.
- IsHoverTargetOverlay
bool IsHoverTargetOverlay(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- IsOverlayVisible
bool IsOverlayVisible(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- PollNextOverlayEvent
bool PollNextOverlayEvent(VROverlayHandle_t ulOverlayHandle, VREvent_t* pEvent, uint uncbVREvent)
Undocumented in source.
- ReleaseNativeOverlayHandle
EVROverlayError ReleaseNativeOverlayHandle(VROverlayHandle_t ulOverlayHandle, void* pNativeTextureHandle)
Undocumented in source.
- SetDashboardOverlaySceneProcess
EVROverlayError SetDashboardOverlaySceneProcess(VROverlayHandle_t ulOverlayHandle, uint unProcessId)
Undocumented in source.
- SetKeyboardPositionForOverlay
void SetKeyboardPositionForOverlay(VROverlayHandle_t ulOverlayHandle, HmdRect2_t avoidRect)
Undocumented in source.
- SetKeyboardTransformAbsolute
void SetKeyboardTransformAbsolute(ETrackingUniverseOrigin eTrackingOrigin, const(HmdMatrix34_t)* pmatTrackingOriginToKeyboardTransform)
Undocumented in source.
- SetOverlayAlpha
EVROverlayError SetOverlayAlpha(VROverlayHandle_t ulOverlayHandle, float fAlpha)
Undocumented in source.
- SetOverlayColor
EVROverlayError SetOverlayColor(VROverlayHandle_t ulOverlayHandle, float fRed, float fGreen, float fBlue)
Undocumented in source.
- SetOverlayCursor
EVROverlayError SetOverlayCursor(VROverlayHandle_t ulOverlayHandle, VROverlayHandle_t ulCursorHandle)
Undocumented in source.
- SetOverlayCursorPositionOverride
EVROverlayError SetOverlayCursorPositionOverride(VROverlayHandle_t ulOverlayHandle, const(HmdVector2_t)* pvCursor)
Undocumented in source.
- SetOverlayCurvature
EVROverlayError SetOverlayCurvature(VROverlayHandle_t ulOverlayHandle, float fCurvature)
Undocumented in source.
- SetOverlayFlag
EVROverlayError SetOverlayFlag(VROverlayHandle_t ulOverlayHandle, VROverlayFlags eOverlayFlag, bool bEnabled)
Undocumented in source.
- SetOverlayFromFile
EVROverlayError SetOverlayFromFile(VROverlayHandle_t ulOverlayHandle, const(char)* pchFilePath)
Separate interface for providing the image through a filename: can be png or jpg, and should not be bigger than 1920x1080.
This function can only be called by the overlay's renderer process
- SetOverlayInputMethod
EVROverlayError SetOverlayInputMethod(VROverlayHandle_t ulOverlayHandle, VROverlayInputMethod eInputMethod)
Undocumented in source.
- SetOverlayIntersectionMask
EVROverlayError SetOverlayIntersectionMask(VROverlayHandle_t ulOverlayHandle, VROverlayIntersectionMaskPrimitive_t* pMaskPrimitives, uint unNumMaskPrimitives, uint unPrimitiveSize)
Undocumented in source.
- SetOverlayMouseScale
EVROverlayError SetOverlayMouseScale(VROverlayHandle_t ulOverlayHandle, const(HmdVector2_t)* pvecMouseScale)
Undocumented in source.
- SetOverlayName
EVROverlayError SetOverlayName(VROverlayHandle_t ulOverlayHandle, const(char)* pchName)
Undocumented in source.
- SetOverlayRaw
EVROverlayError SetOverlayRaw(VROverlayHandle_t ulOverlayHandle, void* pvBuffer, uint unWidth, uint unHeight, uint unBytesPerPixel)
Undocumented in source.
- SetOverlayRenderingPid
EVROverlayError SetOverlayRenderingPid(VROverlayHandle_t ulOverlayHandle, uint unPID)
Undocumented in source.
- SetOverlaySortOrder
EVROverlayError SetOverlaySortOrder(VROverlayHandle_t ulOverlayHandle, uint unSortOrder)
Sets the rendering sort order for the overlay. Overlays are rendered this order:
Overlays owned by the scene application
Overlays owned by some other application
Within a category overlays are rendered lowest sort order to highest sort order. Overlays with the same
sort order are rendered back to front base on distance from the HMD.
Sort order defaults to 0.
- SetOverlayTexelAspect
EVROverlayError SetOverlayTexelAspect(VROverlayHandle_t ulOverlayHandle, float fTexelAspect)
Undocumented in source.
- SetOverlayTexture
EVROverlayError SetOverlayTexture(VROverlayHandle_t ulOverlayHandle, const(Texture_t)* pTexture)
Texture to draw for the overlay. This function can only be called by the overlay's creator or renderer process (see SetOverlayRenderingPid) .
OpenGL dirty state: glBindTexture
- SetOverlayTextureBounds
EVROverlayError SetOverlayTextureBounds(VROverlayHandle_t ulOverlayHandle, const(VRTextureBounds_t)* pOverlayTextureBounds)
Undocumented in source.
- SetOverlayTextureColorSpace
EVROverlayError SetOverlayTextureColorSpace(VROverlayHandle_t ulOverlayHandle, EColorSpace eTextureColorSpace)
Undocumented in source.
- SetOverlayTransformAbsolute
EVROverlayError SetOverlayTransformAbsolute(VROverlayHandle_t ulOverlayHandle, ETrackingUniverseOrigin eTrackingOrigin, const(HmdMatrix34_t)* pmatTrackingOriginToOverlayTransform)
Undocumented in source.
- SetOverlayTransformCursor
EVROverlayError SetOverlayTransformCursor(VROverlayHandle_t ulCursorOverlayHandle, const(HmdVector2_t)* pvHotspot)
Undocumented in source.
- SetOverlayTransformOverlayRelative
EVROverlayError SetOverlayTransformOverlayRelative(VROverlayHandle_t ulOverlayHandle, VROverlayHandle_t ulOverlayHandleParent, const(HmdMatrix34_t)* pmatParentOverlayToOverlayTransform)
Undocumented in source.
- SetOverlayTransformTrackedDeviceComponent
EVROverlayError SetOverlayTransformTrackedDeviceComponent(VROverlayHandle_t ulOverlayHandle, TrackedDeviceIndex_t unDeviceIndex, const(char)* pchComponentName)
Undocumented in source.
- SetOverlayTransformTrackedDeviceRelative
EVROverlayError SetOverlayTransformTrackedDeviceRelative(VROverlayHandle_t ulOverlayHandle, TrackedDeviceIndex_t unTrackedDevice, const(HmdMatrix34_t)* pmatTrackedDeviceToOverlayTransform)
Undocumented in source.
- SetOverlayWidthInMeters
EVROverlayError SetOverlayWidthInMeters(VROverlayHandle_t ulOverlayHandle, float fWidthInMeters)
Undocumented in source.
- ShowDashboard
void ShowDashboard(const(char)* pchOverlayToShow)
Undocumented in source.
- ShowKeyboard
EVROverlayError ShowKeyboard(EGamepadTextInputMode eInputMode, EGamepadTextInputLineMode eLineInputMode, uint unFlags, const(char)* pchDescription, uint unCharMax, const(char)* pchExistingText, ulong uUserValue)
Undocumented in source.
- ShowKeyboardForOverlay
EVROverlayError ShowKeyboardForOverlay(VROverlayHandle_t ulOverlayHandle, EGamepadTextInputMode eInputMode, EGamepadTextInputLineMode eLineInputMode, uint unFlags, const(char)* pchDescription, uint unCharMax, const(char)* pchExistingText, ulong uUserValue)
Undocumented in source.
- ShowMessageOverlay
VRMessageOverlayResponse ShowMessageOverlay(const(char)* pchText, const(char)* pchCaption, const(char)* pchButton0Text, const(char)* pchButton1Text, const(char)* pchButton2Text, const(char)* pchButton3Text)
Undocumented in source.
- ShowOverlay
EVROverlayError ShowOverlay(VROverlayHandle_t ulOverlayHandle)
Undocumented in source.
- TriggerLaserMouseHapticVibration
EVROverlayError TriggerLaserMouseHapticVibration(VROverlayHandle_t ulOverlayHandle, float fDurationSeconds, float fFrequency, float fAmplitude)
Undocumented in source.