Struct bevy::pbr::MeshPipelineKey

pub const fn empty() -> MeshPipelineKey

Get a flags value with all bits unset.

pub const fn all() -> MeshPipelineKey

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<MeshPipelineKey>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> MeshPipelineKey

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> MeshPipelineKey

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<MeshPipelineKey>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: MeshPipelineKey) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: MeshPipelineKey) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: MeshPipelineKey)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: MeshPipelineKey)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: MeshPipelineKey)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: MeshPipelineKey, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: MeshPipelineKey) -> MeshPipelineKey

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: MeshPipelineKey) -> MeshPipelineKey

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: MeshPipelineKey) -> MeshPipelineKey

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: MeshPipelineKey ) -> MeshPipelineKey

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> MeshPipelineKey

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MeshPipelineKey

pub const fn iter(&self) -> Iter<MeshPipelineKey>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MeshPipelineKey>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl MeshPipelineKey

pub fn from_msaa_samples(msaa_samples: u32) -> MeshPipelineKey

Examples found in repository ?

examples/shader/shader_instancing.rs (line 124)

fn queue_custom(
    transparent_3d_draw_functions: Res<DrawFunctions<Transparent3d>>,
    custom_pipeline: Res<CustomPipeline>,
    msaa: Res<Msaa>,
    mut pipelines: ResMut<SpecializedMeshPipelines<CustomPipeline>>,
    pipeline_cache: Res<PipelineCache>,
    meshes: Res<RenderAssets<Mesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent3d>)>,
) {
    let draw_custom = transparent_3d_draw_functions.read().id::<DrawCustom>();

    let msaa_key = MeshPipelineKey::from_msaa_samples(msaa.samples());

    for (view, mut transparent_phase) in &mut views {
        let view_key = msaa_key | MeshPipelineKey::from_hdr(view.hdr);
        let rangefinder = view.rangefinder3d();
        for entity in &material_meshes {
            let Some(mesh_instance) = render_mesh_instances.get(&entity) else {
                continue;
            };
            let Some(mesh) = meshes.get(mesh_instance.mesh_asset_id) else {
                continue;
            };
            let key = view_key | MeshPipelineKey::from_primitive_topology(mesh.primitive_topology);
            let pipeline = pipelines
                .specialize(&pipeline_cache, &custom_pipeline, key, &mesh.layout)
                .unwrap();
            transparent_phase.add(Transparent3d {
                entity,
                pipeline,
                draw_function: draw_custom,
                distance: rangefinder
                    .distance_translation(&mesh_instance.transforms.transform.translation),
                batch_range: 0..1,
                dynamic_offset: None,
            });
        }
    }
}

pub fn from_hdr(hdr: bool) -> MeshPipelineKey

Examples found in repository ?

examples/shader/shader_instancing.rs (line 127)

fn queue_custom(
    transparent_3d_draw_functions: Res<DrawFunctions<Transparent3d>>,
    custom_pipeline: Res<CustomPipeline>,
    msaa: Res<Msaa>,
    mut pipelines: ResMut<SpecializedMeshPipelines<CustomPipeline>>,
    pipeline_cache: Res<PipelineCache>,
    meshes: Res<RenderAssets<Mesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent3d>)>,
) {
    let draw_custom = transparent_3d_draw_functions.read().id::<DrawCustom>();

    let msaa_key = MeshPipelineKey::from_msaa_samples(msaa.samples());

    for (view, mut transparent_phase) in &mut views {
        let view_key = msaa_key | MeshPipelineKey::from_hdr(view.hdr);
        let rangefinder = view.rangefinder3d();
        for entity in &material_meshes {
            let Some(mesh_instance) = render_mesh_instances.get(&entity) else {
                continue;
            };
            let Some(mesh) = meshes.get(mesh_instance.mesh_asset_id) else {
                continue;
            };
            let key = view_key | MeshPipelineKey::from_primitive_topology(mesh.primitive_topology);
            let pipeline = pipelines
                .specialize(&pipeline_cache, &custom_pipeline, key, &mesh.layout)
                .unwrap();
            transparent_phase.add(Transparent3d {
                entity,
                pipeline,
                draw_function: draw_custom,
                distance: rangefinder
                    .distance_translation(&mesh_instance.transforms.transform.translation),
                batch_range: 0..1,
                dynamic_offset: None,
            });
        }
    }
}

pub fn msaa_samples(&self) -> u32

pub fn from_primitive_topology( primitive_topology: PrimitiveTopology ) -> MeshPipelineKey

Examples found in repository ?

examples/shader/shader_instancing.rs (line 136)

fn queue_custom(
    transparent_3d_draw_functions: Res<DrawFunctions<Transparent3d>>,
    custom_pipeline: Res<CustomPipeline>,
    msaa: Res<Msaa>,
    mut pipelines: ResMut<SpecializedMeshPipelines<CustomPipeline>>,
    pipeline_cache: Res<PipelineCache>,
    meshes: Res<RenderAssets<Mesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent3d>)>,
) {
    let draw_custom = transparent_3d_draw_functions.read().id::<DrawCustom>();

    let msaa_key = MeshPipelineKey::from_msaa_samples(msaa.samples());

    for (view, mut transparent_phase) in &mut views {
        let view_key = msaa_key | MeshPipelineKey::from_hdr(view.hdr);
        let rangefinder = view.rangefinder3d();
        for entity in &material_meshes {
            let Some(mesh_instance) = render_mesh_instances.get(&entity) else {
                continue;
            };
            let Some(mesh) = meshes.get(mesh_instance.mesh_asset_id) else {
                continue;
            };
            let key = view_key | MeshPipelineKey::from_primitive_topology(mesh.primitive_topology);
            let pipeline = pipelines
                .specialize(&pipeline_cache, &custom_pipeline, key, &mesh.layout)
                .unwrap();
            transparent_phase.add(Transparent3d {
                entity,
                pipeline,
                draw_function: draw_custom,
                distance: rangefinder
                    .distance_translation(&mesh_instance.transforms.transform.translation),
                batch_range: 0..1,
                dynamic_offset: None,
            });
        }
    }
}

pub fn primitive_topology(&self) -> PrimitiveTopology

Trait Implementations§

impl Binary for MeshPipelineKey

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

Formats the value using the given formatter.

impl BitAnd for MeshPipelineKey

fn bitand(self, other: MeshPipelineKey) -> MeshPipelineKey

The bitwise and (&) of the bits in two flags values.

type Output = MeshPipelineKey

The resulting type after applying the & operator.

impl BitAndAssign for MeshPipelineKey

fn bitand_assign(&mut self, other: MeshPipelineKey)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MeshPipelineKey

fn bitor(self, other: MeshPipelineKey) -> MeshPipelineKey

The bitwise or (|) of the bits in two flags values.

type Output = MeshPipelineKey

The resulting type after applying the | operator.

impl BitOrAssign for MeshPipelineKey

fn bitor_assign(&mut self, other: MeshPipelineKey)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MeshPipelineKey

fn bitxor(self, other: MeshPipelineKey) -> MeshPipelineKey

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MeshPipelineKey

The resulting type after applying the ^ operator.

impl BitXorAssign for MeshPipelineKey

fn bitxor_assign(&mut self, other: MeshPipelineKey)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MeshPipelineKey

fn clone(&self) -> MeshPipelineKey

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for MeshPipelineKey

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

Formats the value using the given formatter. Read more

impl Extend<MeshPipelineKey> for MeshPipelineKey

fn extend<T>(&mut self, iterator: T)
where T: IntoIterator<Item = MeshPipelineKey>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

impl Flags for MeshPipelineKey

const FLAGS: &'static [Flag<MeshPipelineKey>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value. Read more

fn from_bits_retain(bits: u32) -> MeshPipelineKey

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<MeshPipelineKey> for MeshPipelineViewLayoutKey

fn from(value: MeshPipelineKey) -> MeshPipelineViewLayoutKey

Converts to this type from the input type.

impl FromIterator<MeshPipelineKey> for MeshPipelineKey

fn from_iter<T>(iterator: T) -> MeshPipelineKey
where T: IntoIterator<Item = MeshPipelineKey>,

The bitwise or (|) of the bits in each flags value.

impl Hash for MeshPipelineKey

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl IntoIterator for MeshPipelineKey

type Item = MeshPipelineKey

The type of the elements being iterated over.

type IntoIter = Iter<MeshPipelineKey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <MeshPipelineKey as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl LowerHex for MeshPipelineKey

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

Formats the value using the given formatter.

impl Not for MeshPipelineKey

fn not(self) -> MeshPipelineKey

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MeshPipelineKey

The resulting type after applying the ! operator.

impl Octal for MeshPipelineKey

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

Formats the value using the given formatter.

impl PartialEq for MeshPipelineKey

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

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

1.0.0 · source§

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

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

impl Sub for MeshPipelineKey

fn sub(self, other: MeshPipelineKey) -> MeshPipelineKey

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MeshPipelineKey

The resulting type after applying the - operator.

impl SubAssign for MeshPipelineKey

fn sub_assign(&mut self, other: MeshPipelineKey)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MeshPipelineKey

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

Formats the value using the given formatter.

impl Copy for MeshPipelineKey

impl Eq for MeshPipelineKey

impl StructuralPartialEq for MeshPipelineKey

Auto Trait Implementations§

impl Freeze for MeshPipelineKey

impl RefUnwindSafe for MeshPipelineKey

impl Send for MeshPipelineKey

impl Sync for MeshPipelineKey

impl Unpin for MeshPipelineKey

impl UnwindSafe for MeshPipelineKey

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for T
where U: ShaderType, &'a T: for<'a> Into,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.