Struct gdnative::api::ARVRInterfaceGDNative

pub struct ARVRInterfaceGDNative { /* fields omitted */ }

core class ARVRInterfaceGDNative inherits ARVRInterface (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

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

Class hierarchy

ARVRInterfaceGDNative inherits methods from:

• ARVRInterface
• 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 ARVRInterfaceGDNative

pub fn new() -> Ref<ARVRInterfaceGDNative, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

Methods from Deref<Target = ARVRInterface>

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

pub fn anchor_detection_is_enabled(&self) -> bool

pub fn get_camera_feed_id(&self) -> i64

pub fn get_capabilities(&self) -> i64

pub fn get_name(&self) -> GodotString

pub fn get_render_targetsize(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_tracking_status(&self) -> TrackingStatus

pub fn initialize(&self) -> bool

pub fn is_initialized(&self) -> bool

pub fn is_primary(&self) -> bool

pub fn is_stereo(&self) -> bool

pub fn set_anchor_detection_is_enabled(&self, enable: bool)

pub fn set_is_initialized(&self, initialized: bool)

pub fn set_is_primary(&self, enable: bool)

pub fn uninitialize(&self)

Trait Implementations

impl Debug for ARVRInterfaceGDNative

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

Formats the value using the given formatter.

impl Deref for ARVRInterfaceGDNative

type Target = ARVRInterface

The resulting type after dereferencing.

fn deref(&self) -> &ARVRInterface

Dereferences the value.

impl DerefMut for ARVRInterfaceGDNative

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

Mutably dereferences the value.

impl GodotObject for ARVRInterfaceGDNative

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.

impl Instanciable for ARVRInterfaceGDNative

fn construct() -> Ref<ARVRInterfaceGDNative, Unique>

impl SubClass<ARVRInterface> for ARVRInterfaceGDNative

impl SubClass<Object> for ARVRInterfaceGDNative

impl SubClass<Reference> for ARVRInterfaceGDNative