bevy_material 0.19.0

Provides a material abstraction for Bevy Engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use bevy_ecs::world::World;
use bevy_mesh::{MeshVertexBufferLayoutRef, MissingVertexAttributeError};
use bevy_platform::sync::Arc;
use core::any::Any;
use thiserror::Error;

use crate::{
    descriptor::{CachedRenderPipelineId, RenderPipelineDescriptor},
    key::ErasedMaterialPipelineKey,
    MaterialProperties,
};

/// A type erased function pointer for specializing a material pipeline. The implementation is
/// expected to:
/// - Look up the appropriate specializer from the world
/// - Downcast the erased key to the concrete key type
/// - Call `SpecializedMeshPipelines::specialize` with the specializer and return the resulting pipeline id
pub type BaseSpecializeFn = fn(
    &mut World,
    ErasedMaterialPipelineKey,
    &MeshVertexBufferLayoutRef,
    &Arc<MaterialProperties>,
) -> Result<CachedRenderPipelineId, SpecializedMeshPipelineError>;

/// A type erased function pointer for specializing a material prepass pipeline. The implementation is
/// expected to:
/// - Look up the appropriate specializer from the world
/// - Downcast the erased key to the concrete key type
/// - Call `SpecializedMeshPipelines::specialize` with the specializer and return the resulting pipeline id
pub type PrepassSpecializeFn = fn(
    &mut World,
    ErasedMaterialPipelineKey,
    &MeshVertexBufferLayoutRef,
    &Arc<MaterialProperties>,
) -> Result<CachedRenderPipelineId, SpecializedMeshPipelineError>;

/// A type erased function pointer for specializing a material prepass pipeline. The implementation is
/// expected to:
/// - Look up the appropriate specializer from the world
/// - Downcast the erased key to the concrete key type
/// - Call `SpecializedMeshPipelines::specialize` with the specializer and return the resulting pipeline id
pub type UserSpecializeFn = fn(
    &dyn Any,
    &mut RenderPipelineDescriptor,
    &MeshVertexBufferLayoutRef,
    ErasedMaterialPipelineKey,
) -> Result<(), SpecializedMeshPipelineError>;

#[derive(Error, Debug)]
pub enum SpecializedMeshPipelineError {
    #[error(transparent)]
    MissingVertexAttribute(#[from] MissingVertexAttributeError),
}