org.lwjgl.openxr.METAPassthroughPreferences 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.
The 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_META_passthrough_preferences extension.
 * 
 * This extension provides applications with access to system preferences concerning passthrough. For more information on how applications can control the display of passthrough, see {@link FBPassthrough XR_FB_passthrough}.
 */
public class METAPassthroughPreferences {

    /** The extension specification version. */
    public static final int XR_META_passthrough_preferences_SPEC_VERSION = 1;

    /** The extension name. */
    public static final String XR_META_PASSTHROUGH_PREFERENCES_EXTENSION_NAME = "XR_META_passthrough_preferences";

    /** Extends {@code XrStructureType}. */
    public static final int XR_TYPE_PASSTHROUGH_PREFERENCES_META = 1000217000;

    /**
     * XrPassthroughPreferenceFlagBitsMETA - XrPassthroughPreferenceFlagBitsMETA
     * 
     * Flag Descriptions
     * 
     * 
     * {@link #XR_PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META} — Indicates that the runtime recommends apps to default to a mixed reality experience with passthrough (if supported).
     * 
     */
    public static final int XR_PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META = 0x1;

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

    // --- [ xrGetPassthroughPreferencesMETA ] ---

    /** Unsafe version of: {@link #xrGetPassthroughPreferencesMETA GetPassthroughPreferencesMETA} */
    public static int nxrGetPassthroughPreferencesMETA(XrSession session, long preferences) {
        long __functionAddress = session.getCapabilities().xrGetPassthroughPreferencesMETA;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callPPI(session.address(), preferences, __functionAddress);
    }

    /**
     * Get passthrough preferences.
     * 
     * C Specification
     * 
     * The {@link #xrGetPassthroughPreferencesMETA GetPassthroughPreferencesMETA} function is defined as:
     * 
     * 
     * XrResult xrGetPassthroughPreferencesMETA(
     *     XrSession                                   session,
     *     XrPassthroughPreferencesMETA*               preferences);
     * 
     * Description
     * 
     * An application can call {@link #xrGetPassthroughPreferencesMETA GetPassthroughPreferencesMETA} to retrieve passthrough-related preferences from the system.
     * 
     * Valid Usage (Implicit)
     * 
     * 
     * The {@link METAPassthroughPreferences XR_META_passthrough_preferences} extension must be enabled prior to calling {@link #xrGetPassthroughPreferencesMETA GetPassthroughPreferencesMETA}
     * {@code session} must be a valid {@code XrSession} handle
     * {@code preferences} must be a pointer to an {@link XrPassthroughPreferencesMETA} structure
     * 
     * 
     * 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}
     * 
     * 
     * 
     * See Also
     * 
     * {@link XrPassthroughPreferencesMETA}
     *
     * @param session     the {@code XrSession}.
     * @param preferences points to an instance of {@link XrPassthroughPreferencesMETA} structure, that will be filled with returned information
     */
    @NativeType("XrResult")
    public static int xrGetPassthroughPreferencesMETA(XrSession session, @NativeType("XrPassthroughPreferencesMETA *") XrPassthroughPreferencesMETA preferences) {
        return nxrGetPassthroughPreferencesMETA(session, preferences.address());
    }

}