Struct webgl_stdweb::WEBGL_lose_context

pub struct WEBGL_lose_context(_);

Extension

This extension exposes new functions which simulate losing and restoring the WebGL context, even on platforms where the context can never be lost. Consult the WebGL specification for documentation about the webglcontextlost and webglcontextrestored events.

When this extension is enabled:

• loseContext and restoreContext are allowed to generate INVALID_OPERATION errors even when the context is lost.

Note that this extension is not disconnected from the WebGLRenderingContext if that object loses its context as described in "The Context Lost Event" of the WebGL specification, either through use of this API or via actual circumstances such as a system failure.

Methods

impl WEBGL_lose_context

pub fn lose_context(&self)

When this function is called and the context is not lost, simulate losing the context so as to trigger the steps described in the WebGL spec for handling context lost. The context will remain in the lost state according to the WebGL specification until restoreContext() is called. If the context is already lost when this function is called, generate an INVALID_OPERATION error.

Implementations should destroy the underlying graphics context and all graphics resources when this method is called. This is the recommended mechanism for applications to programmatically halt their use of the WebGL API.

pub fn restore_context(&self)

When this function is called while the context is lost, and the conditions defined by the WebGL specification for restoring the context are met, simulate the context being restored so as to trigger the steps described in the WebGL spec for handling the context being restored. If the context is already restored when this function is called, or if the conditions in the WebGL specification for restoring the context are not satisfied, or if the context was not lost via loseContext(), generate an INVALID_OPERATION error.

Trait Implementations

impl Debug for WEBGL_lose_context

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for WEBGL_lose_context

fn clone(&self) -> WEBGL_lose_context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<Reference> for WEBGL_lose_context

fn as_ref(&self) -> &Reference

Performs the conversion.

impl ReferenceType for WEBGL_lose_context

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl From<WEBGL_lose_context> for Reference

fn from(value: WEBGL_lose_context) -> Self

Performs the conversion.

impl TryFrom<WEBGL_lose_context> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: WEBGL_lose_context) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for WEBGL_lose_context

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for WEBGL_lose_context

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for WEBGL_lose_context

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for WEBGL_lose_context

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl JsSerialize for WEBGL_lose_context

impl JsSerializeOwned for WEBGL_lose_context

fn into_js_owned<'_a>(
    value: &'_a mut Option<Self>,
    arena: &'_a PreallocatedArena
) -> SerializedValue<'_a>

fn memory_required_owned(&self) -> usize

impl<'_r> JsSerializeOwned for &'_r WEBGL_lose_context

fn into_js_owned<'_a>(
    value: &'_a mut Option<Self>,
    arena: &'_a PreallocatedArena
) -> SerializedValue<'_a>

fn memory_required_owned(&self) -> usize

impl InstanceOf for WEBGL_lose_context

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl Extension for WEBGL_lose_context

const NAME: &'static str

NAME: &'static str = "WEBGL_lose_context"