Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class EXTPerformanceSettings

extends Object
Class Inheritance
Imports
org.lwjgl.system.*
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:

Field Summary

Modifier and TypeField and Description
public static final String
XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME

The extension name.

public static final int
XR_EXT_performance_settings_SPEC_VERSION

The extension specification version.

public static final int
XR_PERF_SETTINGS_DOMAIN_CPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT Enum values:

public static final int
XR_PERF_SETTINGS_DOMAIN_GPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT Enum values:

public static final int
XR_PERF_SETTINGS_LEVEL_BOOST_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT See Also

PerfSettingsSetPerformanceLevelEXT Enum values:

public static final int
XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT See Also

PerfSettingsSetPerformanceLevelEXT Enum values:

public static final int
XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT See Also

PerfSettingsSetPerformanceLevelEXT Enum values:

public static final int
XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT See Also

PerfSettingsSetPerformanceLevelEXT Enum values:

public static final int
XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT Enum values:

public static final int
XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT Enum values:

public static final int
XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT Enum values:

public static final int
XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT See Also

XrEventDataPerfSettingsEXT Enum values:

public static final int
XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT See Also

XrEventDataPerfSettingsEXT Enum values:

public static final int
XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT See Also

XrEventDataPerfSettingsEXT Enum values:

public static final int
XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT

Extends XrStructureType.

Constructor Summary

AccessConstructor and Description
protected
EXTPerformanceSettings()

Method Summary

Modifier and TypeMethod and Description
public static int
xrPerfSettingsSetPerformanceLevelEXT(XrSession
a valid XrSession handle.
session, int
the processing domain for which the level hint is applied
domain, int
the level hint to be applied
level)

xrPerfSettingsSetPerformanceLevelEXT.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAMEback to summary
public static final String XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME

The extension name.

XR_EXT_performance_settings_SPEC_VERSIONback to summary
public static final int XR_EXT_performance_settings_SPEC_VERSION

The extension specification version.

XR_PERF_SETTINGS_DOMAIN_CPU_EXTback to summary
public static final int XR_PERF_SETTINGS_DOMAIN_CPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT

See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT

Enum values:
XR_PERF_SETTINGS_DOMAIN_GPU_EXTback to summary
public static final int XR_PERF_SETTINGS_DOMAIN_GPU_EXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT

See Also

XrEventDataPerfSettingsEXT, PerfSettingsSetPerformanceLevelEXT, ThermalGetTemperatureTrendEXT

Enum values:
XR_PERF_SETTINGS_LEVEL_BOOST_EXTback to summary
public static final int XR_PERF_SETTINGS_LEVEL_BOOST_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:
XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXTback to summary
public static final int XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:
XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXTback to summary
public static final int XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:
XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXTback to summary
public static final int XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

PerfSettingsSetPerformanceLevelEXT

Enum values:
XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXTback to summary
public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:
XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXTback to summary
public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:
XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXTback to summary
public static final int XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

XrEventDataPerfSettingsEXT, ThermalGetTemperatureTrendEXT

Enum values:
XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXTback to summary
public static final int XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:
XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXTback to summary
public static final int XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:
XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXTback to summary
public static final int XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

XrEventDataPerfSettingsEXT

Enum values:
XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXTback to summary
public static final int XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT

Extends XrStructureType.

Constructor Detail

EXTPerformanceSettingsback to summary
protected EXTPerformanceSettings()

Method Detail

xrPerfSettingsSetPerformanceLevelEXTback to summary
public static int xrPerfSettingsSetPerformanceLevelEXT(XrSession session, int domain, int level)

xrPerfSettingsSetPerformanceLevelEXT.

C Specification

XrResult xrPerfSettingsSetPerformanceLevelEXT(
    XrSession                                   session,
    XrPerfSettingsDomainEXT                     domain,
    XrPerfSettingsLevelEXT                      level);
Valid Usage (Implicit)
Return Codes
On success, this command returns
On failure, this command returns
Parameters
session:XrSession

a valid XrSession handle.

domain:int

the processing domain for which the level hint is applied

level:int

the level hint to be applied

Annotations
@NativeType:XrResult