Struct web_sys::VrDisplay

#[repr(transparent)]pub struct VrDisplay { /* fields omitted */ }

The VrDisplay class.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

Implementations

impl VrDisplay

pub fn is_connected(&self) -> bool

Getter for the isConnected field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn is_presenting(&self) -> bool

Getter for the isPresenting field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn capabilities(&self) -> VrDisplayCapabilities

Getter for the capabilities field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrDisplayCapabilities

impl VrDisplay

pub fn stage_parameters(&self) -> Option<VrStageParameters>

Getter for the stageParameters field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrStageParameters

impl VrDisplay

pub fn display_id(&self) -> u32

Getter for the displayId field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn display_name(&self) -> String

Getter for the displayName field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn depth_near(&self) -> f64

Getter for the depthNear field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn set_depth_near(&self, value: f64)

Setter for the depthNear field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn depth_far(&self) -> f64

Getter for the depthFar field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn set_depth_far(&self, value: f64)

Setter for the depthFar field of this object.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn cancel_animation_frame(&self, handle: i32) -> Result<(), JsValue>

The cancelAnimationFrame() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn exit_present(&self) -> Result<Promise, JsValue>

The exitPresent() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn get_eye_parameters(&self, which_eye: VrEye) -> VrEyeParameters

The getEyeParameters() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrEye, VrEyeParameters

impl VrDisplay

pub fn get_frame_data(&self, frame_data: &VrFrameData) -> bool

The getFrameData() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrFrameData

impl VrDisplay

pub fn get_layers(&self) -> Array

The getLayers() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn get_pose(&self) -> VrPose

The getPose() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrPose

impl VrDisplay

pub fn get_submit_frame_result(&self, result: &VrSubmitFrameResult) -> bool

The getSubmitFrameResult() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay, VrSubmitFrameResult

impl VrDisplay

pub fn request_animation_frame(
    &self,
    callback: &Function
) -> Result<i32, JsValue>

The requestAnimationFrame() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn request_present(&self, layers: &JsValue) -> Result<Promise, JsValue>

The requestPresent() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn reset_pose(&self)

The resetPose() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

impl VrDisplay

pub fn submit_frame(&self)

The submitFrame() method.

MDN Documentation

This API requires the following crate features to be activated: VrDisplay

Methods from Deref<Target = EventTarget>

pub fn add_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn dispatch_event(&self, event: &Event) -> Result<bool, JsValue>

The dispatchEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn remove_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn remove_event_listener_with_callback_and_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListenerOptions, EventTarget

pub fn remove_event_listener_with_event_listener_and_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventListenerOptions, EventTarget

pub fn remove_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method.

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

Trait Implementations

impl AsRef<EventTarget> for VrDisplay

fn as_ref(&self) -> &EventTarget

Performs the conversion.

impl AsRef<JsValue> for VrDisplay

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for VrDisplay

fn as_ref(&self) -> &Object

Performs the conversion.

impl AsRef<VrDisplay> for VrDisplay

fn as_ref(&self) -> &VrDisplay

Performs the conversion.

impl Clone for VrDisplay

fn clone(&self) -> VrDisplay

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VrDisplay

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

Formats the value using the given formatter.

impl Deref for VrDisplay

type Target = EventTarget

The resulting type after dereferencing.

fn deref(&self) -> &EventTarget

Dereferences the value.

impl Eq for VrDisplay

impl From<JsValue> for VrDisplay

fn from(obj: JsValue) -> VrDisplay

Performs the conversion.

impl From<VrDisplay> for JsValue

fn from(obj: VrDisplay) -> JsValue

Performs the conversion.

impl From<VrDisplay> for EventTarget

fn from(obj: VrDisplay) -> EventTarget

Performs the conversion.

impl From<VrDisplay> for Object

fn from(obj: VrDisplay) -> Object

Performs the conversion.

impl FromWasmAbi for VrDisplay

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for VrDisplay

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a VrDisplay

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for VrDisplay

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

pub fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

pub fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

pub fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

pub fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

pub fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

pub fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

pub fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl OptionFromWasmAbi for VrDisplay

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for VrDisplay

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a VrDisplay

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq<VrDisplay> for VrDisplay

fn eq(&self, other: &VrDisplay) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VrDisplay) -> bool

This method tests for !=.

impl RefFromWasmAbi for VrDisplay

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<VrDisplay>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl StructuralEq for VrDisplay

impl StructuralPartialEq for VrDisplay

impl WasmDescribe for VrDisplay

fn describe()