org.lwjgl.openxr.FBSceneCapture 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 java.nio.*;

import org.lwjgl.system.*;

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

/**
 * The XR_FB_scene_capture extension.
 * 
 * This extension allows an application to request that the system begin capturing information about what is in the environment around the user.
 * 
 * In order to enable the functionality of this extension, you must pass the name of the extension into {@link XR10#xrCreateInstance CreateInstance} via the {@link XrInstanceCreateInfo}{@code ::enabledExtensionNames} parameter as indicated in the extension section.
 */
public class FBSceneCapture {

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

    /** The extension name. */
    public static final String XR_FB_SCENE_CAPTURE_EXTENSION_NAME = "XR_FB_scene_capture";

    /**
     * Extends {@code XrStructureType}.
     * 
     * Enum values:
     * 
     * 
     * {@link #XR_TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB}
     * {@link #XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB TYPE_SCENE_CAPTURE_REQUEST_INFO_FB}
     * 
     */
    public static final int
        XR_TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB = 1000198001,
        XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB        = 1000198050;

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

    // --- [ xrRequestSceneCaptureFB ] ---

    /** Unsafe version of: {@link #xrRequestSceneCaptureFB RequestSceneCaptureFB} */
    public static int nxrRequestSceneCaptureFB(XrSession session, long info, long requestId) {
        long __functionAddress = session.getCapabilities().xrRequestSceneCaptureFB;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callPPPI(session.address(), info, requestId, __functionAddress);
    }

    /**
     * Begins a scene capture using the specified parameters.
     * 
     * C Specification
     * 
     * The {@link #xrRequestSceneCaptureFB RequestSceneCaptureFB} function is defined as:
     * 
     * 
     * XrResult xrRequestSceneCaptureFB(
     *     XrSession                                   session,
     *     const XrSceneCaptureRequestInfoFB*          info,
     *     XrAsyncRequestIdFB*                         requestId);
     * 
     * Description
     * 
     * The {@link #xrRequestSceneCaptureFB RequestSceneCaptureFB} function is used by an application to begin capturing the scene around the user. This is an asynchronous operation.
     * 
     * Valid Usage (Implicit)
     * 
     * 
     * The {@link FBSceneCapture XR_FB_scene_capture} extension must be enabled prior to calling {@link #xrRequestSceneCaptureFB RequestSceneCaptureFB}
     * {@code session} must be a valid {@code XrSession} handle
     * {@code info} must be a pointer to a valid {@link XrSceneCaptureRequestInfoFB} structure
     * {@code requestId} must be a pointer to an {@code XrAsyncRequestIdFB} 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}
     * {@link XR10#XR_ERROR_FEATURE_UNSUPPORTED ERROR_FEATURE_UNSUPPORTED}
     * 
     * 
     * 
     * See Also
     * 
     * {@link XrSceneCaptureRequestInfoFB}
     *
     * @param session   a handle to an {@code XrSession}.
     * @param info      an {@link XrSceneCaptureRequestInfoFB} which specifies how the scene capture should occur.
     * @param requestId the output parameter that points to the ID of this asynchronous request.
     */
    @NativeType("XrResult")
    public static int xrRequestSceneCaptureFB(XrSession session, @NativeType("XrSceneCaptureRequestInfoFB const *") XrSceneCaptureRequestInfoFB info, @NativeType("XrAsyncRequestIdFB *") LongBuffer requestId) {
        if (CHECKS) {
            check(requestId, 1);
        }
        return nxrRequestSceneCaptureFB(session, info.address(), memAddress(requestId));
    }

}