Struct gdnative_bindings_lily::ARVRInterface

pub struct ARVRInterface { /* fields omitted */ }

core class ARVRInterface inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

ARVRInterface inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl ARVRInterface

Constants

pub const ARVR_AR: i64

pub const ARVR_EXCESSIVE_MOTION: i64

pub const ARVR_EXTERNAL: i64

pub const ARVR_INSUFFICIENT_FEATURES: i64

pub const ARVR_MONO: i64

pub const ARVR_NONE: i64

pub const ARVR_NORMAL_TRACKING: i64

pub const ARVR_NOT_TRACKING: i64

pub const ARVR_STEREO: i64

pub const ARVR_UNKNOWN_TRACKING: i64

pub const EYE_LEFT: i64

pub const EYE_MONO: i64

pub const EYE_RIGHT: i64

impl ARVRInterface

pub fn anchor_detection_is_enabled(&self) -> bool

On an AR interface, true if anchor detection is enabled.

pub fn get_camera_feed_id(&self) -> i64

If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the CameraServer for this interface.

pub fn get_capabilities(&self) -> i64

Returns a combination of [enum Capabilities] flags providing information about the capabilities of this interface.

pub fn get_name(&self) -> GodotString

Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).

pub fn get_render_targetsize(&self) -> Vector2

Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.

pub fn get_tracking_status(&self) -> TrackingStatus

If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.

pub fn initialize(&self) -> bool

Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence. Note: You must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot, such as for mobile VR. If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively, you can add a separate viewport node to your scene and enable AR/VR on that viewport. It will be used to output to the HMD, leaving you free to do anything you like in the main window, such as using a separate camera as a spectator camera or rendering something completely different. While currently not used, you can activate additional interfaces. You may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD.

pub fn is_initialized(&self) -> bool

true if this interface been initialized.

pub fn is_primary(&self) -> bool

true if this is the primary interface.

pub fn is_stereo(&self) -> bool

Returns true if the current output of this interface is in stereo.

pub fn set_anchor_detection_is_enabled(&self, enable: bool)

On an AR interface, true if anchor detection is enabled.

pub fn set_is_initialized(&self, initialized: bool)

true if this interface been initialized.

pub fn set_is_primary(&self, enable: bool)

true if this is the primary interface.

pub fn uninitialize(&self)

Turns the interface off.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful.

Trait Implementations

impl Debug for ARVRInterface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ARVRInterface

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for ARVRInterface

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for ARVRInterface

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Sealed for ARVRInterface

impl SubClass<ARVRInterface> for ARVRInterfaceGDNative

impl SubClass<ARVRInterface> for WebXRInterface

impl SubClass<ARVRInterface> for MobileVRInterface

impl SubClass<Object> for ARVRInterface

impl SubClass<Reference> for ARVRInterface