Enum LoadOp

#[repr(u8)]
pub enum LoadOp<V> {
    Clear(V),
    Load = 1,
    DontCare(LoadOpDontCare),
}

Operation to perform to the output attachment at the start of a render pass.

Corresponds to WebGPU GPULoadOp, plus the corresponding clearValue.

Variants

Clear(V)

Loads the specified value for this attachment into the render pass.

On some GPU hardware (primarily mobile), “clear” is significantly cheaper because it avoids loading data from main memory into tile-local memory.

On other GPU hardware, there isn’t a significant difference.

As a result, it is recommended to use “clear” rather than “load” in cases where the initial value doesn’t matter (e.g. the render target will be cleared using a skybox).

Load = 1

Loads the existing value for this attachment into the render pass.

DontCare(LoadOpDontCare)

The render target has undefined contents at the start of the render pass. This may lead to undefined behavior if you read from the any of the render target pixels without first writing to them.

Blending also becomes undefined behavior if the source pixels are undefined.

This is the fastest option on all GPUs if you always overwrite all pixels in the render target after this load operation.

Backends that don’t support DontCare internally, will pick a different (unspecified) load op instead.

Safety

• All pixels in the render target must be written to before any read or a StoreOp::Store occurs.

Implementations

impl<V> LoadOp<V>

pub fn eq_variant<T>(&self, other: LoadOp<T>) -> bool

Returns true if variants are same (ignoring clear value)

Trait Implementations

impl<V> Clone for LoadOp<V>

where V: Clone,

fn clone(&self) -> LoadOp<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for LoadOp<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V> Default for LoadOp<V>

where V: Default,

fn default() -> LoadOp<V>

Returns the “default value” for a type.

impl<'de, V> Deserialize<'de> for LoadOp<V>

where V: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<LoadOp<V>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> Hash for LoadOp<V>

where V: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<V> PartialEq for LoadOp<V>

where V: PartialEq,

fn eq(&self, other: &LoadOp<V>) -> 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<V> Serialize for LoadOp<V>

where V: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V> Copy for LoadOp<V>

where V: Copy,

impl<V> Eq for LoadOp<V>

where V: Eq,

impl<V> StructuralPartialEq for LoadOp<V>