Package org.lwjgl.openxr

Class KHRLoaderInit

java.lang.Object

org.lwjgl.openxr.KHRLoaderInit

public class KHRLoaderInit
extends Object

The XR_KHR_loader_init extension.

On some platforms, before loading can occur the loader must be initialized with platform-specific parameters.

Unlike other extensions, the presence of this extension is signaled by a successful call to GetInstanceProcAddr to retrieve the function pointer for InitializeLoaderKHR using NULL_HANDLE as the instance parameter.

If this extension is supported, its use may be required on some platforms and the use of the InitializeLoaderKHR function must precede other OpenXR calls except GetInstanceProcAddr.

This function exists as part of the loader library that the application is using and the loader must pass calls to InitializeLoaderKHR to the active runtime, and all enabled API layers that expose a InitializeLoaderKHR function exposed either through their manifest, or through their implementation of GetInstanceProcAddr.

If the InitializeLoaderKHR function is discovered through the manifest, InitializeLoaderKHR will be called before xrNegotiateLoaderRuntimeInterface or xrNegotiateLoaderApiLayerInterface has been called on the runtime or layer respectively.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_KHR_LOADER_INIT_EXTENSION_NAME	The extension name.
static final int	XR_KHR_loader_init_SPEC_VERSION	The extension specification version.

Method Summary

Modifier and Type	Method	Description
static int	nxrInitializeLoaderKHR(long loaderInitInfo)	Unsafe version of: InitializeLoaderKHR
static int	xrInitializeLoaderKHR(XrLoaderInitInfoBaseHeaderKHR loaderInitInfo)	Initializes loader.

Methods inherited from class java.lang.Object

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

Field Details

XR_KHR_loader_init_SPEC_VERSION

public static final int XR_KHR_loader_init_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_KHR_LOADER_INIT_EXTENSION_NAME

public static final String XR_KHR_LOADER_INIT_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

Method Details

nxrInitializeLoaderKHR

public static int nxrInitializeLoaderKHR(long loaderInitInfo)

Unsafe version of: InitializeLoaderKHR

xrInitializeLoaderKHR

public static int xrInitializeLoaderKHR(XrLoaderInitInfoBaseHeaderKHR loaderInitInfo)

Initializes loader.

C Specification

To initialize an OpenXR loader with platform or implementation-specific parameters, call:

 XrResult xrInitializeLoaderKHR(
     const XrLoaderInitInfoBaseHeaderKHR*        loaderInitInfo);

Valid Usage (Implicit)

• The XR_KHR_loader_init extension must be enabled prior to calling InitializeLoaderKHR
• loaderInitInfo must be a pointer to a valid XrLoaderInitInfoBaseHeaderKHR-based structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE

See Also

XrLoaderInitInfoBaseHeaderKHR

Parameters:

loaderInitInfo - a pointer to an XrLoaderInitInfoBaseHeaderKHR structure, which is a polymorphic type defined by other platform- or implementation-specific extensions.