Package org.lwjgl.openxr

Class MLSystemNotifications

java.lang.Object

org.lwjgl.openxr.MLSystemNotifications

public class MLSystemNotifications
extends Object

The XR_ML_system_notifications extension.

This extension provides control over the system notifications. This extension allows system notifications that might obscure the field of view to be disabled.

Note that even when all system notifications have been suppressed, developers can still intercept certain events that allow them to properly react to the underlying reason of system notifications.

Permissions

Android applications must have the com.magicleap.permission.SYSTEM_NOTIFICATION permission listed in their manifest to use this extension. (protection level: normal)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML	Extends XrResult.
static final int	XR_ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML	Extends XrResult.
static final String	XR_ML_SYSTEM_NOTIFICATIONS_EXTENSION_NAME	The extension name.
static final int	XR_ML_system_notifications_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_SYSTEM_NOTIFICATIONS_SET_INFO_ML	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrSetSystemNotificationsML(org.lwjgl.openxr.XrInstance instance, long info)	Unsafe version of: SetSystemNotificationsML
static int	xrSetSystemNotificationsML(org.lwjgl.openxr.XrInstance instance, XrSystemNotificationsSetInfoML info)	Set system notification suppression state.

Methods inherited from class java.lang.Object

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

Field Details

XR_ML_system_notifications_SPEC_VERSION

public static final int XR_ML_system_notifications_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_ML_SYSTEM_NOTIFICATIONS_EXTENSION_NAME

public static final String XR_ML_SYSTEM_NOTIFICATIONS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_NOTIFICATIONS_SET_INFO_ML

public static final int XR_TYPE_SYSTEM_NOTIFICATIONS_SET_INFO_ML

Extends XrStructureType.

See Also:

• Constant Field Values

XR_ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML

public static final int XR_ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML

Extends XrResult.

Enum values:

• ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML
• ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

See Also:

• Constant Field Values

XR_ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

public static final int XR_ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

Extends XrResult.

Enum values:

• ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML
• ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

See Also:

• Constant Field Values

Method Details

nxrSetSystemNotificationsML

public static int nxrSetSystemNotificationsML(org.lwjgl.openxr.XrInstance instance,
 long info)

Unsafe version of: SetSystemNotificationsML

xrSetSystemNotificationsML

public static int xrSetSystemNotificationsML(org.lwjgl.openxr.XrInstance instance,
 XrSystemNotificationsSetInfoML info)

Set system notification suppression state.

C Specification

The SetSystemNotificationsML function is defined as:

 XrResult xrSetSystemNotificationsML(
     XrInstance                                  instance,
     const XrSystemNotificationsSetInfoML*       info);

Description

This API will work only on certain SKUs. When called on an incompatible SKU the ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML error must be returned.

If the com.magicleap.permission.SYSTEM_NOTIFICATION permission is not granted, the runtime must return ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML.

Valid Usage (Implicit)

• The XR_ML_system_notifications extension must be enabled prior to calling SetSystemNotificationsML
• instance must be a valid XrInstance handle
• info must be a pointer to a valid XrSystemNotificationsSetInfoML structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML
• ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

See Also

XrSystemNotificationsSetInfoML

Parameters:

instance - XrInstance.

info - a pointer to an XrSystemNotificationsSetInfoML structure.