Package org.lwjgl.openvr

Class VRNotifications

java.lang.Object

org.lwjgl.openvr.VRNotifications

public class VRNotifications
extends Object

Method Summary

Modifier and Type	Method	Description
static int	nVRNotifications_CreateNotification(long ulOverlayHandle, long ulUserValue, int type, long pchText, int style, long pImage, long pNotificationId)	Unsafe version of: CreateNotification
static int	VRNotifications_CreateNotification(long ulOverlayHandle, long ulUserValue, int type, CharSequence pchText, int style, @Nullable NotificationBitmap pImage, IntBuffer pNotificationId)	Create a notification and enqueue it to be shown to the user.
static int	VRNotifications_CreateNotification(long ulOverlayHandle, long ulUserValue, int type, ByteBuffer pchText, int style, @Nullable NotificationBitmap pImage, IntBuffer pNotificationId)	Create a notification and enqueue it to be shown to the user.
static int	VRNotifications_RemoveNotification(int notificationId)	Destroy a notification, hiding it first if it currently shown to the user.

Methods inherited from class java.lang.Object

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

Method Details

nVRNotifications_CreateNotification

public static int nVRNotifications_CreateNotification(long ulOverlayHandle,
 long ulUserValue,
 int type,
 long pchText,
 int style,
 long pImage,
 long pNotificationId)

Unsafe version of: CreateNotification

VRNotifications_CreateNotification

public static int VRNotifications_CreateNotification(long ulOverlayHandle,
 long ulUserValue,
 int type,
 ByteBuffer pchText,
 int style,
 @Nullable NotificationBitmap pImage,
 IntBuffer pNotificationId)

Create a notification and enqueue it to be shown to the user.

An overlay handle is required to create a notification, as otherwise it would be impossible for a user to act on it. To create a two-line notification, use a line break ('\n') to split the text into two lines. The pImage argument may be NULL, in which case the specified overlay's icon will be used instead.

Parameters:

type - one of:

VR.EVRNotificationType_Transient	VR.EVRNotificationType_Persistent
VR.EVRNotificationType_Transient_SystemWithUserValue

style - one of:

VR.EVRNotificationStyle_None	VR.EVRNotificationStyle_Application
VR.EVRNotificationStyle_Contact_Disabled	VR.EVRNotificationStyle_Contact_Enabled
VR.EVRNotificationStyle_Contact_Active

VRNotifications_CreateNotification

public static int VRNotifications_CreateNotification(long ulOverlayHandle,
 long ulUserValue,
 int type,
 CharSequence pchText,
 int style,
 @Nullable NotificationBitmap pImage,
 IntBuffer pNotificationId)

Create a notification and enqueue it to be shown to the user.

An overlay handle is required to create a notification, as otherwise it would be impossible for a user to act on it. To create a two-line notification, use a line break ('\n') to split the text into two lines. The pImage argument may be NULL, in which case the specified overlay's icon will be used instead.

Parameters:

type - one of:

VR.EVRNotificationType_Transient	VR.EVRNotificationType_Persistent
VR.EVRNotificationType_Transient_SystemWithUserValue

style - one of:

VR.EVRNotificationStyle_None	VR.EVRNotificationStyle_Application
VR.EVRNotificationStyle_Contact_Disabled	VR.EVRNotificationStyle_Contact_Enabled
VR.EVRNotificationStyle_Contact_Active

VRNotifications_RemoveNotification

public static int VRNotifications_RemoveNotification(int notificationId)

Destroy a notification, hiding it first if it currently shown to the user.