Top Description Constructors Methods
org.lwjgl.openvr

public Class VROverlay

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Overlay management methods.

Constructor Summary

AccessConstructor and Description
protected
VROverlay()

Method Summary

Modifier and TypeMethod and Description
public static boolean
nVROverlay_ComputeOverlayIntersection(long ulOverlayHandle, long pParams, long pResults)

Unsafe version of: ComputeOverlayIntersection

public static int
nVROverlay_CreateDashboardOverlay(long pchOverlayKey, long pchOverlayFriendlyName, long pMainHandle, long pThumbnailHandle)

Unsafe version of: CreateDashboardOverlay

public static int
nVROverlay_CreateOverlay(long pchOverlayKey, long pchOverlayName, long pOverlayHandle)

Unsafe version of: CreateOverlay

public static int
nVROverlay_FindOverlay(long pchOverlayKey, long pOverlayHandle)

Unsafe version of: FindOverlay

public static int
nVROverlay_GetDashboardOverlaySceneProcess(long ulOverlayHandle, long punProcessId)

Unsafe version of: GetDashboardOverlaySceneProcess

public static int
nVROverlay_GetKeyboardText(long pchText, int cchText)

Unsafe version of: GetKeyboardText

public static int
nVROverlay_GetOverlayAlpha(long ulOverlayHandle, long pfAlpha)

Unsafe version of: GetOverlayAlpha

public static int
nVROverlay_GetOverlayColor(long ulOverlayHandle, long pfRed, long pfGreen, long pfBlue)

Unsafe version of: GetOverlayColor

public static int
nVROverlay_GetOverlayCurvature(long ulOverlayHandle, long pfCurvature)

Unsafe version of: GetOverlayCurvature

public static long
nVROverlay_GetOverlayErrorNameFromEnum(int error)

Unsafe version of: GetOverlayErrorNameFromEnum

public static int
nVROverlay_GetOverlayFlag(long ulOverlayHandle, int eOverlayFlag, long pbEnabled)

Unsafe version of: GetOverlayFlag

public static int
nVROverlay_GetOverlayFlags(long ulOverlayHandle, long pFlags)

Unsafe version of: GetOverlayFlags

public static int
nVROverlay_GetOverlayImageData(long ulOverlayHandle, long pvBuffer, int unBufferSize, long punWidth, long punHeight)

Unsafe version of: GetOverlayImageData

public static int
nVROverlay_GetOverlayInputMethod(long ulOverlayHandle, long peInputMethod)

Unsafe version of: GetOverlayInputMethod

public static int
nVROverlay_GetOverlayKey(long ulOverlayHandle, long pchValue, int unBufferSize, long pError)

Unsafe version of: GetOverlayKey

public static int
nVROverlay_GetOverlayMouseScale(long ulOverlayHandle, long pvecMouseScale)

Unsafe version of: GetOverlayMouseScale

public static int
nVROverlay_GetOverlayName(long ulOverlayHandle, long pchValue, int unBufferSize, long pError)

Unsafe version of: GetOverlayName

public static int
nVROverlay_GetOverlayPreCurvePitch(long ulOverlayHandle, long pfRadians)

public static int
nVROverlay_GetOverlaySortOrder(long ulOverlayHandle, long punSortOrder)

Unsafe version of: GetOverlaySortOrder

public static int
nVROverlay_GetOverlayTexelAspect(long ulOverlayHandle, long pfTexelAspect)

Unsafe version of: GetOverlayTexelAspect

public static int
nVROverlay_GetOverlayTexture(long ulOverlayHandle, long pNativeTextureHandle, long pNativeTextureRef, long pWidth, long pHeight, long pNativeFormat, long pAPIType, long pColorSpace, long pTextureBounds)

Unsafe version of: GetOverlayTexture

public static int
nVROverlay_GetOverlayTextureBounds(long ulOverlayHandle, long pOverlayTextureBounds)

Unsafe version of: GetOverlayTextureBounds

public static int
nVROverlay_GetOverlayTextureColorSpace(long ulOverlayHandle, long peTextureColorSpace)

Unsafe version of: GetOverlayTextureColorSpace

public static int
nVROverlay_GetOverlayTextureSize(long ulOverlayHandle, long pWidth, long pHeight)

Unsafe version of: GetOverlayTextureSize

public static int
nVROverlay_GetOverlayTransformAbsolute(long ulOverlayHandle, long peTrackingOrigin, long pmatTrackingOriginToOverlayTransform)

Unsafe version of: GetOverlayTransformAbsolute

public static int
nVROverlay_GetOverlayTransformCursor(long ulOverlayHandle, long pvHotspot)

Unsafe version of: GetOverlayTransformCursor

public static int
nVROverlay_GetOverlayTransformTrackedDeviceComponent(long ulOverlayHandle, long punDeviceIndex, long pchComponentName, int unComponentNameSize)

Unsafe version of: GetOverlayTransformTrackedDeviceComponent

public static int
nVROverlay_GetOverlayTransformTrackedDeviceRelative(long ulOverlayHandle, long punTrackedDevice, long pmatTrackedDeviceToOverlayTransform)

Unsafe version of: GetOverlayTransformTrackedDeviceRelative

public static int
nVROverlay_GetOverlayTransformType(long ulOverlayHandle, long peTransformType)

Unsafe version of: GetOverlayTransformType

public static int
nVROverlay_GetOverlayWidthInMeters(long ulOverlayHandle, long pfWidthInMeters)

Unsafe version of: GetOverlayWidthInMeters

public static native int
nVROverlay_GetTransformForOverlayCoordinates(long ulOverlayHandle, int eTrackingOrigin, long coordinatesInOverlay, long pmatTransform, long __functionAddress)

Unsafe version of: GetTransformForOverlayCoordinates

public static int
nVROverlay_GetTransformForOverlayCoordinates(long ulOverlayHandle, int eTrackingOrigin, long coordinatesInOverlay, long pmatTransform)

Unsafe version of: GetTransformForOverlayCoordinates

public static boolean
nVROverlay_PollNextOverlayEvent(long ulOverlayHandle, long pEvent, int uncbVREvent)

Unsafe version of: PollNextOverlayEvent

public static native void
nVROverlay_SetKeyboardPositionForOverlay(long ulOverlayHandle, long avoidRect, long __functionAddress)

Unsafe version of: SetKeyboardPositionForOverlay

public static void
nVROverlay_SetKeyboardPositionForOverlay(long ulOverlayHandle, long avoidRect)

Unsafe version of: SetKeyboardPositionForOverlay

public static void
nVROverlay_SetKeyboardTransformAbsolute(int eTrackingOrigin, long pmatTrackingOriginToKeyboardTransform)

Unsafe version of: SetKeyboardTransformAbsolute

public static int
nVROverlay_SetOverlayCursorPositionOverride(long ulOverlayHandle, long pvCursor)

Unsafe version of: SetOverlayCursorPositionOverride

public static int
nVROverlay_SetOverlayFromFile(long ulOverlayHandle, long pchFilePath)

Unsafe version of: SetOverlayFromFile

public static int
nVROverlay_SetOverlayIntersectionMask(long ulOverlayHandle, long pMaskPrimitives, int unNumMaskPrimitives, int unPrimitiveSize)

Unsafe version of: SetOverlayIntersectionMask

public static int
nVROverlay_SetOverlayMouseScale(long ulOverlayHandle, long pvecMouseScale)

Unsafe version of: SetOverlayMouseScale

public static int
nVROverlay_SetOverlayName(long ulOverlayHandle, long pchName)

Unsafe version of: SetOverlayName

public static int
nVROverlay_SetOverlayRaw(long ulOverlayHandle, long pvBuffer, int unWidth, int unHeight, int unBytesPerPixel)

Unsafe version of: SetOverlayRaw

public static int
nVROverlay_SetOverlayTexture(long ulOverlayHandle, long pTexture)

Unsafe version of: SetOverlayTexture

public static int
nVROverlay_SetOverlayTextureBounds(long ulOverlayHandle, long pOverlayTextureBounds)

Unsafe version of: SetOverlayTextureBounds

public static int
nVROverlay_SetOverlayTransformAbsolute(long ulOverlayHandle, int eTrackingOrigin, long pmatTrackingOriginToOverlayTransform)

Unsafe version of: SetOverlayTransformAbsolute

public static int
nVROverlay_SetOverlayTransformCursor(long ulCursorOverlayHandle, long pvHotspot)

Unsafe version of: SetOverlayTransformCursor

public static int
nVROverlay_SetOverlayTransformProjection(long ulOverlayHandle, int eTrackingOrigin, long pmatTrackingOriginToOverlayTransform, long pProjection, int eEye)

Unsafe version of: SetOverlayTransformProjection

public static int
nVROverlay_SetOverlayTransformTrackedDeviceComponent(long ulOverlayHandle, int unDeviceIndex, long pchComponentName)

Unsafe version of: SetOverlayTransformTrackedDeviceComponent

public static int
nVROverlay_SetOverlayTransformTrackedDeviceRelative(long ulOverlayHandle, int unTrackedDevice, long pmatTrackedDeviceToOverlayTransform)

Unsafe version of: SetOverlayTransformTrackedDeviceRelative

public static void
nVROverlay_ShowDashboard(long pchOverlayToShow)

Unsafe version of: ShowDashboard

public static int
nVROverlay_ShowKeyboard(int eInputMode, int eLineInputMode, int unFlags, long pchDescription, int unCharMax, long pchExistingText, boolean bUseMinimalMode, long uUserValue)

Unsafe version of: ShowKeyboard

public static int
nVROverlay_ShowKeyboardForOverlay(long ulOverlayHandle, int eInputMode, int eLineInputMode, int unFlags, long pchDescription, int unCharMax, long pchExistingText, boolean bUseMinimalMode, long uUserValue)

Unsafe version of: ShowKeyboardForOverlay

public static int
nVROverlay_ShowMessageOverlay(long pchText, long pchCaption, long pchButton0Text, long pchButton1Text, long pchButton2Text, long pchButton3Text)

Unsafe version of: ShowMessageOverlay

public static int
VROverlay_ClearOverlayCursorPositionOverride(long ulOverlayHandle)

Clears the override cursor position for this overlay.

public static int
VROverlay_ClearOverlayTexture(long ulOverlayHandle)

Use this to tell the overlay system to release the texture set for this overlay.

public static void
VROverlay_CloseMessageOverlay()

If the calling process owns the overlay and it's open, this will close it.

public static boolean
VROverlay_ComputeOverlayIntersection(long ulOverlayHandle, VROverlayIntersectionParams pParams, VROverlayIntersectionResults pResults)

Computes the overlay-space pixel coordinates of where the ray intersects the overlay with the specified settings.

public static int
VROverlay_CreateDashboardOverlay(ByteBuffer pchOverlayKey, ByteBuffer pchOverlayFriendlyName, LongBuffer pMainHandle, LongBuffer pThumbnailHandle)

Creates a dashboard overlay and returns its handle.

public static int
VROverlay_CreateDashboardOverlay(CharSequence pchOverlayKey, CharSequence pchOverlayFriendlyName, LongBuffer pMainHandle, LongBuffer pThumbnailHandle)

Creates a dashboard overlay and returns its handle.

public static int
VROverlay_CreateOverlay(ByteBuffer pchOverlayKey, ByteBuffer pchOverlayName, LongBuffer pOverlayHandle)

Creates a new named overlay.

public static int
VROverlay_CreateOverlay(CharSequence pchOverlayKey, CharSequence pchOverlayName, LongBuffer pOverlayHandle)

Creates a new named overlay.

public static int
VROverlay_DestroyOverlay(long ulOverlayHandle)

Destroys the specified overlay.

public static int
VROverlay_FindOverlay(ByteBuffer pchOverlayKey, LongBuffer pOverlayHandle)

Finds an existing overlay with the specified key.

public static int
VROverlay_FindOverlay(CharSequence pchOverlayKey, LongBuffer pOverlayHandle)

Finds an existing overlay with the specified key.

public static int
VROverlay_GetDashboardOverlaySceneProcess(long ulOverlayHandle, IntBuffer punProcessId)

Gets the process ID that this dashboard overlay requires to have scene focus.

public static int
VROverlay_GetKeyboardText(ByteBuffer pchText)

Get the text that was entered into the text input.

public static String
VROverlay_GetKeyboardText(int cchText)

Get the text that was entered into the text input.

public static int
VROverlay_GetOverlayAlpha(long ulOverlayHandle, FloatBuffer pfAlpha)

Gets the alpha of the overlay quad.

public static int
VROverlay_GetOverlayColor(long ulOverlayHandle, FloatBuffer pfRed, FloatBuffer pfGreen, FloatBuffer pfBlue)

Gets the color tint of the overlay quad.

public static int
VROverlay_GetOverlayCurvature(long ulOverlayHandle, FloatBuffer pfCurvature)

Returns the curvature of the overlay as a percentage from (0..1] where 1 is a fully closed cylinder.

public static String
VROverlay_GetOverlayErrorNameFromEnum(int
one of:
VR#EVROverlayError_VROverlayError_None
VR#EVROverlayError_VROverlayError_UnknownOverlay
VR#EVROverlayError_VROverlayError_InvalidHandle
VR#EVROverlayError_VROverlayError_PermissionDenied
VR#EVROverlayError_VROverlayError_OverlayLimitExceeded
VR#EVROverlayError_VROverlayError_WrongVisibilityType
VR#EVROverlayError_VROverlayError_KeyTooLong
VR#EVROverlayError_VROverlayError_NameTooLong
VR#EVROverlayError_VROverlayError_KeyInUse
VR#EVROverlayError_VROverlayError_WrongTransformType
VR#EVROverlayError_VROverlayError_InvalidTrackedDevice
VR#EVROverlayError_VROverlayError_InvalidParameter
VR#EVROverlayError_VROverlayError_ThumbnailCantBeDestroyed
VR#EVROverlayError_VROverlayError_ArrayTooSmall
VR#EVROverlayError_VROverlayError_RequestFailed
VR#EVROverlayError_VROverlayError_InvalidTexture
VR#EVROverlayError_VROverlayError_UnableToLoadFile
VR#EVROverlayError_VROverlayError_KeyboardAlreadyInUse
VR#EVROverlayError_VROverlayError_NoNeighbor
VR#EVROverlayError_VROverlayError_TooManyMaskPrimitives
VR#EVROverlayError_VROverlayError_BadMaskPrimitive
VR#EVROverlayError_VROverlayError_TextureAlreadyLocked
VR#EVROverlayError_VROverlayError_TextureLockCapacityReached
VR#EVROverlayError_VROverlayError_TextureNotLocked
VR#EVROverlayError_VROverlayError_TimedOut
error)

Returns a string that corresponds with the specified overlay error.

public static int
VROverlay_GetOverlayFlag(long ulOverlayHandle, int
one of:
VR#VROverlayFlags_NoDashboardTabVR#VROverlayFlags_SendVRDiscreteScrollEvents
VR#VROverlayFlags_SendVRTouchpadEventsVR#VROverlayFlags_ShowTouchPadScrollWheel
VR#VROverlayFlags_TransferOwnershipToInternalProcessVR#VROverlayFlags_SideBySide_Parallel
VR#VROverlayFlags_SideBySide_CrossedVR#VROverlayFlags_Panorama
VR#VROverlayFlags_StereoPanoramaVR#VROverlayFlags_SortWithNonSceneOverlays
VR#VROverlayFlags_VisibleInDashboardVR#VROverlayFlags_MakeOverlaysInteractiveIfVisible
VR#VROverlayFlags_SendVRSmoothScrollEventsVR#VROverlayFlags_ProtectedContent
VR#VROverlayFlags_HideLaserIntersectionVR#VROverlayFlags_WantsModalBehavior
VR#VROverlayFlags_IsPremultipliedVR#VROverlayFlags_IgnoreTextureAlpha
VR#VROverlayFlags_Reserved
eOverlayFlag, ByteBuffer pbEnabled)

Gets flag setting for a given overlay.

public static int
VROverlay_GetOverlayFlags(long ulOverlayHandle, IntBuffer pFlags)

Gets all the flags for a given overlay.

public static int
VROverlay_GetOverlayImageData(long ulOverlayHandle, ByteBuffer pvBuffer, IntBuffer punWidth, IntBuffer punHeight)

Gets the raw image data from an overlay.

public static int
VROverlay_GetOverlayInputMethod(long ulOverlayHandle, IntBuffer peInputMethod)

Returns the current input settings for the specified overlay.

public static int
VROverlay_GetOverlayKey(long ulOverlayHandle, ByteBuffer pchValue, IntBuffer pError)

Fills the provided buffer with the string key of the overlay.

public static String
VROverlay_GetOverlayKey(long ulOverlayHandle, int unBufferSize, IntBuffer pError)

Fills the provided buffer with the string key of the overlay.

public static int
VROverlay_GetOverlayMouseScale(long ulOverlayHandle, HmdVector2 pvecMouseScale)

Gets the mouse scaling factor that is used for mouse events.

public static int
VROverlay_GetOverlayName(long ulOverlayHandle, ByteBuffer pchValue, IntBuffer pError)

Fills the provided buffer with the friendly name of the overlay.

public static String
VROverlay_GetOverlayName(long ulOverlayHandle, int unBufferSize, IntBuffer pError)

Fills the provided buffer with the friendly name of the overlay.

public static int
VROverlay_GetOverlayPreCurvePitch(long ulOverlayHandle, FloatBuffer pfRadians)

public static int
VROverlay_GetOverlayRenderingPid(long ulOverlayHandle)

Gets the pid that is allowed to render to this overlay.

public static int
VROverlay_GetOverlaySortOrder(long ulOverlayHandle, IntBuffer punSortOrder)

Gets the sort order of the overlay.

public static int
VROverlay_GetOverlayTexelAspect(long ulOverlayHandle, FloatBuffer pfTexelAspect)

Gets the aspect ratio of the texels in the overlay.

public static int
VROverlay_GetOverlayTexture(long ulOverlayHandle, PointerBuffer pNativeTextureHandle, long pNativeTextureRef, IntBuffer pWidth, IntBuffer pHeight, IntBuffer pNativeFormat, IntBuffer pAPIType, IntBuffer pColorSpace, VRTextureBounds pTextureBounds)

Get the native texture handle/device for an overlay you have created.

public static int
VROverlay_GetOverlayTextureBounds(long ulOverlayHandle, VRTextureBounds pOverlayTextureBounds)

Gets the part of the texture to use for the overlay.

public static int
VROverlay_GetOverlayTextureColorSpace(long ulOverlayHandle, IntBuffer peTextureColorSpace)

Gets the overlay's current colorspace setting.

public static int
VROverlay_GetOverlayTextureSize(long ulOverlayHandle, IntBuffer pWidth, IntBuffer pHeight)

Get the size of the overlay texture.

public static int
VROverlay_GetOverlayTransformAbsolute(long ulOverlayHandle, IntBuffer peTrackingOrigin, HmdMatrix34 pmatTrackingOriginToOverlayTransform)

Gets the transform if it is absolute.

public static int
VROverlay_GetOverlayTransformCursor(long ulOverlayHandle, HmdVector2 pvHotspot)

Gets cursor hotspot/transform for the specified overlay.

public static int
VROverlay_GetOverlayTransformTrackedDeviceComponent(long ulOverlayHandle, IntBuffer punDeviceIndex, ByteBuffer pchComponentName)

Gets the transform information when the overlay is rendering on a component.

public static int
VROverlay_GetOverlayTransformTrackedDeviceRelative(long ulOverlayHandle, IntBuffer punTrackedDevice, HmdMatrix34 pmatTrackedDeviceToOverlayTransform)

Gets the transform if it is relative to a tracked device.

public static int
VROverlay_GetOverlayTransformType(long ulOverlayHandle, IntBuffer peTransformType)

Returns the transform type of this overlay.

public static int
VROverlay_GetOverlayWidthInMeters(long ulOverlayHandle, FloatBuffer pfWidthInMeters)

Returns the width of the overlay quad in meters.

public static int
VROverlay_GetPrimaryDashboardDevice()

Returns the tracked device that has the laser pointer in the dashboard.

public static int
VROverlay_GetTransformForOverlayCoordinates(long ulOverlayHandle, int
one of:
VR#ETrackingUniverseOrigin_TrackingUniverseSeated
VR#ETrackingUniverseOrigin_TrackingUniverseStanding
VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
eTrackingOrigin, HmdVector2 coordinatesInOverlay, HmdMatrix34 pmatTransform)

Get the transform in 3d space associated with a specific 2d point in the overlay's coordinate space (where 0,0 is the lower left).

public static void
VROverlay_HideKeyboard()

Hide the virtual keyboard.

public static int
VROverlay_HideOverlay(long ulOverlayHandle)

Hides the VR overlay.

public static boolean
VROverlay_IsActiveDashboardOverlay(long ulOverlayHandle)

Returns true if the dashboard is visible and the specified overlay is the active system Overlay.

public static boolean
VROverlay_IsDashboardVisible()

Returns true if the dashboard is visible.

public static boolean
VROverlay_IsHoverTargetOverlay(long ulOverlayHandle)

Returns true if the specified overlay is the hover target.

public static boolean
VROverlay_IsOverlayVisible(long ulOverlayHandle)

Returns true if the overlay is visible.

public static boolean
VROverlay_PollNextOverlayEvent(long ulOverlayHandle, VREvent pEvent, int uncbVREvent)

Returns true and fills the event with the next event on the overlay's event queue, if there is one.

public static boolean
VROverlay_PollNextOverlayEvent(long ulOverlayHandle, VREvent pEvent)

Returns true and fills the event with the next event on the overlay's event queue, if there is one.

public static int
VROverlay_ReleaseNativeOverlayHandle(long ulOverlayHandle, long pNativeTextureHandle)

Release the pNativeTextureHandle provided from the GetOverlayTexture call, this allows the system to free the underlying GPU resources for this object, so only do it once you stop rendering this texture.

public static int
VROverlay_SetDashboardOverlaySceneProcess(long ulOverlayHandle, int unProcessId)

Sets the dashboard overlay to only appear when the specified process ID has scene focus.

public static void
VROverlay_SetKeyboardPositionForOverlay(long ulOverlayHandle, HmdRect2 avoidRect)

Set the position of the keyboard in overlay space by telling it to avoid a rectangle in the overlay.

public static void
VROverlay_SetKeyboardTransformAbsolute(int
one of:
VR#ETrackingUniverseOrigin_TrackingUniverseSeated
VR#ETrackingUniverseOrigin_TrackingUniverseStanding
VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
eTrackingOrigin, HmdMatrix34 pmatTrackingOriginToKeyboardTransform)

Set the position of the keyboard in world space.

public static int
VROverlay_SetOverlayAlpha(long ulOverlayHandle, float fAlpha)

Sets the alpha of the overlay quad.

public static int
VROverlay_SetOverlayColor(long ulOverlayHandle, float fRed, float fGreen, float fBlue)

Sets the color tint of the overlay quad.

public static int
VROverlay_SetOverlayCursor(long ulOverlayHandle, long ulCursorHandle)

Sets the cursor to use for the specified overlay.

public static int
VROverlay_SetOverlayCursorPositionOverride(long ulOverlayHandle, HmdVector2 pvCursor)

Sets the override cursor position to use for this overlay in overlay mouse coordinates.

public static int
VROverlay_SetOverlayCurvature(long ulOverlayHandle, float fCurvature)

Use to draw overlay as a curved surface.

public static int
VROverlay_SetOverlayFlag(long ulOverlayHandle, int
one of:
VR#VROverlayFlags_NoDashboardTabVR#VROverlayFlags_SendVRDiscreteScrollEvents
VR#VROverlayFlags_SendVRTouchpadEventsVR#VROverlayFlags_ShowTouchPadScrollWheel
VR#VROverlayFlags_TransferOwnershipToInternalProcessVR#VROverlayFlags_SideBySide_Parallel
VR#VROverlayFlags_SideBySide_CrossedVR#VROverlayFlags_Panorama
VR#VROverlayFlags_StereoPanoramaVR#VROverlayFlags_SortWithNonSceneOverlays
VR#VROverlayFlags_VisibleInDashboardVR#VROverlayFlags_MakeOverlaysInteractiveIfVisible
VR#VROverlayFlags_SendVRSmoothScrollEventsVR#VROverlayFlags_ProtectedContent
VR#VROverlayFlags_HideLaserIntersectionVR#VROverlayFlags_WantsModalBehavior
VR#VROverlayFlags_IsPremultipliedVR#VROverlayFlags_IgnoreTextureAlpha
VR#VROverlayFlags_Reserved
eOverlayFlag, boolean bEnabled)

Specify flag setting for a given overlay.

public static int
VROverlay_SetOverlayFromFile(long ulOverlayHandle, ByteBuffer pchFilePath)

Separate interface for providing the image through a filename: can be png or jpg, and should not be bigger than 1920x1080.

public static int
VROverlay_SetOverlayFromFile(long ulOverlayHandle, CharSequence pchFilePath)

Separate interface for providing the image through a filename: can be png or jpg, and should not be bigger than 1920x1080.

public static int
VROverlay_SetOverlayInputMethod(long ulOverlayHandle, int
one of:
VR#VROverlayInputMethod_NoneVR#VROverlayInputMethod_Mouse
eInputMethod)

Sets the input settings for the specified overlay.

public static int
VROverlay_SetOverlayIntersectionMask(long ulOverlayHandle, VROverlayIntersectionMaskPrimitive.Buffer pMaskPrimitives)

Sets a list of primitives to be used for controller ray intersection typically the size of the underlying UI in pixels (not in world space).

public static int
VROverlay_SetOverlayMouseScale(long ulOverlayHandle, HmdVector2 pvecMouseScale)

Sets the mouse scaling factor that is used for mouse events.

public static int
VROverlay_SetOverlayName(long ulOverlayHandle, ByteBuffer pchName)

Sets the name to use for this overlay.

public static int
VROverlay_SetOverlayName(long ulOverlayHandle, CharSequence pchName)

Sets the name to use for this overlay.

public static int
VROverlay_SetOverlayPreCurvePitch(long ulOverlayHandle, float fRadians)

public static int
VROverlay_SetOverlayRaw(long ulOverlayHandle, ByteBuffer pvBuffer, int unWidth, int unHeight, int unBytesPerPixel)

Separate interface for providing the data as a stream of bytes, but there is an upper bound on data that can be sent.

public static int
VROverlay_SetOverlayRenderingPid(long ulOverlayHandle, int unPID)

Sets the pid that is allowed to render to this overlay (the creator pid is always allow to render), by default this is the pid of the process that made the overlay.

public static int
VROverlay_SetOverlaySortOrder(long ulOverlayHandle, int unSortOrder)

Sets the rendering sort order for the overlay.

public static int
VROverlay_SetOverlayTexelAspect(long ulOverlayHandle, float fTexelAspect)

Sets the aspect ratio of the texels in the overlay.

public static int
VROverlay_SetOverlayTexture(long ulOverlayHandle, Texture pTexture)

Texture to draw for the overlay.

public static int
VROverlay_SetOverlayTextureBounds(long ulOverlayHandle, VRTextureBounds pOverlayTextureBounds)

Sets the part of the texture to use for the overlay.

public static int
VROverlay_SetOverlayTextureColorSpace(long ulOverlayHandle, int
one of:
VR#EColorSpace_ColorSpace_AutoVR#EColorSpace_ColorSpace_Gamma
VR#EColorSpace_ColorSpace_Linear
eTextureColorSpace)

Sets the colorspace the overlay texture's data is in. Defaults to 'auto'.

public static int
VROverlay_SetOverlayTransformAbsolute(long ulOverlayHandle, int
one of:
VR#ETrackingUniverseOrigin_TrackingUniverseSeated
VR#ETrackingUniverseOrigin_TrackingUniverseStanding
VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
eTrackingOrigin, HmdMatrix34 pmatTrackingOriginToOverlayTransform)

Sets the transform to absolute tracking origin.

public static int
VROverlay_SetOverlayTransformCursor(long ulCursorOverlayHandle, HmdVector2 pvHotspot)

Sets the hotspot for the specified overlay when that overlay is used as a cursor.

public static int
VROverlay_SetOverlayTransformProjection(long ulOverlayHandle, int eTrackingOrigin, HmdMatrix34 pmatTrackingOriginToOverlayTransform, VROverlayProjection pProjection, int eEye)

Sets the overlay as a projection overlay.

public static int
VROverlay_SetOverlayTransformTrackedDeviceComponent(long ulOverlayHandle, int unDeviceIndex, ByteBuffer pchComponentName)

Sets the transform to draw the overlay on a rendermodel component mesh instead of a quad.

public static int
VROverlay_SetOverlayTransformTrackedDeviceComponent(long ulOverlayHandle, int unDeviceIndex, CharSequence pchComponentName)

Sets the transform to draw the overlay on a rendermodel component mesh instead of a quad.

public static int
VROverlay_SetOverlayTransformTrackedDeviceRelative(long ulOverlayHandle, int unTrackedDevice, HmdMatrix34 pmatTrackedDeviceToOverlayTransform)

Sets the transform to relative to the transform of the specified tracked device.

public static int
VROverlay_SetOverlayWidthInMeters(long ulOverlayHandle, float fWidthInMeters)

Sets the width of the overlay quad in meters.

public static void
VROverlay_ShowDashboard(ByteBuffer pchOverlayToShow)

Shows the dashboard.

public static void
VROverlay_ShowDashboard(CharSequence pchOverlayToShow)

Shows the dashboard.

public static int
VROverlay_ShowKeyboard(int
one of:
VR#EGamepadTextInputMode_k_EGamepadTextInputModeNormal
VR#EGamepadTextInputMode_k_EGamepadTextInputModePassword
VR#EGamepadTextInputMode_k_EGamepadTextInputModeSubmit
eInputMode, int
one of:
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeSingleLine
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeMultipleLines
eLineInputMode, int unFlags, ByteBuffer pchDescription, int unCharMax, ByteBuffer pchExistingText, boolean bUseMinimalMode, long uUserValue)

Show the virtual keyboard to accept input.

public static int
VROverlay_ShowKeyboard(int
one of:
VR#EGamepadTextInputMode_k_EGamepadTextInputModeNormal
VR#EGamepadTextInputMode_k_EGamepadTextInputModePassword
VR#EGamepadTextInputMode_k_EGamepadTextInputModeSubmit
eInputMode, int
one of:
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeSingleLine
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeMultipleLines
eLineInputMode, int unFlags, CharSequence pchDescription, int unCharMax, CharSequence pchExistingText, boolean bUseMinimalMode, long uUserValue)

Show the virtual keyboard to accept input.

public static int
VROverlay_ShowKeyboardForOverlay(long ulOverlayHandle, int
one of:
VR#EGamepadTextInputMode_k_EGamepadTextInputModeNormal
VR#EGamepadTextInputMode_k_EGamepadTextInputModePassword
VR#EGamepadTextInputMode_k_EGamepadTextInputModeSubmit
eInputMode, int
one of:
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeSingleLine
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeMultipleLines
eLineInputMode, int unFlags, ByteBuffer pchDescription, int unCharMax, ByteBuffer pchExistingText, boolean bUseMinimalMode, long uUserValue)

Show the virtual keyboard to accept input for an overlay.

public static int
VROverlay_ShowKeyboardForOverlay(long ulOverlayHandle, int
one of:
VR#EGamepadTextInputMode_k_EGamepadTextInputModeNormal
VR#EGamepadTextInputMode_k_EGamepadTextInputModePassword
VR#EGamepadTextInputMode_k_EGamepadTextInputModeSubmit
eInputMode, int
one of:
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeSingleLine
VR#EGamepadTextInputLineMode_k_EGamepadTextInputLineModeMultipleLines
eLineInputMode, int unFlags, CharSequence pchDescription, int unCharMax, CharSequence pchExistingText, boolean bUseMinimalMode, long uUserValue)

Show the virtual keyboard to accept input for an overlay.

public static int
VROverlay_ShowMessageOverlay(ByteBuffer pchText, ByteBuffer pchCaption, ByteBuffer pchButton0Text, ByteBuffer pchButton1Text, ByteBuffer pchButton2Text, ByteBuffer pchButton3Text)

Show the message overlay.

public static int
VROverlay_ShowMessageOverlay(CharSequence pchText, CharSequence pchCaption, CharSequence pchButton0Text, CharSequence pchButton1Text, CharSequence pchButton2Text, CharSequence pchButton3Text)

Show the message overlay.

public static int
VROverlay_ShowOverlay(long ulOverlayHandle)

Shows the VR overlay.

public static int
VROverlay_TriggerLaserMouseHapticVibration(long ulOverlayHandle, float fDurationSeconds, float fFrequency, float fAmplitude)

Triggers a haptic event on the laser mouse controller for the specified overlay.

public static int
VROverlay_WaitFrameSync(int nTimeoutMs)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait