Struct WebXrInterface

pub struct WebXrInterface { /* private fields */ }

Expand description

Godot class WebXRInterface.

Inherits XrInterface.

Related symbols:

web_xr_interface: sidecar module with related enum/flag types
SignalsOfWebXrInterface: signal collection

§Not instantiable

This class cannot be constructed. Obtain Gd<WebXrInterface> instances via Godot APIs.

§Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

Implementations§

§

impl WebXrInterface

pub fn is_session_supported(&mut self, session_mode: impl AsArg<GString>)

pub fn set_session_mode(&mut self, session_mode: impl AsArg<GString>)

pub fn get_session_mode(&self) -> GString

pub fn set_required_features(&mut self, required_features: impl AsArg<GString>)

pub fn get_required_features(&self) -> GString

pub fn set_optional_features(&mut self, optional_features: impl AsArg<GString>)

pub fn get_optional_features(&self) -> GString

pub fn get_reference_space_type(&self) -> GString

pub fn get_enabled_features(&self) -> GString

pub fn set_requested_reference_space_types( &mut self, requested_reference_space_types: impl AsArg<GString>, )

pub fn get_requested_reference_space_types(&self) -> GString

pub fn is_input_source_active(&self, input_source_id: i32) -> bool

pub fn get_input_source_tracker( &self, input_source_id: i32, ) -> Option<Gd<XrControllerTracker>>

pub fn get_input_source_target_ray_mode( &self, input_source_id: i32, ) -> TargetRayMode

pub fn get_visibility_state(&self) -> GString

pub fn get_display_refresh_rate(&self) -> f32

pub fn set_display_refresh_rate(&mut self, refresh_rate: f32)

pub fn get_available_display_refresh_rates(&self) -> Array<Variant>

Methods from Deref<Target = XrInterface>§

pub fn get_name(&self) -> StringName

pub fn get_capabilities(&self) -> u32

pub fn is_primary(&mut self) -> bool

pub fn set_primary(&mut self, primary: bool)

pub fn is_initialized(&self) -> bool

pub fn initialize(&mut self) -> bool

pub fn uninitialize(&mut self)

pub fn get_system_info(&mut self) -> Dictionary

pub fn get_tracking_status(&self) -> TrackingStatus

pub fn get_render_target_size(&mut self) -> Vector2

pub fn get_view_count(&mut self) -> u32

pub fn trigger_haptic_pulse( &mut self, action_name: impl AsArg<GString>, tracker_name: impl AsArg<StringName>, frequency: f64, amplitude: f64, duration_sec: f64, delay_sec: f64, )

pub fn supports_play_area_mode(&mut self, mode: PlayAreaMode) -> bool

pub fn get_play_area_mode(&self) -> PlayAreaMode

pub fn set_play_area_mode(&mut self, mode: PlayAreaMode) -> bool

pub fn get_play_area(&self) -> PackedArray<Vector3>

pub fn get_anchor_detection_is_enabled(&self) -> bool

pub fn set_anchor_detection_is_enabled(&mut self, enable: bool)

pub fn get_camera_feed_id(&mut self) -> i32

pub fn is_passthrough_supported(&mut self) -> bool

pub fn is_passthrough_enabled(&mut self) -> bool

pub fn start_passthrough(&mut self) -> bool

pub fn stop_passthrough(&mut self)

pub fn get_transform_for_view( &mut self, view: u32, cam_transform: Transform3D, ) -> Transform3D

pub fn get_projection_for_view( &mut self, view: u32, aspect: f64, near: f64, far: f64, ) -> Projection

pub fn get_supported_environment_blend_modes(&mut self) -> Array<Variant>

pub fn set_environment_blend_mode(&mut self, mode: EnvironmentBlendMode) -> bool

pub fn get_environment_blend_mode(&self) -> EnvironmentBlendMode

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

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

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

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

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

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

pub fn get_indexed(&self, property_path: impl AsArg<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: impl AsArg<StringName>) -> bool

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

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

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

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

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> 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: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

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.