Table of Contents

Class CVROverlay

Namespace
Valve.VR
Assembly
Stride.VirtualReality.dll
public class CVROverlay
Inheritance
CVROverlay

Methods

ClearOverlayCursorPositionOverride(ulong) 

public EVROverlayError ClearOverlayCursorPositionOverride(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

EVROverlayError

ClearOverlayTexture(ulong) 

public EVROverlayError ClearOverlayTexture(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

EVROverlayError

CloseMessageOverlay() 

public void CloseMessageOverlay()

ComputeOverlayIntersection(ulong, ref VROverlayIntersectionParams_t, ref VROverlayIntersectionResults_t) 

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

Parameters

ulOverlayHandle ulong
pParams VROverlayIntersectionParams_t
pResults VROverlayIntersectionResults_t

Returns

bool

CreateDashboardOverlay(string, string, ref ulong, ref ulong) 

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

Parameters

pchOverlayKey string
pchOverlayFriendlyName string
pMainHandle ulong
pThumbnailHandle ulong

Returns

EVROverlayError

CreateOverlay(string, string, ref ulong) 

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

Parameters

pchOverlayKey string
pchOverlayName string
pOverlayHandle ulong

Returns

EVROverlayError

DestroyOverlay(ulong) 

public EVROverlayError DestroyOverlay(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

EVROverlayError

FindOverlay(string, ref ulong) 

public EVROverlayError FindOverlay(string pchOverlayKey, ref ulong pOverlayHandle)

Parameters

pchOverlayKey string
pOverlayHandle ulong

Returns

EVROverlayError

GetDashboardOverlaySceneProcess(ulong, ref uint) 

public EVROverlayError GetDashboardOverlaySceneProcess(ulong ulOverlayHandle, ref uint punProcessId)

Parameters

ulOverlayHandle ulong
punProcessId uint

Returns

EVROverlayError

GetKeyboardText(StringBuilder, uint) 

public uint GetKeyboardText(StringBuilder pchText, uint cchText)

Parameters

pchText StringBuilder
cchText uint

Returns

uint

GetOverlayAlpha(ulong, ref float) 

public EVROverlayError GetOverlayAlpha(ulong ulOverlayHandle, ref float pfAlpha)

Parameters

ulOverlayHandle ulong
pfAlpha float

Returns

EVROverlayError

GetOverlayColor(ulong, ref float, ref float, ref float) 

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

Parameters

ulOverlayHandle ulong
pfRed float
pfGreen float
pfBlue float

Returns

EVROverlayError

GetOverlayCurvature(ulong, ref float) 

public EVROverlayError GetOverlayCurvature(ulong ulOverlayHandle, ref float pfCurvature)

Parameters

ulOverlayHandle ulong
pfCurvature float

Returns

EVROverlayError

GetOverlayErrorNameFromEnum(EVROverlayError) 

public string GetOverlayErrorNameFromEnum(EVROverlayError error)

Parameters

error EVROverlayError

Returns

string

GetOverlayFlag(ulong, VROverlayFlags, ref bool) 

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

Parameters

ulOverlayHandle ulong
eOverlayFlag VROverlayFlags
pbEnabled bool

Returns

EVROverlayError

GetOverlayFlags(ulong, ref uint) 

public EVROverlayError GetOverlayFlags(ulong ulOverlayHandle, ref uint pFlags)

Parameters

ulOverlayHandle ulong
pFlags uint

Returns

EVROverlayError

GetOverlayImageData(ulong, IntPtr, uint, ref uint, ref uint) 

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

Parameters

ulOverlayHandle ulong
pvBuffer IntPtr
unBufferSize uint
punWidth uint
punHeight uint

Returns

EVROverlayError

GetOverlayInputMethod(ulong, ref VROverlayInputMethod) 

public EVROverlayError GetOverlayInputMethod(ulong ulOverlayHandle, ref VROverlayInputMethod peInputMethod)

Parameters

ulOverlayHandle ulong
peInputMethod VROverlayInputMethod

Returns

EVROverlayError

GetOverlayKey(ulong, StringBuilder, uint, ref EVROverlayError) 

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

Parameters

ulOverlayHandle ulong
pchValue StringBuilder
unBufferSize uint
pError EVROverlayError

Returns

uint

GetOverlayMouseScale(ulong, ref HmdVector2_t) 

public EVROverlayError GetOverlayMouseScale(ulong ulOverlayHandle, ref HmdVector2_t pvecMouseScale)

Parameters

ulOverlayHandle ulong
pvecMouseScale HmdVector2_t

Returns

EVROverlayError

GetOverlayName(ulong, StringBuilder, uint, ref EVROverlayError) 

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

Parameters

ulOverlayHandle ulong
pchValue StringBuilder
unBufferSize uint
pError EVROverlayError

Returns

uint

GetOverlayRenderingPid(ulong) 

public uint GetOverlayRenderingPid(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

uint

GetOverlaySortOrder(ulong, ref uint) 

public EVROverlayError GetOverlaySortOrder(ulong ulOverlayHandle, ref uint punSortOrder)

Parameters

ulOverlayHandle ulong
punSortOrder uint

Returns

EVROverlayError

GetOverlayTexelAspect(ulong, ref float) 

public EVROverlayError GetOverlayTexelAspect(ulong ulOverlayHandle, ref float pfTexelAspect)

Parameters

ulOverlayHandle ulong
pfTexelAspect float

Returns

EVROverlayError

GetOverlayTexture(ulong, ref IntPtr, IntPtr, ref uint, ref uint, ref uint, ref ETextureType, ref EColorSpace, ref VRTextureBounds_t) 

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

ulOverlayHandle ulong
pNativeTextureHandle IntPtr
pNativeTextureRef IntPtr
pWidth uint
pHeight uint
pNativeFormat uint
pAPIType ETextureType
pColorSpace EColorSpace
pTextureBounds VRTextureBounds_t

Returns

EVROverlayError

GetOverlayTextureBounds(ulong, ref VRTextureBounds_t) 

public EVROverlayError GetOverlayTextureBounds(ulong ulOverlayHandle, ref VRTextureBounds_t pOverlayTextureBounds)

Parameters

ulOverlayHandle ulong
pOverlayTextureBounds VRTextureBounds_t

Returns

EVROverlayError

GetOverlayTextureColorSpace(ulong, ref EColorSpace) 

public EVROverlayError GetOverlayTextureColorSpace(ulong ulOverlayHandle, ref EColorSpace peTextureColorSpace)

Parameters

ulOverlayHandle ulong
peTextureColorSpace EColorSpace

Returns

EVROverlayError

GetOverlayTextureSize(ulong, ref uint, ref uint) 

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

Parameters

ulOverlayHandle ulong
pWidth uint
pHeight uint

Returns

EVROverlayError

GetOverlayTransformAbsolute(ulong, ref ETrackingUniverseOrigin, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
peTrackingOrigin ETrackingUniverseOrigin
pmatTrackingOriginToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

GetOverlayTransformCursor(ulong, ref HmdVector2_t) 

public EVROverlayError GetOverlayTransformCursor(ulong ulOverlayHandle, ref HmdVector2_t pvHotspot)

Parameters

ulOverlayHandle ulong
pvHotspot HmdVector2_t

Returns

EVROverlayError

GetOverlayTransformOverlayRelative(ulong, ref ulong, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
ulOverlayHandleParent ulong
pmatParentOverlayToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

GetOverlayTransformTrackedDeviceComponent(ulong, ref uint, StringBuilder, uint) 

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

Parameters

ulOverlayHandle ulong
punDeviceIndex uint
pchComponentName StringBuilder
unComponentNameSize uint

Returns

EVROverlayError

GetOverlayTransformTrackedDeviceRelative(ulong, ref uint, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
punTrackedDevice uint
pmatTrackedDeviceToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

GetOverlayTransformType(ulong, ref VROverlayTransformType) 

public EVROverlayError GetOverlayTransformType(ulong ulOverlayHandle, ref VROverlayTransformType peTransformType)

Parameters

ulOverlayHandle ulong
peTransformType VROverlayTransformType

Returns

EVROverlayError

GetOverlayWidthInMeters(ulong, ref float) 

public EVROverlayError GetOverlayWidthInMeters(ulong ulOverlayHandle, ref float pfWidthInMeters)

Parameters

ulOverlayHandle ulong
pfWidthInMeters float

Returns

EVROverlayError

GetPrimaryDashboardDevice() 

public uint GetPrimaryDashboardDevice()

Returns

uint

GetTransformForOverlayCoordinates(ulong, ETrackingUniverseOrigin, HmdVector2_t, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
eTrackingOrigin ETrackingUniverseOrigin
coordinatesInOverlay HmdVector2_t
pmatTransform HmdMatrix34_t

Returns

EVROverlayError

HideKeyboard() 

public void HideKeyboard()

HideOverlay(ulong) 

public EVROverlayError HideOverlay(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

EVROverlayError

IsActiveDashboardOverlay(ulong) 

public bool IsActiveDashboardOverlay(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

bool

IsDashboardVisible() 

public bool IsDashboardVisible()

Returns

bool

IsHoverTargetOverlay(ulong) 

public bool IsHoverTargetOverlay(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

bool

IsOverlayVisible(ulong) 

public bool IsOverlayVisible(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

bool

PollNextOverlayEvent(ulong, ref VREvent_t, uint) 

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

Parameters

ulOverlayHandle ulong
pEvent VREvent_t
uncbVREvent uint

Returns

bool

ReleaseNativeOverlayHandle(ulong, IntPtr) 

public EVROverlayError ReleaseNativeOverlayHandle(ulong ulOverlayHandle, IntPtr pNativeTextureHandle)

Parameters

ulOverlayHandle ulong
pNativeTextureHandle IntPtr

Returns

EVROverlayError

SetDashboardOverlaySceneProcess(ulong, uint) 

public EVROverlayError SetDashboardOverlaySceneProcess(ulong ulOverlayHandle, uint unProcessId)

Parameters

ulOverlayHandle ulong
unProcessId uint

Returns

EVROverlayError

SetKeyboardPositionForOverlay(ulong, HmdRect2_t) 

public void SetKeyboardPositionForOverlay(ulong ulOverlayHandle, HmdRect2_t avoidRect)

Parameters

ulOverlayHandle ulong
avoidRect HmdRect2_t

SetKeyboardTransformAbsolute(ETrackingUniverseOrigin, ref HmdMatrix34_t) 

public void SetKeyboardTransformAbsolute(ETrackingUniverseOrigin eTrackingOrigin, ref HmdMatrix34_t pmatTrackingOriginToKeyboardTransform)

Parameters

eTrackingOrigin ETrackingUniverseOrigin
pmatTrackingOriginToKeyboardTransform HmdMatrix34_t

SetOverlayAlpha(ulong, float) 

public EVROverlayError SetOverlayAlpha(ulong ulOverlayHandle, float fAlpha)

Parameters

ulOverlayHandle ulong
fAlpha float

Returns

EVROverlayError

SetOverlayColor(ulong, float, float, float) 

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

Parameters

ulOverlayHandle ulong
fRed float
fGreen float
fBlue float

Returns

EVROverlayError

SetOverlayCursor(ulong, ulong) 

public EVROverlayError SetOverlayCursor(ulong ulOverlayHandle, ulong ulCursorHandle)

Parameters

ulOverlayHandle ulong
ulCursorHandle ulong

Returns

EVROverlayError

SetOverlayCursorPositionOverride(ulong, ref HmdVector2_t) 

public EVROverlayError SetOverlayCursorPositionOverride(ulong ulOverlayHandle, ref HmdVector2_t pvCursor)

Parameters

ulOverlayHandle ulong
pvCursor HmdVector2_t

Returns

EVROverlayError

SetOverlayCurvature(ulong, float) 

public EVROverlayError SetOverlayCurvature(ulong ulOverlayHandle, float fCurvature)

Parameters

ulOverlayHandle ulong
fCurvature float

Returns

EVROverlayError

SetOverlayFlag(ulong, VROverlayFlags, bool) 

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

Parameters

ulOverlayHandle ulong
eOverlayFlag VROverlayFlags
bEnabled bool

Returns

EVROverlayError

SetOverlayFromFile(ulong, string) 

public EVROverlayError SetOverlayFromFile(ulong ulOverlayHandle, string pchFilePath)

Parameters

ulOverlayHandle ulong
pchFilePath string

Returns

EVROverlayError

SetOverlayInputMethod(ulong, VROverlayInputMethod) 

public EVROverlayError SetOverlayInputMethod(ulong ulOverlayHandle, VROverlayInputMethod eInputMethod)

Parameters

ulOverlayHandle ulong
eInputMethod VROverlayInputMethod

Returns

EVROverlayError

SetOverlayIntersectionMask(ulong, ref VROverlayIntersectionMaskPrimitive_t, uint, uint) 

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

Parameters

ulOverlayHandle ulong
pMaskPrimitives VROverlayIntersectionMaskPrimitive_t
unNumMaskPrimitives uint
unPrimitiveSize uint

Returns

EVROverlayError

SetOverlayMouseScale(ulong, ref HmdVector2_t) 

public EVROverlayError SetOverlayMouseScale(ulong ulOverlayHandle, ref HmdVector2_t pvecMouseScale)

Parameters

ulOverlayHandle ulong
pvecMouseScale HmdVector2_t

Returns

EVROverlayError

SetOverlayName(ulong, string) 

public EVROverlayError SetOverlayName(ulong ulOverlayHandle, string pchName)

Parameters

ulOverlayHandle ulong
pchName string

Returns

EVROverlayError

SetOverlayRaw(ulong, IntPtr, uint, uint, uint) 

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

Parameters

ulOverlayHandle ulong
pvBuffer IntPtr
unWidth uint
unHeight uint
unBytesPerPixel uint

Returns

EVROverlayError

SetOverlayRenderingPid(ulong, uint) 

public EVROverlayError SetOverlayRenderingPid(ulong ulOverlayHandle, uint unPID)

Parameters

ulOverlayHandle ulong
unPID uint

Returns

EVROverlayError

SetOverlaySortOrder(ulong, uint) 

public EVROverlayError SetOverlaySortOrder(ulong ulOverlayHandle, uint unSortOrder)

Parameters

ulOverlayHandle ulong
unSortOrder uint

Returns

EVROverlayError

SetOverlayTexelAspect(ulong, float) 

public EVROverlayError SetOverlayTexelAspect(ulong ulOverlayHandle, float fTexelAspect)

Parameters

ulOverlayHandle ulong
fTexelAspect float

Returns

EVROverlayError

SetOverlayTexture(ulong, ref Texture_t) 

public EVROverlayError SetOverlayTexture(ulong ulOverlayHandle, ref Texture_t pTexture)

Parameters

ulOverlayHandle ulong
pTexture Texture_t

Returns

EVROverlayError

SetOverlayTextureBounds(ulong, ref VRTextureBounds_t) 

public EVROverlayError SetOverlayTextureBounds(ulong ulOverlayHandle, ref VRTextureBounds_t pOverlayTextureBounds)

Parameters

ulOverlayHandle ulong
pOverlayTextureBounds VRTextureBounds_t

Returns

EVROverlayError

SetOverlayTextureColorSpace(ulong, EColorSpace) 

public EVROverlayError SetOverlayTextureColorSpace(ulong ulOverlayHandle, EColorSpace eTextureColorSpace)

Parameters

ulOverlayHandle ulong
eTextureColorSpace EColorSpace

Returns

EVROverlayError

SetOverlayTransformAbsolute(ulong, ETrackingUniverseOrigin, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
eTrackingOrigin ETrackingUniverseOrigin
pmatTrackingOriginToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

SetOverlayTransformCursor(ulong, ref HmdVector2_t) 

public EVROverlayError SetOverlayTransformCursor(ulong ulCursorOverlayHandle, ref HmdVector2_t pvHotspot)

Parameters

ulCursorOverlayHandle ulong
pvHotspot HmdVector2_t

Returns

EVROverlayError

SetOverlayTransformOverlayRelative(ulong, ulong, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
ulOverlayHandleParent ulong
pmatParentOverlayToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

SetOverlayTransformTrackedDeviceComponent(ulong, uint, string) 

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

Parameters

ulOverlayHandle ulong
unDeviceIndex uint
pchComponentName string

Returns

EVROverlayError

SetOverlayTransformTrackedDeviceRelative(ulong, uint, ref HmdMatrix34_t) 

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

Parameters

ulOverlayHandle ulong
unTrackedDevice uint
pmatTrackedDeviceToOverlayTransform HmdMatrix34_t

Returns

EVROverlayError

SetOverlayWidthInMeters(ulong, float) 

public EVROverlayError SetOverlayWidthInMeters(ulong ulOverlayHandle, float fWidthInMeters)

Parameters

ulOverlayHandle ulong
fWidthInMeters float

Returns

EVROverlayError

ShowDashboard(string) 

public void ShowDashboard(string pchOverlayToShow)

Parameters

pchOverlayToShow string

ShowKeyboard(int, int, uint, string, uint, string, ulong) 

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

Parameters

eInputMode int
eLineInputMode int
unFlags uint
pchDescription string
unCharMax uint
pchExistingText string
uUserValue ulong

Returns

EVROverlayError

ShowKeyboardForOverlay(ulong, int, int, uint, string, uint, string, ulong) 

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

Parameters

ulOverlayHandle ulong
eInputMode int
eLineInputMode int
unFlags uint
pchDescription string
unCharMax uint
pchExistingText string
uUserValue ulong

Returns

EVROverlayError

ShowMessageOverlay(string, string, string, string, string, string) 

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

Parameters

pchText string
pchCaption string
pchButton0Text string
pchButton1Text string
pchButton2Text string
pchButton3Text string

Returns

VRMessageOverlayResponse

ShowOverlay(ulong) 

public EVROverlayError ShowOverlay(ulong ulOverlayHandle)

Parameters

ulOverlayHandle ulong

Returns

EVROverlayError

TriggerLaserMouseHapticVibration(ulong, float, float, float) 

public EVROverlayError TriggerLaserMouseHapticVibration(ulong ulOverlayHandle, float fDurationSeconds, float fFrequency, float fAmplitude)

Parameters

ulOverlayHandle ulong
fDurationSeconds float
fFrequency float
fAmplitude float

Returns

EVROverlayError
Edit this page