Class CVROverlay

Inheritance

Object

CVROverlay

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.Toolkit.OpenVR.Headers

Assembly: cs.temp.dll.dll

Syntax

public class CVROverlay

Methods

ClearOverlayTexture(UInt64)

Declaration

public EVROverlayError ClearOverlayTexture(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
EVROverlayError

CloseMessageOverlay()

Declaration

public void CloseMessageOverlay()

ComputeOverlayIntersection(UInt64, ref VROverlayIntersectionParams_t, ref VROverlayIntersectionResults_t)

Declaration

public bool ComputeOverlayIntersection(ulong ulOverlayHandle, ref VROverlayIntersectionParams_t pParams, ref VROverlayIntersectionResults_t pResults)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayIntersectionParams_t	pParams
VROverlayIntersectionResults_t	pResults

Returns

Type	Description
Boolean

CreateDashboardOverlay(String, String, ref UInt64, ref UInt64)

Declaration

public EVROverlayError CreateDashboardOverlay(string pchOverlayKey, string pchOverlayFriendlyName, ref ulong pMainHandle, ref ulong pThumbnailHandle)

Parameters

Type	Name	Description
String	pchOverlayKey
String	pchOverlayFriendlyName
UInt64	pMainHandle
UInt64	pThumbnailHandle

Returns

Type	Description
EVROverlayError

CreateOverlay(String, String, ref UInt64)

Declaration

public EVROverlayError CreateOverlay(string pchOverlayKey, string pchOverlayName, ref ulong pOverlayHandle)

Parameters

Type	Name	Description
String	pchOverlayKey
String	pchOverlayName
UInt64	pOverlayHandle

Returns

Type	Description
EVROverlayError

DestroyOverlay(UInt64)

Declaration

public EVROverlayError DestroyOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
EVROverlayError

FindOverlay(String, ref UInt64)

Declaration

public EVROverlayError FindOverlay(string pchOverlayKey, ref ulong pOverlayHandle)

Parameters

Type	Name	Description
String	pchOverlayKey
UInt64	pOverlayHandle

Returns

Type	Description
EVROverlayError

GetDashboardOverlaySceneProcess(UInt64, ref UInt32)

Declaration

public EVROverlayError GetDashboardOverlaySceneProcess(ulong ulOverlayHandle, ref uint punProcessId)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	punProcessId

Returns

Type	Description
EVROverlayError

GetGamepadFocusOverlay()

Declaration

public ulong GetGamepadFocusOverlay()

Returns

Type	Description
UInt64

GetHighQualityOverlay()

Declaration

public ulong GetHighQualityOverlay()

Returns

Type	Description
UInt64

GetKeyboardText(StringBuilder, UInt32)

Declaration

public uint GetKeyboardText(StringBuilder pchText, uint cchText)

Parameters

Type	Name	Description
StringBuilder	pchText
UInt32	cchText

Returns

Type	Description
UInt32

GetOverlayAlpha(UInt64, ref Single)

Declaration

public EVROverlayError GetOverlayAlpha(ulong ulOverlayHandle, ref float pfAlpha)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	pfAlpha

Returns

Type	Description
EVROverlayError

GetOverlayAutoCurveDistanceRangeInMeters(UInt64, ref Single, ref Single)

Declaration

public EVROverlayError GetOverlayAutoCurveDistanceRangeInMeters(ulong ulOverlayHandle, ref float pfMinDistanceInMeters, ref float pfMaxDistanceInMeters)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	pfMinDistanceInMeters
Single	pfMaxDistanceInMeters

Returns

Type	Description
EVROverlayError

GetOverlayColor(UInt64, ref Single, ref Single, ref Single)

Declaration

public EVROverlayError GetOverlayColor(ulong ulOverlayHandle, ref float pfRed, ref float pfGreen, ref float pfBlue)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	pfRed
Single	pfGreen
Single	pfBlue

Returns

Type	Description
EVROverlayError

GetOverlayDualAnalogTransform(UInt64, EDualAnalogWhich, ref HmdVector2_t, ref Single)

Declaration

public EVROverlayError GetOverlayDualAnalogTransform(ulong ulOverlay, EDualAnalogWhich eWhich, ref HmdVector2_t pvCenter, ref float pfRadius)

Parameters

Type	Name	Description
UInt64	ulOverlay
EDualAnalogWhich	eWhich
HmdVector2_t	pvCenter
Single	pfRadius

Returns

Type	Description
EVROverlayError

GetOverlayErrorNameFromEnum(EVROverlayError)

Declaration

public string GetOverlayErrorNameFromEnum(EVROverlayError error)

Parameters

Type	Name	Description
EVROverlayError	error

Returns

Type	Description
String

GetOverlayFlag(UInt64, VROverlayFlags, ref Boolean)

Declaration

public EVROverlayError GetOverlayFlag(ulong ulOverlayHandle, VROverlayFlags eOverlayFlag, ref bool pbEnabled)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayFlags	eOverlayFlag
Boolean	pbEnabled

Returns

Type	Description
EVROverlayError

GetOverlayFlags(UInt64, ref UInt32)

Declaration

public EVROverlayError GetOverlayFlags(ulong ulOverlayHandle, ref uint pFlags)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	pFlags

Returns

Type	Description
EVROverlayError

GetOverlayImageData(UInt64, IntPtr, UInt32, ref UInt32, ref UInt32)

Declaration

public EVROverlayError GetOverlayImageData(ulong ulOverlayHandle, IntPtr pvBuffer, uint unBufferSize, ref uint punWidth, ref uint punHeight)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
IntPtr	pvBuffer
UInt32	unBufferSize
UInt32	punWidth
UInt32	punHeight

Returns

Type	Description
EVROverlayError

GetOverlayInputMethod(UInt64, ref VROverlayInputMethod)

Declaration

public EVROverlayError GetOverlayInputMethod(ulong ulOverlayHandle, ref VROverlayInputMethod peInputMethod)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayInputMethod	peInputMethod

Returns

Type	Description
EVROverlayError

GetOverlayKey(UInt64, StringBuilder, UInt32, ref EVROverlayError)

Declaration

public uint GetOverlayKey(ulong ulOverlayHandle, StringBuilder pchValue, uint unBufferSize, ref EVROverlayError pError)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
StringBuilder	pchValue
UInt32	unBufferSize
EVROverlayError	pError

Returns

Type	Description
UInt32

GetOverlayMouseScale(UInt64, ref HmdVector2_t)

Declaration

public EVROverlayError GetOverlayMouseScale(ulong ulOverlayHandle, ref HmdVector2_t pvecMouseScale)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
HmdVector2_t	pvecMouseScale

Returns

Type	Description
EVROverlayError

GetOverlayName(UInt64, StringBuilder, UInt32, ref EVROverlayError)

Declaration

public uint GetOverlayName(ulong ulOverlayHandle, StringBuilder pchValue, uint unBufferSize, ref EVROverlayError pError)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
StringBuilder	pchValue
UInt32	unBufferSize
EVROverlayError	pError

Returns

Type	Description
UInt32

GetOverlayRenderingPid(UInt64)

Declaration

public uint GetOverlayRenderingPid(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
UInt32

GetOverlayRenderModel(UInt64, StringBuilder, UInt32, ref HmdColor_t, ref EVROverlayError)

Declaration

public uint GetOverlayRenderModel(ulong ulOverlayHandle, StringBuilder pchValue, uint unBufferSize, ref HmdColor_t pColor, ref EVROverlayError pError)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
StringBuilder	pchValue
UInt32	unBufferSize
HmdColor_t	pColor
EVROverlayError	pError

Returns

Type	Description
UInt32

GetOverlaySortOrder(UInt64, ref UInt32)

Declaration

public EVROverlayError GetOverlaySortOrder(ulong ulOverlayHandle, ref uint punSortOrder)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	punSortOrder

Returns

Type	Description
EVROverlayError

GetOverlayTexelAspect(UInt64, ref Single)

Declaration

public EVROverlayError GetOverlayTexelAspect(ulong ulOverlayHandle, ref float pfTexelAspect)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	pfTexelAspect

Returns

Type	Description
EVROverlayError

GetOverlayTexture(UInt64, ref IntPtr, IntPtr, ref UInt32, ref UInt32, ref UInt32, ref ETextureType, ref EColorSpace, ref VRTextureBounds_t)

Declaration

public EVROverlayError GetOverlayTexture(ulong ulOverlayHandle, ref IntPtr pNativeTextureHandle, IntPtr pNativeTextureRef, ref uint pWidth, ref uint pHeight, ref uint pNativeFormat, ref ETextureType pAPIType, ref EColorSpace pColorSpace, ref VRTextureBounds_t pTextureBounds)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
IntPtr	pNativeTextureHandle
IntPtr	pNativeTextureRef
UInt32	pWidth
UInt32	pHeight
UInt32	pNativeFormat
ETextureType	pAPIType
EColorSpace	pColorSpace
VRTextureBounds_t	pTextureBounds

Returns

Type	Description
EVROverlayError

GetOverlayTextureBounds(UInt64, ref VRTextureBounds_t)

Declaration

public EVROverlayError GetOverlayTextureBounds(ulong ulOverlayHandle, ref VRTextureBounds_t pOverlayTextureBounds)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VRTextureBounds_t	pOverlayTextureBounds

Returns

Type	Description
EVROverlayError

GetOverlayTextureColorSpace(UInt64, ref EColorSpace)

Declaration

public EVROverlayError GetOverlayTextureColorSpace(ulong ulOverlayHandle, ref EColorSpace peTextureColorSpace)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
EColorSpace	peTextureColorSpace

Returns

Type	Description
EVROverlayError

GetOverlayTextureSize(UInt64, ref UInt32, ref UInt32)

Declaration

public EVROverlayError GetOverlayTextureSize(ulong ulOverlayHandle, ref uint pWidth, ref uint pHeight)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	pWidth
UInt32	pHeight

Returns

Type	Description
EVROverlayError

GetOverlayTransformAbsolute(UInt64, ref ETrackingUniverseOrigin, ref HmdMatrix34_t)

Declaration

public EVROverlayError GetOverlayTransformAbsolute(ulong ulOverlayHandle, ref ETrackingUniverseOrigin peTrackingOrigin, ref HmdMatrix34_t pmatTrackingOriginToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
ETrackingUniverseOrigin	peTrackingOrigin
HmdMatrix34_t	pmatTrackingOriginToOverlayTransform

Returns

Type	Description
EVROverlayError

GetOverlayTransformOverlayRelative(UInt64, ref UInt64, ref HmdMatrix34_t)

Declaration

public EVROverlayError GetOverlayTransformOverlayRelative(ulong ulOverlayHandle, ref ulong ulOverlayHandleParent, ref HmdMatrix34_t pmatParentOverlayToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt64	ulOverlayHandleParent
HmdMatrix34_t	pmatParentOverlayToOverlayTransform

Returns

Type	Description
EVROverlayError

GetOverlayTransformTrackedDeviceComponent(UInt64, ref UInt32, StringBuilder, UInt32)

Declaration

public EVROverlayError GetOverlayTransformTrackedDeviceComponent(ulong ulOverlayHandle, ref uint punDeviceIndex, StringBuilder pchComponentName, uint unComponentNameSize)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	punDeviceIndex
StringBuilder	pchComponentName
UInt32	unComponentNameSize

Returns

Type	Description
EVROverlayError

GetOverlayTransformTrackedDeviceRelative(UInt64, ref UInt32, ref HmdMatrix34_t)

Declaration

public EVROverlayError GetOverlayTransformTrackedDeviceRelative(ulong ulOverlayHandle, ref uint punTrackedDevice, ref HmdMatrix34_t pmatTrackedDeviceToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	punTrackedDevice
HmdMatrix34_t	pmatTrackedDeviceToOverlayTransform

Returns

Type	Description
EVROverlayError

GetOverlayTransformType(UInt64, ref VROverlayTransformType)

Declaration

public EVROverlayError GetOverlayTransformType(ulong ulOverlayHandle, ref VROverlayTransformType peTransformType)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayTransformType	peTransformType

Returns

Type	Description
EVROverlayError

GetOverlayWidthInMeters(UInt64, ref Single)

Declaration

public EVROverlayError GetOverlayWidthInMeters(ulong ulOverlayHandle, ref float pfWidthInMeters)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	pfWidthInMeters

Returns

Type	Description
EVROverlayError

GetPrimaryDashboardDevice()

Declaration

public uint GetPrimaryDashboardDevice()

Returns

Type	Description
UInt32

GetTransformForOverlayCoordinates(UInt64, ETrackingUniverseOrigin, HmdVector2_t, ref HmdMatrix34_t)

Declaration

public EVROverlayError GetTransformForOverlayCoordinates(ulong ulOverlayHandle, ETrackingUniverseOrigin eTrackingOrigin, HmdVector2_t coordinatesInOverlay, ref HmdMatrix34_t pmatTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
ETrackingUniverseOrigin	eTrackingOrigin
HmdVector2_t	coordinatesInOverlay
HmdMatrix34_t	pmatTransform

Returns

Type	Description
EVROverlayError

HideKeyboard()

Declaration

public void HideKeyboard()

HideOverlay(UInt64)

Declaration

public EVROverlayError HideOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
EVROverlayError

IsActiveDashboardOverlay(UInt64)

Declaration

public bool IsActiveDashboardOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
Boolean

IsDashboardVisible()

Declaration

public bool IsDashboardVisible()

Returns

Type	Description
Boolean

IsHoverTargetOverlay(UInt64)

Declaration

public bool IsHoverTargetOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
Boolean

IsOverlayVisible(UInt64)

Declaration

public bool IsOverlayVisible(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
Boolean

MoveGamepadFocusToNeighbor(EOverlayDirection, UInt64)

Declaration

public EVROverlayError MoveGamepadFocusToNeighbor(EOverlayDirection eDirection, ulong ulFrom)

Parameters

Type	Name	Description
EOverlayDirection	eDirection
UInt64	ulFrom

Returns

Type	Description
EVROverlayError

PollNextOverlayEvent(UInt64, ref VREvent_t, UInt32)

Declaration

public bool PollNextOverlayEvent(ulong ulOverlayHandle, ref VREvent_t pEvent, uint uncbVREvent)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VREvent_t	pEvent
UInt32	uncbVREvent

Returns

Type	Description
Boolean

ReleaseNativeOverlayHandle(UInt64, IntPtr)

Declaration

public EVROverlayError ReleaseNativeOverlayHandle(ulong ulOverlayHandle, IntPtr pNativeTextureHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
IntPtr	pNativeTextureHandle

Returns

Type	Description
EVROverlayError

SetDashboardOverlaySceneProcess(UInt64, UInt32)

Declaration

public EVROverlayError SetDashboardOverlaySceneProcess(ulong ulOverlayHandle, uint unProcessId)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	unProcessId

Returns

Type	Description
EVROverlayError

SetGamepadFocusOverlay(UInt64)

Declaration

public EVROverlayError SetGamepadFocusOverlay(ulong ulNewFocusOverlay)

Parameters

Type	Name	Description
UInt64	ulNewFocusOverlay

Returns

Type	Description
EVROverlayError

SetHighQualityOverlay(UInt64)

Declaration

public EVROverlayError SetHighQualityOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
EVROverlayError

SetKeyboardPositionForOverlay(UInt64, HmdRect2_t)

Declaration

public void SetKeyboardPositionForOverlay(ulong ulOverlayHandle, HmdRect2_t avoidRect)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
HmdRect2_t	avoidRect

SetKeyboardTransformAbsolute(ETrackingUniverseOrigin, ref HmdMatrix34_t)

Declaration

public void SetKeyboardTransformAbsolute(ETrackingUniverseOrigin eTrackingOrigin, ref HmdMatrix34_t pmatTrackingOriginToKeyboardTransform)

Parameters

Type	Name	Description
ETrackingUniverseOrigin	eTrackingOrigin
HmdMatrix34_t	pmatTrackingOriginToKeyboardTransform

SetOverlayAlpha(UInt64, Single)

Declaration

public EVROverlayError SetOverlayAlpha(ulong ulOverlayHandle, float fAlpha)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	fAlpha

Returns

Type	Description
EVROverlayError

SetOverlayAutoCurveDistanceRangeInMeters(UInt64, Single, Single)

Declaration

public EVROverlayError SetOverlayAutoCurveDistanceRangeInMeters(ulong ulOverlayHandle, float fMinDistanceInMeters, float fMaxDistanceInMeters)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	fMinDistanceInMeters
Single	fMaxDistanceInMeters

Returns

Type	Description
EVROverlayError

SetOverlayColor(UInt64, Single, Single, Single)

Declaration

public EVROverlayError SetOverlayColor(ulong ulOverlayHandle, float fRed, float fGreen, float fBlue)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	fRed
Single	fGreen
Single	fBlue

Returns

Type	Description
EVROverlayError

SetOverlayDualAnalogTransform(UInt64, EDualAnalogWhich, ref HmdVector2_t, Single)

Declaration

public EVROverlayError SetOverlayDualAnalogTransform(ulong ulOverlay, EDualAnalogWhich eWhich, ref HmdVector2_t pvCenter, float fRadius)

Parameters

Type	Name	Description
UInt64	ulOverlay
EDualAnalogWhich	eWhich
HmdVector2_t	pvCenter
Single	fRadius

Returns

Type	Description
EVROverlayError

SetOverlayFlag(UInt64, VROverlayFlags, Boolean)

Declaration

public EVROverlayError SetOverlayFlag(ulong ulOverlayHandle, VROverlayFlags eOverlayFlag, bool bEnabled)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayFlags	eOverlayFlag
Boolean	bEnabled

Returns

Type	Description
EVROverlayError

SetOverlayFromFile(UInt64, String)

Declaration

public EVROverlayError SetOverlayFromFile(ulong ulOverlayHandle, string pchFilePath)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
String	pchFilePath

Returns

Type	Description
EVROverlayError

SetOverlayInputMethod(UInt64, VROverlayInputMethod)

Declaration

public EVROverlayError SetOverlayInputMethod(ulong ulOverlayHandle, VROverlayInputMethod eInputMethod)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayInputMethod	eInputMethod

Returns

Type	Description
EVROverlayError

SetOverlayIntersectionMask(UInt64, ref VROverlayIntersectionMaskPrimitive_t, UInt32, UInt32)

Declaration

public EVROverlayError SetOverlayIntersectionMask(ulong ulOverlayHandle, ref VROverlayIntersectionMaskPrimitive_t pMaskPrimitives, uint unNumMaskPrimitives, uint unPrimitiveSize)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VROverlayIntersectionMaskPrimitive_t	pMaskPrimitives
UInt32	unNumMaskPrimitives
UInt32	unPrimitiveSize

Returns

Type	Description
EVROverlayError

SetOverlayMouseScale(UInt64, ref HmdVector2_t)

Declaration

public EVROverlayError SetOverlayMouseScale(ulong ulOverlayHandle, ref HmdVector2_t pvecMouseScale)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
HmdVector2_t	pvecMouseScale

Returns

Type	Description
EVROverlayError

SetOverlayName(UInt64, String)

Declaration

public EVROverlayError SetOverlayName(ulong ulOverlayHandle, string pchName)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
String	pchName

Returns

Type	Description
EVROverlayError

SetOverlayNeighbor(EOverlayDirection, UInt64, UInt64)

Declaration

public EVROverlayError SetOverlayNeighbor(EOverlayDirection eDirection, ulong ulFrom, ulong ulTo)

Parameters

Type	Name	Description
EOverlayDirection	eDirection
UInt64	ulFrom
UInt64	ulTo

Returns

Type	Description
EVROverlayError

SetOverlayRaw(UInt64, IntPtr, UInt32, UInt32, UInt32)

Declaration

public EVROverlayError SetOverlayRaw(ulong ulOverlayHandle, IntPtr pvBuffer, uint unWidth, uint unHeight, uint unDepth)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
IntPtr	pvBuffer
UInt32	unWidth
UInt32	unHeight
UInt32	unDepth

Returns

Type	Description
EVROverlayError

SetOverlayRenderingPid(UInt64, UInt32)

Declaration

public EVROverlayError SetOverlayRenderingPid(ulong ulOverlayHandle, uint unPID)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	unPID

Returns

Type	Description
EVROverlayError

SetOverlayRenderModel(UInt64, String, ref HmdColor_t)

Declaration

public EVROverlayError SetOverlayRenderModel(ulong ulOverlayHandle, string pchRenderModel, ref HmdColor_t pColor)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
String	pchRenderModel
HmdColor_t	pColor

Returns

Type	Description
EVROverlayError

SetOverlaySortOrder(UInt64, UInt32)

Declaration

public EVROverlayError SetOverlaySortOrder(ulong ulOverlayHandle, uint unSortOrder)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	unSortOrder

Returns

Type	Description
EVROverlayError

SetOverlayTexelAspect(UInt64, Single)

Declaration

public EVROverlayError SetOverlayTexelAspect(ulong ulOverlayHandle, float fTexelAspect)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	fTexelAspect

Returns

Type	Description
EVROverlayError

SetOverlayTexture(UInt64, ref Texture_t)

Declaration

public EVROverlayError SetOverlayTexture(ulong ulOverlayHandle, ref Texture_t pTexture)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Texture_t	pTexture

Returns

Type	Description
EVROverlayError

SetOverlayTextureBounds(UInt64, ref VRTextureBounds_t)

Declaration

public EVROverlayError SetOverlayTextureBounds(ulong ulOverlayHandle, ref VRTextureBounds_t pOverlayTextureBounds)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
VRTextureBounds_t	pOverlayTextureBounds

Returns

Type	Description
EVROverlayError

SetOverlayTextureColorSpace(UInt64, EColorSpace)

Declaration

public EVROverlayError SetOverlayTextureColorSpace(ulong ulOverlayHandle, EColorSpace eTextureColorSpace)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
EColorSpace	eTextureColorSpace

Returns

Type	Description
EVROverlayError

SetOverlayTransformAbsolute(UInt64, ETrackingUniverseOrigin, ref HmdMatrix34_t)

Declaration

public EVROverlayError SetOverlayTransformAbsolute(ulong ulOverlayHandle, ETrackingUniverseOrigin eTrackingOrigin, ref HmdMatrix34_t pmatTrackingOriginToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
ETrackingUniverseOrigin	eTrackingOrigin
HmdMatrix34_t	pmatTrackingOriginToOverlayTransform

Returns

Type	Description
EVROverlayError

SetOverlayTransformOverlayRelative(UInt64, UInt64, ref HmdMatrix34_t)

Declaration

public EVROverlayError SetOverlayTransformOverlayRelative(ulong ulOverlayHandle, ulong ulOverlayHandleParent, ref HmdMatrix34_t pmatParentOverlayToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt64	ulOverlayHandleParent
HmdMatrix34_t	pmatParentOverlayToOverlayTransform

Returns

Type	Description
EVROverlayError

SetOverlayTransformTrackedDeviceComponent(UInt64, UInt32, String)

Declaration

public EVROverlayError SetOverlayTransformTrackedDeviceComponent(ulong ulOverlayHandle, uint unDeviceIndex, string pchComponentName)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	unDeviceIndex
String	pchComponentName

Returns

Type	Description
EVROverlayError

SetOverlayTransformTrackedDeviceRelative(UInt64, UInt32, ref HmdMatrix34_t)

Declaration

public EVROverlayError SetOverlayTransformTrackedDeviceRelative(ulong ulOverlayHandle, uint unTrackedDevice, ref HmdMatrix34_t pmatTrackedDeviceToOverlayTransform)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
UInt32	unTrackedDevice
HmdMatrix34_t	pmatTrackedDeviceToOverlayTransform

Returns

Type	Description
EVROverlayError

SetOverlayWidthInMeters(UInt64, Single)

Declaration

public EVROverlayError SetOverlayWidthInMeters(ulong ulOverlayHandle, float fWidthInMeters)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Single	fWidthInMeters

Returns

Type	Description
EVROverlayError

ShowDashboard(String)

Declaration

public void ShowDashboard(string pchOverlayToShow)

Parameters

Type	Name	Description
String	pchOverlayToShow

ShowKeyboard(Int32, Int32, String, UInt32, String, Boolean, UInt64)

Declaration

public EVROverlayError ShowKeyboard(int eInputMode, int eLineInputMode, string pchDescription, uint unCharMax, string pchExistingText, bool bUseMinimalMode, ulong uUserValue)

Parameters

Type	Name	Description
Int32	eInputMode
Int32	eLineInputMode
String	pchDescription
UInt32	unCharMax
String	pchExistingText
Boolean	bUseMinimalMode
UInt64	uUserValue

Returns

Type	Description
EVROverlayError

ShowKeyboardForOverlay(UInt64, Int32, Int32, String, UInt32, String, Boolean, UInt64)

Declaration

public EVROverlayError ShowKeyboardForOverlay(ulong ulOverlayHandle, int eInputMode, int eLineInputMode, string pchDescription, uint unCharMax, string pchExistingText, bool bUseMinimalMode, ulong uUserValue)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle
Int32	eInputMode
Int32	eLineInputMode
String	pchDescription
UInt32	unCharMax
String	pchExistingText
Boolean	bUseMinimalMode
UInt64	uUserValue

Returns

Type	Description
EVROverlayError

ShowMessageOverlay(String, String, String, String, String, String)

Declaration

public VRMessageOverlayResponse ShowMessageOverlay(string pchText, string pchCaption, string pchButton0Text, string pchButton1Text, string pchButton2Text, string pchButton3Text)

Parameters

Type	Name	Description
String	pchText
String	pchCaption
String	pchButton0Text
String	pchButton1Text
String	pchButton2Text
String	pchButton3Text

Returns

Type	Description
VRMessageOverlayResponse

ShowOverlay(UInt64)

Declaration

public EVROverlayError ShowOverlay(ulong ulOverlayHandle)

Parameters

Type	Name	Description
UInt64	ulOverlayHandle

Returns

Type	Description
EVROverlayError