Struct OpenXrApiExtension

pub struct OpenXrApiExtension { /* private fields */ }

Expand description

Godot class OpenXRAPIExtension.

Inherits RefCounted.

Related symbols:

open_xr_api_extension: sidecar module with related enum/flag types
IOpenXrApiExtension: virtual methods

§Construction

This class is reference-counted. You can create a new instance using OpenXrApiExtension::new_gd().

§Godot docs

OpenXRAPIExtension makes OpenXR available for GDExtension. It provides the OpenXR API to GDExtension through the get_instance_proc_addr method, and the OpenXR instance through get_instance.

It also provides methods for querying the status of OpenXR initialization, and helper methods for ease of use of the API with GDExtension.

Implementations§

§

impl OpenXrApiExtension

pub fn get_openxr_version(&self) -> u64

Returns the version of OpenXR that was initialized. Only valid after the OpenXR instance has been created. See XR_MAKE_VERSION for how the version is calculated.

pub fn get_instance(&self) -> u64

Returns the XrInstance created during the initialization of the OpenXR API.

pub fn get_system_id(&self) -> u64

Returns the ID of the system, which is an XrSystemId cast to an integer.

pub fn get_session(&self) -> u64

Returns the OpenXR session, which is an XrSession cast to an integer.

pub unsafe fn transform_from_pose( &mut self, pose: RawPtr<*const c_void>, ) -> Transform3D

§Godot docs

Creates a Transform3D from an XrPosef.

§Safety

This method has automatically been marked unsafe because it accepts raw pointers as parameters. If Godot does not document any safety requirements, make sure you understand the underlying semantics.

pub fn xr_result( &mut self, result: u64, format: impl AsArg<GString>, args: &AnyArray, ) -> bool

Returns true if the provided XrResult (cast to an integer) is successful. Otherwise returns false and prints the XrResult converted to a string, with the specified additional information.

pub fn openxr_is_enabled(check_run_in_editor: bool) -> bool

Returns true if OpenXR is enabled.

pub fn get_instance_proc_addr(&self, name: impl AsArg<GString>) -> u64

Returns the function pointer of the OpenXR function with the specified name, cast to an integer. If the function with the given name does not exist, the method returns 0.

Note: openxr/util.h contains utility macros for acquiring OpenXR functions, e.g. GDEXTENSION_INIT_XR_FUNC_V(xrCreateAction).

pub fn get_error_string(&self, result: u64) -> GString

Returns an error string for the given XrResult.

pub fn get_swapchain_format_name(&self, swapchain_format: i64) -> GString

Returns the name of the specified swapchain format.

pub fn set_object_name( &mut self, object_type: i64, object_handle: u64, object_name: impl AsArg<GString>, )

Set the object name of an OpenXR object, used for debug output. object_type must be a valid OpenXR XrObjectType enum and object_handle must be a valid OpenXR object handle.

pub fn begin_debug_label_region(&mut self, label_name: impl AsArg<GString>)

Begins a new debug label region, this label will be reported in debug messages for any calls following this until end_debug_label_region is called. Debug labels can be stacked.

pub fn end_debug_label_region(&mut self)

Marks the end of a debug label region. Removes the latest debug label region added by calling begin_debug_label_region.

pub fn insert_debug_label(&mut self, label_name: impl AsArg<GString>)

Inserts a debug label, this label is reported in any debug message resulting from the OpenXR calls that follows, until any of begin_debug_label_region, end_debug_label_region, or insert_debug_label is called.

pub fn is_initialized(&self) -> bool

Returns true if OpenXR is initialized.

pub fn is_running(&self) -> bool

Returns true if OpenXR is running (xrBeginSession was successfully called and the swapchains were created).

pub unsafe fn set_custom_play_space(&mut self, space: RawPtr<*const c_void>)

§Godot docs

Sets the reference space used by OpenXR to the given XrSpace (cast to a void *).

§Safety

This method has automatically been marked unsafe because it accepts raw pointers as parameters. If Godot does not document any safety requirements, make sure you understand the underlying semantics.

pub fn get_play_space(&self) -> u64

Returns the play space, which is an XrSpace cast to an integer.

pub fn get_predicted_display_time(&self) -> i64

Returns the predicted display timing for the current frame.

pub fn get_next_frame_time(&self) -> i64

Returns the predicted display timing for the next frame.

pub fn can_render(&mut self) -> bool

Returns true if OpenXR is initialized for rendering with an XR viewport.

pub fn find_action(&mut self, name: impl AsArg<GString>, action_set: Rid) -> Rid

Returns the RID corresponding to an Action of a matching name, optionally limited to a specified action set.

pub fn action_get_handle(&mut self, action: Rid) -> u64

Returns the corresponding XrAction OpenXR handle for the given action RID.

pub fn get_hand_tracker(&self, hand_index: i32) -> u64

Returns the corresponding XRHandTrackerEXT handle for the given hand index value.

pub fn register_composition_layer_provider( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Registers the given extension as a composition layer provider.

Note: This cannot be called after the OpenXR session has started. However, it can be called in on_session_created.

pub fn unregister_composition_layer_provider( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Unregisters the given extension as a composition layer provider.

Note: This cannot be called while the OpenXR session is still running.

pub fn register_projection_views_extension( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Registers the given extension as a provider of additional data structures to projections views.

Note: This cannot be called after the OpenXR session has started. However, it can be called in on_session_created.

pub fn unregister_projection_views_extension( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Unregisters the given extension as a provider of additional data structures to projections views.

Note: This cannot be called while the OpenXR session is still running.

pub fn register_frame_info_extension( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Registers the given extension as modifying frame info via the set_frame_wait_info_and_get_next_pointer_rawptr, set_view_locate_info_and_get_next_pointer_rawptr, or set_frame_end_info_and_get_next_pointer_rawptr virtual methods.

Note: This cannot be called after the OpenXR session has started. However, it can be called in on_session_created.

pub fn unregister_frame_info_extension( &mut self, extension: impl AsArg<Option<Gd<OpenXrExtensionWrapper>>>, )

Unregisters the given extension as modifying frame info.

Note: This cannot be called while the OpenXR session is still running.

pub fn get_render_state_z_near(&self) -> f64

Returns the near boundary value of the camera frustum.

Note: This is only accessible in the render thread.

pub fn get_render_state_z_far(&self) -> f64

Returns the far boundary value of the camera frustum.

Note: This is only accessible in the render thread.

pub fn set_velocity_texture(&mut self, render_target: Rid)

Sets the render target of the velocity texture.

pub fn set_velocity_depth_texture(&mut self, render_target: Rid)

Sets the render target of the velocity depth texture.

pub fn set_velocity_target_size(&mut self, target_size: Vector2i)

Sets the target size of the velocity and velocity depth textures.

pub fn get_supported_swapchain_formats(&self) -> PackedArray<i64>

Returns an array of supported swapchain formats.

pub fn openxr_swapchain_create( &mut self, create_flags: u64, usage_flags: u64, swapchain_format: i64, width: u32, height: u32, sample_count: u32, array_size: u32, ) -> u64

Returns a pointer to a new swapchain created using the provided parameters.

pub fn openxr_swapchain_free(&mut self, swapchain: u64)

Destroys the provided swapchain and frees it from memory.

pub fn openxr_swapchain_get_swapchain(&mut self, swapchain: u64) -> u64

Returns the XrSwapchain handle of the provided swapchain.

pub fn openxr_swapchain_acquire(&mut self, swapchain: u64)

Acquires the image of the provided swapchain.

pub fn openxr_swapchain_get_image(&mut self, swapchain: u64) -> Rid

Returns the RID of the provided swapchain’s image.

pub fn openxr_swapchain_release(&mut self, swapchain: u64)

Releases the image of the provided swapchain.

pub fn get_projection_layer(&self) -> u64

Returns a pointer to the render state’s XrCompositionLayerProjection struct.

Note: This method should only be called from the rendering thread.

pub fn set_render_region(&mut self, render_region: Rect2i)

Sets the render region to render_region, overriding the normal render target’s rect.

pub fn set_emulate_environment_blend_mode_alpha_blend(&mut self, enabled: bool)

If set to true, an OpenXR extension is loaded which is capable of emulating the EnvironmentBlendMode::ALPHA_BLEND blend mode.

pub fn is_environment_blend_mode_alpha_supported( &self, ) -> OpenXrAlphaBlendModeSupport

Returns [enum OpenXRAPIExtension.OpenXRAlphaBlendModeSupport] denoting if EnvironmentBlendMode::ALPHA_BLEND is really supported, emulated or not supported at all.

pub fn update_main_swapchain_size(&mut self)

Request the recommended resolution from the OpenXR runtime and update the main swapchain size if it has changed.

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Returns the current reference count.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.