Enum GlFenceBehavior

pub enum GlFenceBehavior {
    Normal,
    AutoFinish,
}

Dictate the behavior of fences in OpenGL.

Variants

Normal

Fences in OpenGL behave normally. If you don’t know what to pick, this is what you want.

AutoFinish

Fences in OpenGL are short-circuited to always return true immediately.

This solves a very specific issue that arose due to a bug in wgpu-core that made many WebGL programs work when they “shouldn’t” have. If you have code that is trying to call device.poll(wgpu::PollType::Wait) on WebGL, you need to enable this option for the “Wait” to behave how you would expect.

Previously all poll(Wait) acted like the OpenGL fences were signalled even if they weren’t. See https://github.com/gfx-rs/wgpu/issues/4589 for more information.

When this is set Queue::on_completed_work_done will always return the next time the device is maintained, not when the work is actually done on the GPU.

Implementations

impl GlFenceBehavior

pub fn is_auto_finish(&self) -> bool

Returns true if the fence behavior is AutoFinish.

pub fn is_normal(&self) -> bool

Returns true if the fence behavior is Normal.

pub fn from_env() -> Option<Self>

Choose which minor OpenGL ES version to use from the environment variable WGPU_GL_FENCE_BEHAVIOR.

Possible values are Normal or AutoFinish. Case insensitive.

Use with unwrap_or_default() to get the default value if the environment variable is not set.

pub fn with_env(self) -> Self

Takes the given compiler, modifies it based on the WGPU_GL_FENCE_BEHAVIOR environment variable, and returns the result.

See from_env for more information.

Trait Implementations

impl Clone for GlFenceBehavior

fn clone(&self) -> GlFenceBehavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlFenceBehavior

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

Formats the value using the given formatter.

impl Default for GlFenceBehavior

fn default() -> GlFenceBehavior

Returns the “default value” for a type.

impl PartialEq for GlFenceBehavior

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GlFenceBehavior

impl Eq for GlFenceBehavior

impl StructuralPartialEq for GlFenceBehavior