Struct webgl_stdweb::WEBGL_lose_context
source · pub struct WEBGL_lose_context(_);
Expand description
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.
Implementations
sourceimpl WEBGL_lose_context
impl WEBGL_lose_context
sourcepub fn lose_context(&self)
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.
sourcepub fn restore_context(&self)
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
sourceimpl AsRef<Reference> for WEBGL_lose_context
impl AsRef<Reference> for WEBGL_lose_context
sourceimpl Clone for WEBGL_lose_context
impl Clone for WEBGL_lose_context
sourcefn clone(&self) -> WEBGL_lose_context
fn clone(&self) -> WEBGL_lose_context
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for WEBGL_lose_context
impl Debug for WEBGL_lose_context
sourceimpl From<WEBGL_lose_context> for Reference
impl From<WEBGL_lose_context> for Reference
sourcefn from(value: WEBGL_lose_context) -> Self
fn from(value: WEBGL_lose_context) -> Self
sourceimpl InstanceOf for WEBGL_lose_context
impl InstanceOf for WEBGL_lose_context
sourcefn instance_of(_reference: &Reference) -> bool
fn instance_of(_reference: &Reference) -> bool
Self
.