Struct godot::classes::OpenXrApiExtension
#[repr(C)]pub struct OpenXrApiExtension { /* private fields */ }
Expand description
Godot class OpenXRAPIExtension.
Inherits RefCounted
.
Related symbols:
open_xr_api_extension
: sidecar module with related enum/flag typesIOpenXrApiExtension
: virtual methods
See also Godot docs for OpenXRAPIExtension
.
§Construction
This class is reference-counted. You can create a new instance using OpenXrApiExtension::new_gd()
.
Implementations§
§impl OpenXrApiExtension
impl OpenXrApiExtension
pub fn get_instance(&mut self) -> u64
pub fn get_system_id(&mut self) -> u64
pub fn get_session(&mut self) -> u64
pub unsafe fn transform_from_pose(&mut self, pose: *const c_void) -> Transform3D
pub unsafe fn transform_from_pose(&mut self, pose: *const c_void) -> Transform3D
§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: GString, args: OutArray, ) -> bool
pub fn openxr_is_enabled(check_run_in_editor: bool) -> bool
pub fn get_instance_proc_addr(&mut self, name: GString) -> u64
pub fn get_error_string(&mut self, result: u64) -> GString
pub fn get_swapchain_format_name(&mut self, swapchain_format: i64) -> GString
pub fn is_initialized(&mut self) -> bool
pub fn is_running(&mut self) -> bool
pub fn get_play_space(&mut self) -> u64
pub fn get_predicted_display_time(&mut self) -> i64
pub fn get_next_frame_time(&mut self) -> i64
pub fn can_render(&mut self) -> bool
pub fn get_hand_tracker(&mut self, hand_index: i32) -> u64
pub fn register_composition_layer_provider( &mut self, extension: Gd<OpenXrExtensionWrapperExtension>, )
pub fn unregister_composition_layer_provider( &mut self, extension: Gd<OpenXrExtensionWrapperExtension>, )
pub fn set_emulate_environment_blend_mode_alpha_blend(&mut self, enabled: bool)
pub fn is_environment_blend_mode_alpha_supported( &mut self, ) -> OpenXrAlphaBlendModeSupport
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: GString) -> bool
pub fn set(&mut self, property: StringName, value: Variant)
pub fn get(&self, property: StringName) -> Variant
pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)
pub fn get_indexed(&self, property_path: NodePath) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: StringName) -> bool
pub fn property_get_revert(&self, property: StringName) -> Variant
pub fn set_script(&mut self, script: Variant)
pub fn get_script(&self) -> Variant
pub fn set_meta(&mut self, name: StringName, value: Variant)
pub fn remove_meta(&mut self, name: StringName)
pub fn get_meta(&self, name: StringName) -> Variant
pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>
pub fn has_meta(&self, name: StringName) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: GString)
pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>
pub fn has_user_signal(&self, signal: StringName) -> bool
pub fn remove_user_signal(&mut self, signal: StringName)
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: StringName,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred(&mut self, property: StringName, value: Variant)
pub fn callv(&mut self, method: StringName, arg_array: OutArray) -> Variant
pub fn has_method(&self, method: StringName) -> bool
pub fn get_method_argument_count(&self, method: StringName) -> i32
pub fn has_signal(&self, signal: StringName) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>
pub fn disconnect(&mut self, signal: StringName, callable: Callable)
pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: StringName) -> GString
pub fn tr_ex(&self, message: StringName) -> ExTr<'_>
pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString
pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for OpenXrApiExtension
impl Bounds for OpenXrApiExtension
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for OpenXrApiExtension
impl Debug for OpenXrApiExtension
§impl Deref for OpenXrApiExtension
impl Deref for OpenXrApiExtension
§type Target = RefCounted
type Target = RefCounted
§fn deref(&self) -> &<OpenXrApiExtension as Deref>::Target
fn deref(&self) -> &<OpenXrApiExtension as Deref>::Target
§impl DerefMut for OpenXrApiExtension
impl DerefMut for OpenXrApiExtension
§fn deref_mut(&mut self) -> &mut <OpenXrApiExtension as Deref>::Target
fn deref_mut(&mut self) -> &mut <OpenXrApiExtension as Deref>::Target
§impl GodotClass for OpenXrApiExtension
impl GodotClass for OpenXrApiExtension
§type Base = RefCounted
type Base = RefCounted
T
. This is always a Godot engine class.