forte_engine 0.2.3

A core for a basic render/game engine designed to have little overhead.
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

/// The rust representation of all needed light information needed for shaders.
#[repr(C)]
#[derive(Debug, Clone, Copy, bytemuck::Pod, bytemuck::Zeroable)]
pub struct LightUniform {
    position: [f32; 3],
    range: f32,
    color: [f32; 3],
    exponent: f32,
    direction: [f32; 3],
    cutoff: f32
}

impl LightUniform {
    /// The bind group layout to be used for LightUniform.  This is here to promote consistency across implementations.
    pub const BIND_LAYOUT: wgpu::BindGroupLayoutDescriptor<'static> = wgpu::BindGroupLayoutDescriptor {
        entries: &[
            wgpu::BindGroupLayoutEntry {
                binding: 0,
                visibility: wgpu::ShaderStages::VERTEX_FRAGMENT,
                ty: wgpu::BindingType::Buffer {
                    ty: wgpu::BufferBindingType::Uniform,
                    has_dynamic_offset: false,
                    min_binding_size: None,
                },
                count: None,
            },
            wgpu::BindGroupLayoutEntry {
                binding: 1,
                visibility: wgpu::ShaderStages::VERTEX_FRAGMENT,
                ty: wgpu::BindingType::Buffer { 
                    ty: wgpu::BufferBindingType::Uniform, 
                    has_dynamic_offset: false, 
                    min_binding_size: None
                },
                count: None
            },
            wgpu::BindGroupLayoutEntry {
                binding: 2,
                visibility: wgpu::ShaderStages::VERTEX_FRAGMENT,
                ty: wgpu::BindingType::Buffer { 
                    ty: wgpu::BufferBindingType::Uniform, 
                    has_dynamic_offset: false, 
                    min_binding_size: None
                },
                count: None
            }
        ],
        label: Some("light_uniform_layout"),
    };

    /// Create a new light uniform.
    /// 
    /// Arguments:
    /// * position: [f32; 3] - The position of the light.
    /// * color: [f32; 3] - The color of the light.
    /// * direction: [f32; 3] - The direction of the light.  Only needed if cutoff is set, otherwise, leave as anything.
    /// * range: f32 - The range of the light in units.  If not needed, set to infinity.
    /// * exponent: f32 - The exponent of the light used to adjust how the light "bleeds off" over distance.  If not needed, leave as 0.
    /// * cutoff: f32 - The dot product at which a light will "cutoff".  This is usual for spot lights.  If no cut off needed, set this to higher than 100.
    /// 
    /// Returns a new light uniform.
    pub fn new(position: [f32; 3], color: [f32; 3], direction: [f32; 3], range: f32, exponent: f32, cutoff: f32) -> Self {
        Self { position, color, range, exponent, direction, cutoff }
    }
}