mepeyew 0.3.5

mepeyew - Small But Powerful Graphics Library
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use super::*;
use std::marker::PhantomData;

/// Defines the stride of each vbo item.
/// ```
/// [A, A, A, B, B, C, C, C]
///         ^3   ^2       ^3
///
/// let _ = VertexBufferInput {
///     args: vec![3, 2, 3],
/// };
/// ```
#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub struct VertexBufferInput {
    pub args: Vec<usize>,
}

/// Whether you plan on dynamically upload to a buffer later on.
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum BufferStorageType {
    Static,
    Dynamic,
}

/// The expected type of all vertex buffers.
pub type VertexBufferElement = f32;
/// The expected type of all index buffers.
pub type IndexBufferElement = u32;

/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct NewVertexBufferExt {}
/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct NewIndexBufferExt {}
/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct NewUniformBufferExt {}
/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct NewDynamicUniformBufferExt {}

/// Use to ensure that the correct type is used later when accessing data.
/// This guard is merely a design decision and serves no other purpose.
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub struct UniformBufferTypeGuard<T: Copy>(pub UniformBufferId, PhantomData<T>);
/// Use to ensure that the correct type is used later when accessing data.
/// This guard is merely a design decision and serves no other purpose.
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub struct DynamicUniformBufferTypeGuard<T: Copy>(pub DynamicUniformBufferId, PhantomData<T>);

impl Context {
    pub fn new_vertex_buffer(
        &mut self,
        data: &[VertexBufferElement],
        storage_type: BufferStorageType,
        ext: Option<NewVertexBufferExt>,
    ) -> GResult<VertexBufferId> {
        match self {
            Self::Vulkan(vk) => vk.new_vertex_buffer(data, storage_type, ext),
            Self::WebGpu(wgpu) => wgpu.new_vertex_buffer(data, storage_type, ext),
        }
    }

    pub fn new_index_buffer(
        &mut self,
        data: &[IndexBufferElement],
        storage_type: BufferStorageType,
        ext: Option<NewIndexBufferExt>,
    ) -> GResult<IndexBufferId> {
        match self {
            Self::Vulkan(vk) => vk.new_index_buffer(data, storage_type, ext),
            Self::WebGpu(wgpu) => wgpu.new_index_buffer(data, storage_type, ext),
        }
    }

    pub fn new_uniform_buffer<T: Copy>(
        &mut self,
        data: &T,
        ext: Option<NewUniformBufferExt>,
    ) -> GResult<(UniformBufferId, UniformBufferTypeGuard<T>)> {
        let id = match self {
            Self::Vulkan(vk) => vk.new_uniform_buffer::<T>(data, ext),
            Self::WebGpu(wgpu) => wgpu.new_uniform_buffer::<T>(data, ext),
        }?;

        Ok((id, UniformBufferTypeGuard(id, PhantomData)))
    }

    /// Create multiple uniforms in one which can then be bound with an index during submission
    /// using [Draw::set_dynamic_uniform_buffer_index] or [super::extensions::Dispatch::set_dynamic_uniform_buffer_index]
    /// for graphics and compute respectively.
    /// Setting this index later is MANDITORY.
    pub fn new_dynamic_uniform_buffer<T: Copy>(
        &mut self,
        data: &[T],
        ext: Option<NewDynamicUniformBufferExt>,
    ) -> GResult<(DynamicUniformBufferId, DynamicUniformBufferTypeGuard<T>)> {
        let id = match self {
            Self::Vulkan(vk) => vk.new_dynamic_uniform_buffer(data, ext),
            Self::WebGpu(wgpu) => wgpu.new_dynamic_uniform_buffer(data, ext),
        }?;

        Ok((id, DynamicUniformBufferTypeGuard(id, PhantomData)))
    }
}