#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_gpu.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>

Include dependency graph for SDL_openxr.h:

Data Structures
struct	XrSessionCreateInfo
struct	XrSwapchainCreateInfo

Macros
#define	XR_NULL_HANDLE 0
#define	XR_DEFINE_HANDLE(object)
#define	PFN_xrGetInstanceProcAddr SDL_FunctionPointer

Enumerations
enum	XrStructureType { XR_TYPE_SESSION_CREATE_INFO = 8 , XR_TYPE_SWAPCHAIN_CREATE_INFO = 9 }
enum	XrResult { XR_ERROR_FUNCTION_UNSUPPORTED = -7 , XR_ERROR_HANDLE_INVALID = -12 }

Functions
XrResult	SDL_CreateGPUXRSession (SDL_GPUDevice device, const XrSessionCreateInfo createinfo, XrSession *session)
SDL_GPUTextureFormat *	SDL_GetGPUXRSwapchainFormats (SDL_GPUDevice device, XrSession session, int num_formats)
XrResult	SDL_CreateGPUXRSwapchain (SDL_GPUDevice device, XrSession session, const XrSwapchainCreateInfo createinfo, SDL_GPUTextureFormat format, XrSwapchain swapchain, SDL_GPUTexture **textures)
XrResult	SDL_DestroyGPUXRSwapchain (SDL_GPUDevice device, XrSwapchain swapchain, SDL_GPUTexture *swapchainImages)
bool	SDL_OpenXR_LoadLibrary (void)
void	SDL_OpenXR_UnloadLibrary (void)
PFN_xrGetInstanceProcAddr	SDL_OpenXR_GetXrGetInstanceProcAddr (void)

Macro Definition Documentation

◆ PFN_xrGetInstanceProcAddr

#define PFN_xrGetInstanceProcAddr SDL_FunctionPointer

Definition at line 79 of file SDL_openxr.h.

Referenced by SDL_OpenXR_GetXrGetInstanceProcAddr().

◆ XR_DEFINE_HANDLE

#define XR_DEFINE_HANDLE ( object )

Value:

typedef Uint64 object;

Uint64

uint64_t Uint64

Definition SDL_stdinc.h:504

Definition at line 52 of file SDL_openxr.h.

◆ XR_NULL_HANDLE

#define XR_NULL_HANDLE 0

CategoryOpenXR

Functions for creating OpenXR handles for SDL_gpu contexts.

For the most part, OpenXR operates independent of SDL, but the graphics initialization depends on direct support from SDL_gpu.

Definition at line 49 of file SDL_openxr.h.

Enumeration Type Documentation

◆ XrResult

enum XrResult

Enumerator
XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_HANDLE_INVALID

Definition at line 74 of file SDL_openxr.h.

                      {
    XR_ERROR_FUNCTION_UNSUPPORTED = -7,
    XR_ERROR_HANDLE_INVALID = -12,
} XrResult;

◆ XrStructureType

enum XrStructureType

Enumerator
XR_TYPE_SESSION_CREATE_INFO
XR_TYPE_SWAPCHAIN_CREATE_INFO

Definition at line 55 of file SDL_openxr.h.

                             {
    XR_TYPE_SESSION_CREATE_INFO = 8,
    XR_TYPE_SWAPCHAIN_CREATE_INFO = 9,
} XrStructureType;

Function Documentation

◆ SDL_CreateGPUXRSession()

XrResult SDL_CreateGPUXRSession	(	SDL_GPUDevice *	device,
		const XrSessionCreateInfo *	createinfo,
		XrSession *	session )

extern

Creates an OpenXR session.

The OpenXR system ID is pulled from the passed GPU context.

Parameters

device	a GPU context.
createinfo	the create info for the OpenXR session, sans the system ID.
session	a pointer filled in with an OpenXR session created for the given device.

Returns: the result of the call.

Since: This function is available since SDL 3.6.0.

See also: SDL_CreateGPUDeviceWithProperties

◆ SDL_CreateGPUXRSwapchain()

XrResult SDL_CreateGPUXRSwapchain	(	SDL_GPUDevice *	device,
		XrSession	session,
		const XrSwapchainCreateInfo *	createinfo,
		SDL_GPUTextureFormat	format,
		XrSwapchain *	swapchain,
		SDL_GPUTexture ***	textures )

extern

Creates an OpenXR swapchain.

The array returned via textures is sized according to xrEnumerateSwapchainImages, and thus should only be accessed via index values returned from xrAcquireSwapchainImage.

Applications are still allowed to call xrEnumerateSwapchainImages on the returned XrSwapchain if they need to get the exact size of the array.

Parameters

device	a GPU context.
session	an OpenXR session created for the given device.
createinfo	the create info for the OpenXR swapchain, sans the format.
format	a supported format for the OpenXR swapchain.
swapchain	a pointer filled in with the created OpenXR swapchain.
textures	a pointer filled in with the array of created swapchain images.

Returns: the result of the call.

Since: This function is available since SDL 3.6.0.

See also: SDL_CreateGPUDeviceWithProperties; SDL_CreateGPUXRSession; SDL_GetGPUXRSwapchainFormats; SDL_DestroyGPUXRSwapchain

◆ SDL_DestroyGPUXRSwapchain()

XrResult SDL_DestroyGPUXRSwapchain	(	SDL_GPUDevice *	device,
		XrSwapchain	swapchain,
		SDL_GPUTexture **	swapchainImages )

extern

Destroys and OpenXR swapchain previously returned by SDL_CreateGPUXRSwapchain.

Parameters

device	a GPU context.
swapchain	a swapchain previously returned by SDL_CreateGPUXRSwapchain.
swapchainImages	an array of swapchain images returned by the same call to SDL_CreateGPUXRSwapchain.

Returns: the result of the call.

Since: This function is available since SDL 3.6.0.

See also: SDL_CreateGPUDeviceWithProperties; SDL_CreateGPUXRSession; SDL_CreateGPUXRSwapchain

◆ SDL_GetGPUXRSwapchainFormats()

SDL_GPUTextureFormat * SDL_GetGPUXRSwapchainFormats	(	SDL_GPUDevice *	device,
		XrSession	session,
		int *	num_formats )

extern

Queries the GPU device for supported XR swapchain image formats.

The returned pointer should be allocated with SDL_malloc() and will be passed to SDL_free().

Parameters

device	a GPU context.
session	an OpenXR session created for the given device.
num_formats	a pointer filled with the number of supported XR swapchain formats.

Returns: a 0 terminated array of supported formats or NULL on failure; call SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

Since: This function is available since SDL 3.6.0.

See also: SDL_CreateGPUXRSwapchain

◆ SDL_OpenXR_GetXrGetInstanceProcAddr()

PFN_xrGetInstanceProcAddr SDL_OpenXR_GetXrGetInstanceProcAddr ( void )

extern

Get the address of the xrGetInstanceProcAddr function.

This should be called after either calling SDL_OpenXR_LoadLibrary() or creating an OpenXR SDL_GPUDevice.

The actual type of the returned function pointer is PFN_xrGetInstanceProcAddr, but that isn't always available. You should include the OpenXR headers before this header, or cast the return value of this function to the correct type.

Returns: the function pointer for xrGetInstanceProcAddr or NULL on failure; call SDL_GetError() for more information.

Since: This function is available since SDL 3.6.0.

References PFN_xrGetInstanceProcAddr.

◆ SDL_OpenXR_LoadLibrary()

bool SDL_OpenXR_LoadLibrary ( void )

extern

Dynamically load the OpenXR loader.

This can be called at any time.

SDL keeps a reference count of the OpenXR loader, calling this function multiple times will increment that count, rather than loading the library multiple times.

If not called, this will be implicitly called when creating a GPU device with OpenXR.

This function will use the platform default OpenXR loader name, unless the SDL_HINT_OPENXR_LIBRARY hint is set.

Returns: true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function is not thread safe.

Since: This function is available since SDL 3.6.0.

See also: SDL_HINT_OPENXR_LIBRARY

◆ SDL_OpenXR_UnloadLibrary()

void SDL_OpenXR_UnloadLibrary ( void )

extern

Unload the OpenXR loader previously loaded by SDL_OpenXR_LoadLibrary.

SDL keeps a reference count of the OpenXR loader, calling this function will decrement that count. Once the reference count reaches zero, the library is unloaded.

\threadsafety This function is not thread safe.

Since: This function is available since SDL 3.6.0.

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

◆ PFN_xrGetInstanceProcAddr

◆ XR_DEFINE_HANDLE

◆ XR_NULL_HANDLE

CategoryOpenXR

Enumeration Type Documentation

◆ XrResult

◆ XrStructureType

Function Documentation

◆ SDL_CreateGPUXRSession()

◆ SDL_CreateGPUXRSwapchain()

◆ SDL_DestroyGPUXRSwapchain()

◆ SDL_GetGPUXRSwapchainFormats()

◆ SDL_OpenXR_GetXrGetInstanceProcAddr()

◆ SDL_OpenXR_LoadLibrary()

◆ SDL_OpenXR_UnloadLibrary()