vr::IVRNotifications Class Reference

#include <openvr_mingw.h>

Public Member Functions
EVRNotificationError	CreateNotification (VROverlayHandle_t ulOverlayHandle, uint64_t ulUserValue, EVRNotificationType type, const char *pchText, EVRNotificationStyle style, const NotificationBitmap_t *pImage, VRNotificationId *pNotificationId)
EVRNotificationError	RemoveNotification (VRNotificationId notificationId)

Member Function Documentation

CreateNotification()

EVRNotificationError vr::IVRNotifications::CreateNotification ( VROverlayHandle_t ulOverlayHandle, uint64_t ulUserValue, EVRNotificationType type, const char * pchText, EVRNotificationStyle style, const NotificationBitmap_t * pImage, VRNotificationId * pNotificationId )

inline

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 ('
') 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.

RemoveNotification()

EVRNotificationError vr::IVRNotifications::RemoveNotification ( VRNotificationId notificationId )

inline

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

---

The documentation for this class was generated from the following file:

• openvr/openvr_mingw.h