Package org.lwjgl.openvr

Class VROverlayView

java.lang.Object

org.lwjgl.openvr.VROverlayView

public class VROverlayView
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
static int	nVROverlayView_AcquireOverlayView(long ulOverlayHandle, long pNativeDevice, long pOverlayView, int unOverlayViewSize)	Unsafe version of: AcquireOverlayView
static void	nVROverlayView_PostOverlayEvent(long ulOverlayHandle, long pvrEvent)	Unsafe version of: PostOverlayEvent
static int	nVROverlayView_ReleaseOverlayView(long pOverlayView)	Unsafe version of: ReleaseOverlayView
static int	VROverlayView_AcquireOverlayView(long ulOverlayHandle, VRNativeDevice pNativeDevice, VROverlayView_t pOverlayView, int unOverlayViewSize)	Acquires an OverlayView_t from an overlay handle
static boolean	VROverlayView_IsViewingPermitted(long ulOverlayHandle)	Determines whether this process is permitted to view an overlay's content.
static void	VROverlayView_PostOverlayEvent(long ulOverlayHandle, VREvent pvrEvent)	Posts an overlay event.
static int	VROverlayView_ReleaseOverlayView(VROverlayView_t pOverlayView)	Releases an acquired OverlayView_t.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

nVROverlayView_AcquireOverlayView

public static int nVROverlayView_AcquireOverlayView(long ulOverlayHandle,
                                                    long pNativeDevice,
                                                    long pOverlayView,
                                                    int unOverlayViewSize)

Unsafe version of: AcquireOverlayView

VROverlayView_AcquireOverlayView

public static int VROverlayView_AcquireOverlayView(long ulOverlayHandle,
                                                   VRNativeDevice pNativeDevice,
                                                   VROverlayView_t pOverlayView,
                                                   int unOverlayViewSize)

Acquires an OverlayView_t from an overlay handle

The overlay view can be used to sample the contents directly by a native API. The contents of the OverlayView_t will remain unchanged through the lifetime of the OverlayView_t.

The caller acquires read privileges over the OverlayView_t, but should not write to it.

AcquireOverlayView() may be called on the same ulOverlayHandle multiple times to refresh the image contents. In this case the caller is strongly encouraged to re-use the same pOverlayView for all re-acquisition calls.

If the producer has not yet queued an image, AcquireOverlayView will return success, and the Texture_t will have the expected ETextureType. However, the Texture_t->handle will be nullptr. Once the producer generates the first overlay frame, Texture_t->handle will become a valid handle.

nVROverlayView_ReleaseOverlayView

public static int nVROverlayView_ReleaseOverlayView(long pOverlayView)

Unsafe version of: ReleaseOverlayView

VROverlayView_ReleaseOverlayView

public static int VROverlayView_ReleaseOverlayView(VROverlayView_t pOverlayView)

Releases an acquired OverlayView_t.

Denotes that pOverlayView will no longer require access to the resources it acquired in all previous calls to AcquireOverlayView().

All OverlayView_t*'s provided to AcquireOverlayView() as pOverlayViews must be passed into ReleaseOverlayView() in order for the underlying GPU resources to be freed.

nVROverlayView_PostOverlayEvent

public static void nVROverlayView_PostOverlayEvent(long ulOverlayHandle,
                                                   long pvrEvent)

Unsafe version of: PostOverlayEvent

VROverlayView_PostOverlayEvent

public static void VROverlayView_PostOverlayEvent(long ulOverlayHandle,
                                                  VREvent pvrEvent)

Posts an overlay event.

VROverlayView_IsViewingPermitted

public static boolean VROverlayView_IsViewingPermitted(long ulOverlayHandle)

Determines whether this process is permitted to view an overlay's content.