Struct MobileVrInterface
#[repr(C)]pub struct MobileVrInterface { /* private fields */ }
Expand description
Godot class MobileVRInterface.
Inherits XrInterface
.
Related symbols:
IMobileVrInterface
: virtual methods
See also Godot docs for MobileVRInterface
.
§Construction
This class is reference-counted. You can create a new instance using MobileVrInterface::new_gd()
.
Implementations§
§impl MobileVrInterface
impl MobileVrInterface
pub fn set_eye_height(&mut self, eye_height: f64)
pub fn get_eye_height(&self) -> f64
pub fn set_iod(&mut self, iod: f64)
pub fn get_iod(&self) -> f64
pub fn set_display_width(&mut self, display_width: f64)
pub fn get_display_width(&self) -> f64
pub fn set_display_to_lens(&mut self, display_to_lens: f64)
pub fn get_display_to_lens(&self) -> f64
pub fn set_offset_rect(&mut self, offset_rect: Rect2)
pub fn get_offset_rect(&self) -> Rect2
pub fn set_oversample(&mut self, oversample: f64)
pub fn get_oversample(&self) -> f64
pub fn set_k1(&mut self, k: f64)
pub fn get_k1(&self) -> f64
pub fn set_k2(&mut self, k: f64)
pub fn get_k2(&self) -> f64
pub fn get_vrs_min_radius(&self) -> f32
pub fn set_vrs_min_radius(&mut self, radius: f32)
pub fn get_vrs_strength(&self) -> f32
pub fn set_vrs_strength(&mut self, strength: f32)
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
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>)
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
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>
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
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>
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
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>
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
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
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)
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 MobileVrInterface
impl Bounds for MobileVrInterface
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for MobileVrInterface
impl Debug for MobileVrInterface
§impl Deref for MobileVrInterface
impl Deref for MobileVrInterface
§type Target = XrInterface
type Target = XrInterface
§fn deref(&self) -> &<MobileVrInterface as Deref>::Target
fn deref(&self) -> &<MobileVrInterface as Deref>::Target
§impl DerefMut for MobileVrInterface
impl DerefMut for MobileVrInterface
§fn deref_mut(&mut self) -> &mut <MobileVrInterface as Deref>::Target
fn deref_mut(&mut self) -> &mut <MobileVrInterface as Deref>::Target
§impl GodotClass for MobileVrInterface
impl GodotClass for MobileVrInterface
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§type Base = XrInterface
type Base = XrInterface
T
. This is always a Godot engine class.§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for MobileVrInterface
impl Inherits<Object> for MobileVrInterface
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<RefCounted> for MobileVrInterface
impl Inherits<RefCounted> for MobileVrInterface
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<XrInterface> for MobileVrInterface
impl Inherits<XrInterface> for MobileVrInterface
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for MobileVrInterface
impl WithSignals for MobileVrInterface
§type SignalCollection<'c, C: WithSignals> = SignalsOfXrInterface<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfXrInterface<'c, C>
impl GodotDefault for MobileVrInterface
Auto Trait Implementations§
impl Freeze for MobileVrInterface
impl RefUnwindSafe for MobileVrInterface
impl !Send for MobileVrInterface
impl !Sync for MobileVrInterface
impl Unpin for MobileVrInterface
impl UnwindSafe for MobileVrInterface
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more