Struct bevy::pbr::MeshPipelineKey

pub struct MeshPipelineKey(/* private fields */);

MSAA uses the highest 3 bits for the MSAA log2(sample count) to support up to 128x MSAA.

Implementations

impl MeshPipelineKey

pub const NONE: MeshPipelineKey = _

pub const MORPH_TARGETS: MeshPipelineKey = _

pub const HDR: MeshPipelineKey = _

pub const TONEMAP_IN_SHADER: MeshPipelineKey = _

pub const DEBAND_DITHER: MeshPipelineKey = _

pub const DEPTH_PREPASS: MeshPipelineKey = _

pub const NORMAL_PREPASS: MeshPipelineKey = _

pub const DEFERRED_PREPASS: MeshPipelineKey = _

pub const MOTION_VECTOR_PREPASS: MeshPipelineKey = _

pub const MAY_DISCARD: MeshPipelineKey = _

pub const ENVIRONMENT_MAP: MeshPipelineKey = _

pub const SCREEN_SPACE_AMBIENT_OCCLUSION: MeshPipelineKey = _

pub const DEPTH_CLAMP_ORTHO: MeshPipelineKey = _

pub const TEMPORAL_JITTER: MeshPipelineKey = _

pub const READS_VIEW_TRANSMISSION_TEXTURE: MeshPipelineKey = _

pub const LIGHTMAPPED: MeshPipelineKey = _

pub const IRRADIANCE_VOLUME: MeshPipelineKey = _

pub const VISIBILITY_RANGE_DITHER: MeshPipelineKey = _

pub const LAST_FLAG: MeshPipelineKey = _

pub const MSAA_RESERVED_BITS: MeshPipelineKey = _

pub const BLEND_RESERVED_BITS: MeshPipelineKey = _

pub const BLEND_OPAQUE: MeshPipelineKey = _

pub const BLEND_PREMULTIPLIED_ALPHA: MeshPipelineKey = _

pub const BLEND_MULTIPLY: MeshPipelineKey = _

pub const BLEND_ALPHA: MeshPipelineKey = _

pub const BLEND_ALPHA_TO_COVERAGE: MeshPipelineKey = _

pub const TONEMAP_METHOD_RESERVED_BITS: MeshPipelineKey = _

pub const TONEMAP_METHOD_NONE: MeshPipelineKey = _

pub const TONEMAP_METHOD_REINHARD: MeshPipelineKey = _

pub const TONEMAP_METHOD_REINHARD_LUMINANCE: MeshPipelineKey = _

pub const TONEMAP_METHOD_ACES_FITTED: MeshPipelineKey = _

pub const TONEMAP_METHOD_AGX: MeshPipelineKey = _

pub const TONEMAP_METHOD_SOMEWHAT_BORING_DISPLAY_TRANSFORM: MeshPipelineKey = _

pub const TONEMAP_METHOD_TONY_MC_MAPFACE: MeshPipelineKey = _

pub const TONEMAP_METHOD_BLENDER_FILMIC: MeshPipelineKey = _

pub const SHADOW_FILTER_METHOD_RESERVED_BITS: MeshPipelineKey = _

pub const SHADOW_FILTER_METHOD_HARDWARE_2X2: MeshPipelineKey = _

pub const SHADOW_FILTER_METHOD_GAUSSIAN: MeshPipelineKey = _

pub const SHADOW_FILTER_METHOD_TEMPORAL: MeshPipelineKey = _

pub const VIEW_PROJECTION_RESERVED_BITS: MeshPipelineKey = _

pub const VIEW_PROJECTION_NONSTANDARD: MeshPipelineKey = _

pub const VIEW_PROJECTION_PERSPECTIVE: MeshPipelineKey = _

pub const VIEW_PROJECTION_ORTHOGRAPHIC: MeshPipelineKey = _

pub const VIEW_PROJECTION_RESERVED: MeshPipelineKey = _

pub const SCREEN_SPACE_SPECULAR_TRANSMISSION_RESERVED_BITS: MeshPipelineKey = _

pub const SCREEN_SPACE_SPECULAR_TRANSMISSION_LOW: MeshPipelineKey = _

pub const SCREEN_SPACE_SPECULAR_TRANSMISSION_MEDIUM: MeshPipelineKey = _

pub const SCREEN_SPACE_SPECULAR_TRANSMISSION_HIGH: MeshPipelineKey = _

pub const SCREEN_SPACE_SPECULAR_TRANSMISSION_ULTRA: MeshPipelineKey = _

pub const ALL_RESERVED_BITS: MeshPipelineKey = _

impl 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) -> u64

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> 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: u64) -> MeshPipelineKey

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> 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<GpuMesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut SortedRenderPhase<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.render_mesh_queue_data(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.translation),
                batch_range: 0..1,
                extra_index: PhaseItemExtraIndex::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<GpuMesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut SortedRenderPhase<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.render_mesh_queue_data(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.translation),
                batch_range: 0..1,
                extra_index: PhaseItemExtraIndex::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 137)

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<GpuMesh>>,
    render_mesh_instances: Res<RenderMeshInstances>,
    material_meshes: Query<Entity, With<InstanceMaterialData>>,
    mut views: Query<(&ExtractedView, &mut SortedRenderPhase<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.render_mesh_queue_data(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.translation),
                batch_range: 0..1,
                extra_index: PhaseItemExtraIndex::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.

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

Performs copy-assignment from source.

impl Debug for MeshPipelineKey

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

Formats the value using the given formatter.

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.

impl Flags for MeshPipelineKey

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> 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.

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.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

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 (&!).

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 (&!).

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.

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 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.

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 ==.

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