Package org.lwjgl.openxr

Class EXTPerformanceSettings

java.lang.Object

org.lwjgl.openxr.EXTPerformanceSettings

public class EXTPerformanceSettings
extends Object

The XR_EXT_performance_settings extension.

This extension defines an API for the application to give performance hints to the runtime and for the runtime to send performance related notifications back to the application. This allows both sides to dial in a suitable compromise between needed CPU and GPU performance, thermal sustainability and a consistent good user experience throughout the session.

The goal is to render frames consistently, in time, under varying system load without consuming more energy than necessary.

In summary, the APIs allow:

• setting performance level hints
• receiving performance related notifications

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME	The extension name.
static final int	XR_EXT_performance_settings_SPEC_VERSION	The extension specification version.
static final int	XR_PERF_SETTINGS_DOMAIN_CPU_EXT	XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT
static final int	XR_PERF_SETTINGS_DOMAIN_GPU_EXT	XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT
static final int	XR_PERF_SETTINGS_LEVEL_BOOST_EXT	XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT
static final int	XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT	XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT
static final int	XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT	XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT
static final int	XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT	XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT
static final int	XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT	XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT
static final int	XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT	XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT
static final int	XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT	XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT
static final int	XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT	XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT
static final int	XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT	XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT
static final int	XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT	XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT
static final int	XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	xrPerfSettingsSetPerformanceLevelEXT(XrSession session, int domain, int level)	xrPerfSettingsSetPerformanceLevelEXT.

Methods inherited from class java.lang.Object

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

Field Details

XR_EXT_performance_settings_SPEC_VERSION

public static final int XR_EXT_performance_settings_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME

public static final String XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT

public static final int XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT

Extends XrStructureType.

See Also:

• Constant Field Values

XR_PERF_SETTINGS_DOMAIN_CPU_EXT

public static final int XR_PERF_SETTINGS_DOMAIN_CPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT

See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT

Enum values:

• PERF_SETTINGS_DOMAIN_CPU_EXT
• PERF_SETTINGS_DOMAIN_GPU_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_DOMAIN_GPU_EXT

public static final int XR_PERF_SETTINGS_DOMAIN_GPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT

See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT

Enum values:

• PERF_SETTINGS_DOMAIN_CPU_EXT
• PERF_SETTINGS_DOMAIN_GPU_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT

public static final int XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:

• PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT
• PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT
• PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT

public static final int XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:

• PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT
• PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT
• PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

public static final int XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:

• PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT
• PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT
• PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT

public static final int XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:

• PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT
• PERF_SETTINGS_LEVEL_BOOST_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT

public static final int XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:

• PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT
• PERF_SETTINGS_LEVEL_BOOST_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT

public static final int XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:

• PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT
• PERF_SETTINGS_LEVEL_BOOST_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_LEVEL_BOOST_EXT

public static final int XR_PERF_SETTINGS_LEVEL_BOOST_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:

• PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT
• PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT
• PERF_SETTINGS_LEVEL_BOOST_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT

public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:

• PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT
• PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT
• PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT

public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:

• PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT
• PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT
• PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

See Also:

• Constant Field Values

XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:

• PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT
• PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT
• PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

See Also:

• Constant Field Values

Method Details

xrPerfSettingsSetPerformanceLevelEXT

public static int xrPerfSettingsSetPerformanceLevelEXT(XrSession session,
 int domain,
 int level)

xrPerfSettingsSetPerformanceLevelEXT.

C Specification

 XrResult xrPerfSettingsSetPerformanceLevelEXT(
     XrSession                                   session,
     XrPerfSettingsDomainEXT                     domain,
     XrPerfSettingsLevelEXT                      level);

Valid Usage (Implicit)

• The XR_EXT_performance_settings extension must be enabled prior to calling PerfSettingsSetPerformanceLevelEXT
• session must be a valid XrSession handle
• domain must be a valid XrPerfSettingsDomainEXT value
• level must be a valid XrPerfSettingsLevelEXT value

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST

Parameters:

session - a valid XrSession handle.

domain - the processing domain for which the level hint is applied

level - the level hint to be applied