Package org.lwjgl.openxr

Class KHROpenGLEnable

java.lang.Object

org.lwjgl.openxr.KHROpenGLEnable

public class KHROpenGLEnable
extends Object

The XR_KHR_opengl_enable extension.

This extension enables the use of the OpenGL graphics API in an OpenXR runtime. Without this extension, the OpenXR runtime may not be able to provide any OpenGL swapchain images.

This extension provides the mechanisms necessary for an application to generate a valid stext:XrGraphicsBindingOpenGL*KHR structure in order to create an OpenGL-based XrSession. Note that during this process the application is responsible for creating an OpenGL context to be used for rendering. The runtime however will provide the OpenGL textures to render into in the form of a swapchain.

This extension provides mechanisms for the application to interact with images acquired by calling EnumerateSwapchainImages.

In order to expose the structures, types, and functions of this extension, the application must define USE_GRAPHICS_API_OPENGL, as well as an appropriate window system define supported by this extension, before including the OpenXR platform header openxr_platform.h, in all portions of the library or application that include it. The window system defines currently supported by this extension are:

• USE_PLATFORM_WIN32
• USE_PLATFORM_XLIB
• USE_PLATFORM_XCB
• USE_PLATFORM_WAYLAND

Note that a runtime implementation of this extension is only required to support the structs introduced by this extension which belong to the platform it is running on.

Note that the OpenGL context given to the call CreateSession must not be bound in another thread when calling the functions: CreateSession, DestroySession, BeginFrame, EndFrame, CreateSwapchain, DestroySwapchain, EnumerateSwapchainImages, AcquireSwapchainImage, WaitSwapchainImage and ReleaseSwapchainImage. It may be bound in the thread calling those functions. The runtime must not access the context from any other function. In particular the application must be able to call WaitFrame from a different thread than the rendering thread.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_KHR_OPENGL_ENABLE_EXTENSION_NAME	The extension name.
static final int	XR_KHR_opengl_enable_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR	Extends XrStructureType.
static final int	XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetOpenGLGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, long graphicsRequirements)	Unsafe version of: GetOpenGLGraphicsRequirementsKHR
static int	xrGetOpenGLGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, XrGraphicsRequirementsOpenGLKHR graphicsRequirements)	Retrieve the OpenGL version requirements for an instance and system.

Methods inherited from class java.lang.Object

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

Field Details

XR_KHR_opengl_enable_SPEC_VERSION

public static final int XR_KHR_opengl_enable_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_KHR_OPENGL_ENABLE_EXTENSION_NAME

public static final String XR_KHR_OPENGL_ENABLE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR

public static final int XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

public static final int XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR
• TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR
• TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR
• TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR

See Also:

• Constant Field Values

Method Details

nxrGetOpenGLGraphicsRequirementsKHR

public static int nxrGetOpenGLGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 long graphicsRequirements)

Unsafe version of: GetOpenGLGraphicsRequirementsKHR

xrGetOpenGLGraphicsRequirementsKHR

public static int xrGetOpenGLGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 XrGraphicsRequirementsOpenGLKHR graphicsRequirements)

Retrieve the OpenGL version requirements for an instance and system.

C Specification

To query OpenGL API version requirements for an instance and system, call:

 XrResult xrGetOpenGLGraphicsRequirementsKHR(
     XrInstance                                  instance,
     XrSystemId                                  systemId,
     XrGraphicsRequirementsOpenGLKHR*            graphicsRequirements);

Description

The GetOpenGLGraphicsRequirementsKHR function identifies to the application the minimum OpenGL version requirement and the highest known tested OpenGL version. The runtime must return ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING (ERROR_VALIDATION_FAILURE may be returned due to legacy behavior) on calls to CreateSession if GetOpenGLGraphicsRequirementsKHR has not been called for the same instance and systemId.

Valid Usage (Implicit)

• The XR_KHR_opengl_enable extension must be enabled prior to calling GetOpenGLGraphicsRequirementsKHR
• instance must be a valid XrInstance handle
• graphicsRequirements must be a pointer to an XrGraphicsRequirementsOpenGLKHR structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SYSTEM_INVALID

See Also

XrGraphicsRequirementsOpenGLKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

systemId - an XrSystemId handle for the system which will be used to create a session.

graphicsRequirements - the XrGraphicsRequirementsOpenGLKHR output structure.