org.lwjgl.openxr.EXTPerformanceSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openxr Show documentation
A royalty-free, open standard that provides high-performance access to Augmented Reality (AR) and Virtual Reality (VR)—collectively known as XR—platforms and devices.
There is a newer version: 3.3.6
Show newest version
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.openxr;

import org.lwjgl.system.*;

import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;

/**
 * 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
 * 
 */
public class EXTPerformanceSettings {

    /** The extension specification version. */
    public static final int XR_EXT_performance_settings_SPEC_VERSION = 4;

    /** The extension name. */
    public static final String XR_EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME = "XR_EXT_performance_settings";

    /** Extends {@code XrStructureType}. */
    public static final int XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT = 1000015000;

    /**
     * XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT
     * 
     * See Also
     * 
     * {@link XrEventDataPerfSettingsEXT}, {@link #xrPerfSettingsSetPerformanceLevelEXT PerfSettingsSetPerformanceLevelEXT}, {@link EXTThermalQuery#xrThermalGetTemperatureTrendEXT ThermalGetTemperatureTrendEXT}
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_PERF_SETTINGS_DOMAIN_CPU_EXT PERF_SETTINGS_DOMAIN_CPU_EXT}
     * {@link #XR_PERF_SETTINGS_DOMAIN_GPU_EXT PERF_SETTINGS_DOMAIN_GPU_EXT}
     * 
     */
    public static final int
        XR_PERF_SETTINGS_DOMAIN_CPU_EXT = 1,
        XR_PERF_SETTINGS_DOMAIN_GPU_EXT = 2;

    /**
     * XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT
     * 
     * See Also
     * 
     * {@link XrEventDataPerfSettingsEXT}
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT}
     * {@link #XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT}
     * {@link #XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT}
     * 
     */
    public static final int
        XR_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT = 1,
        XR_PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT   = 2,
        XR_PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT     = 3;

    /**
     * XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT
     * 
     * See Also
     * 
     * {@link #xrPerfSettingsSetPerformanceLevelEXT PerfSettingsSetPerformanceLevelEXT}
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT}
     * {@link #XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT}
     * {@link #XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT}
     * {@link #XR_PERF_SETTINGS_LEVEL_BOOST_EXT PERF_SETTINGS_LEVEL_BOOST_EXT}
     * 
     */
    public static final int
        XR_PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT  = 0,
        XR_PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT  = 25,
        XR_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT = 50,
        XR_PERF_SETTINGS_LEVEL_BOOST_EXT          = 75;

    /**
     * XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT
     * 
     * See Also
     * 
     * {@link XrEventDataPerfSettingsEXT}, {@link EXTThermalQuery#xrThermalGetTemperatureTrendEXT ThermalGetTemperatureTrendEXT}
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT}
     * {@link #XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT}
     * {@link #XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT}
     * 
     */
    public static final int
        XR_PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT   = 0,
        XR_PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT  = 25,
        XR_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT = 75;

    protected EXTPerformanceSettings() {
        throw new UnsupportedOperationException();
    }

    // --- [ xrPerfSettingsSetPerformanceLevelEXT ] ---

    /**
     * xrPerfSettingsSetPerformanceLevelEXT.
     * 
     * C Specification
     * 
     * 
     * XrResult xrPerfSettingsSetPerformanceLevelEXT(
     *     XrSession                                   session,
     *     XrPerfSettingsDomainEXT                     domain,
     *     XrPerfSettingsLevelEXT                      level);
     * 
     * Valid Usage (Implicit)
     * 
     * 
     * The {@link EXTPerformanceSettings XR_EXT_performance_settings} extension must be enabled prior to calling {@link #xrPerfSettingsSetPerformanceLevelEXT PerfSettingsSetPerformanceLevelEXT}
     * {@code session} must be a valid {@code XrSession} handle
     * {@code domain} must be a valid {@code XrPerfSettingsDomainEXT} value
     * {@code level} must be a valid {@code XrPerfSettingsLevelEXT} value
     * 
     * 
     * Return Codes
     * 
     * 
     * On success, this command returns
     * 
     * {@link XR10#XR_SUCCESS SUCCESS}
     * {@link XR10#XR_SESSION_LOSS_PENDING SESSION_LOSS_PENDING}
     * 
     * On failure, this command returns
     * 
     * {@link XR10#XR_ERROR_FUNCTION_UNSUPPORTED ERROR_FUNCTION_UNSUPPORTED}
     * {@link XR10#XR_ERROR_VALIDATION_FAILURE ERROR_VALIDATION_FAILURE}
     * {@link XR10#XR_ERROR_RUNTIME_FAILURE ERROR_RUNTIME_FAILURE}
     * {@link XR10#XR_ERROR_HANDLE_INVALID ERROR_HANDLE_INVALID}
     * {@link XR10#XR_ERROR_INSTANCE_LOST ERROR_INSTANCE_LOST}
     * {@link XR10#XR_ERROR_SESSION_LOST ERROR_SESSION_LOST}
     * 
     * 
     *
     * @param session a valid {@code XrSession} handle.
     * @param domain  the processing domain for which the level hint is applied
     * @param level   the level hint to be applied
     */
    @NativeType("XrResult")
    public static int xrPerfSettingsSetPerformanceLevelEXT(XrSession session, @NativeType("XrPerfSettingsDomainEXT") int domain, @NativeType("XrPerfSettingsLevelEXT") int level) {
        long __functionAddress = session.getCapabilities().xrPerfSettingsSetPerformanceLevelEXT;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callPI(session.address(), domain, level, __functionAddress);
    }

}