aleatico 0.1.1

stub package for furmint engine graphics
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use crate::define_store;
use crate::errors::AleaticoResult;
use crate::renderer::resources::pipelines::PipelineId;
use crate::renderer::resources::texture::TextureId;

define_store!(Material);

/// Descriptor to create a material
#[derive(Debug, Clone)]
pub struct MaterialDescriptor {
    /// Material debug label
    pub label: Option<String>,
    /// Textures of this material
    pub textures: MaterialTextures,
}

/// Possible textures of a material
#[derive(Debug, Default, Clone)]
pub struct MaterialTextures {
    /// Albedo texture
    pub albedo: Option<TextureId>,
    /// Normal map
    pub normal: Option<TextureId>,
}

impl MaterialDescriptor {
    /// Create a new [`MaterialDescriptor`]
    pub fn new() -> Self {
        Self {
            label: None,
            textures: MaterialTextures::default(),
        }
    }

    /// Create a new [`MaterialDescriptor`] with an albedo texture
    pub fn textured(albedo: TextureId) -> Self {
        Self {
            textures: MaterialTextures {
                albedo: Some(albedo),
                ..MaterialTextures::default()
            },
            ..Self::new()
        }
    }

    /// Set label
    pub fn with_label(mut self, label: impl Into<String>) -> Self {
        self.label = Some(label.into());
        self
    }

    /// Set albedo texture
    pub fn with_albedo(mut self, texture: TextureId) -> Self {
        self.textures.albedo = Some(texture);
        self
    }

    /// Set normal map texture
    pub fn with_normal(mut self, texture: TextureId) -> Self {
        self.textures.normal = Some(texture);
        self
    }
}

/// Represents a material
pub struct Material {
    /// Material debug label
    #[allow(unused)]
    pub(crate) label: Option<String>,
    /// Assigned pipeline ID
    pub(crate) pipeline_id: PipelineId,
    /// Textures of this material
    pub(crate) textures: MaterialTextures,
}

impl Material {
    /// Create a new [`Material`]
    pub fn new(pipeline_id: PipelineId, descriptor: MaterialDescriptor) -> AleaticoResult<Self> {
        Ok(Self {
            label: descriptor.label,
            pipeline_id,
            textures: descriptor.textures,
        })
    }
}