Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

OpenXRExtensionWrapperExtension

Inherits: Object

Allows clients to implement OpenXR extensions with GDExtension.

Description

OpenXRExtensionWrapperExtension allows clients to implement OpenXR extensions with GDExtension. The extension should be registered with register_extension_wrapper.

Methods

Dictionary

_get_requested_extensions ( ) virtual

void

_on_before_instance_created ( ) virtual

bool

_on_event_polled ( const void* event ) virtual

void

_on_instance_created ( int instance ) virtual

void

_on_instance_destroyed ( ) virtual

void

_on_pre_render ( ) virtual

void

_on_process ( ) virtual

void

_on_register_metadata ( ) virtual

void

_on_session_created ( int session ) virtual

void

_on_session_destroyed ( ) virtual

void

_on_state_exiting ( ) virtual

void

_on_state_focused ( ) virtual

void

_on_state_idle ( ) virtual

void

_on_state_loss_pending ( ) virtual

void

_on_state_ready ( ) virtual

void

_on_state_stopping ( ) virtual

void

_on_state_synchronized ( ) virtual

void

_on_state_visible ( ) virtual

int

_set_instance_create_info_and_get_next_pointer ( void* next_pointer ) virtual

int

_set_session_create_and_get_next_pointer ( void* next_pointer ) virtual

int

_set_swapchain_create_info_and_get_next_pointer ( void* next_pointer ) virtual

int

_set_system_properties_and_get_next_pointer ( void* next_pointer ) virtual

OpenXRAPIExtension

get_openxr_api ( )

void

register_extension_wrapper ( )


Method Descriptions

Dictionary _get_requested_extensions ( ) virtual

Returns a Dictionary of OpenXR extensions related to this extension. The Dictionary should contain the name of the extension, mapped to a bool * cast to an integer:

  • If the bool * is a nullptr this extension is mandatory.

  • If the bool * points to a boolean, the boolean will be updated to true if the extension is enabled.


void _on_before_instance_created ( ) virtual

Called before the OpenXR instance is created.


bool _on_event_polled ( const void* event ) virtual

Called when there is an OpenXR event to process. When implementing, return true if the event was handled, return false otherwise.


void _on_instance_created ( int instance ) virtual

Called right after the OpenXR instance is created.


void _on_instance_destroyed ( ) virtual

Called right before the OpenXR instance is destroyed.


void _on_pre_render ( ) virtual

Called right before the XR viewports begin their rendering step.


void _on_process ( ) virtual

Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic.


void _on_register_metadata ( ) virtual

Allows extensions to register additional controller metadata. This function