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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use super::*;
use std::collections::HashMap;

//  TODO docs ALL OF THIS!

/// A compute pass that is later compiled with [`Context::compile_compute_pass`].
#[derive(Default, Debug, Clone, Hash, PartialEq, Eq)]
pub struct ComputePass {
    pub(crate) programs: Vec<ComputeProgramId>,
    pub(crate) set_blocking: bool,
}

impl ComputePass {
    pub fn new() -> Self {
        ComputePass::default()
    }

    /// Registers compute programs that can then be bound to dispatches later.
    pub fn add_program(&mut self, program: ComputeProgramId) -> &mut Self {
        self.programs.push(program);
        self
    }

    /// A hint for whether this pass must complete before the next one.
    /// Although this is a hint, please use it anyway to reduce platform-specific bugs.
    /// This option is `false` by default.
    pub fn set_blocking(&mut self, set: bool) -> &mut Self {
        self.set_blocking = set;
        self
    }
}

/// Configure options regarding compute dispatches such as dynamic buffer indices, the
/// bound program, work group counts, etc.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Dispatch {
    pub(crate) ty: DispatchType,
    pub(crate) program: ComputeProgramId,

    pub(crate) workgroup_count_x: usize,
    pub(crate) workgroup_count_y: usize,
    pub(crate) workgroup_count_z: usize,

    pub(crate) dynamic_buffer_indices: HashMap<DynamicGenericBufferId, usize>,
}

impl Dispatch {
    /// Set the index to use for a dynamic uniform buffer for this dispatch.
    /// If you are using a dynamic uniform buffer, this option is MANDITORY.
    pub fn set_dynamic_uniform_buffer_index(
        &mut self,
        ubo: DynamicUniformBufferId,
        index: usize,
    ) -> &mut Self {
        self.dynamic_buffer_indices
            .insert(DynamicGenericBufferId::Uniform(ubo), index);
        self
    }
}

#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub enum DispatchType {
    Blocking,
    NonBlocking,
}

/// Submit data for compute passes.
#[derive(Debug, Clone)]
pub struct ComputePassSubmitData {
    pub(crate) compute_pass: CompiledComputePassId,
    pub(crate) dispatches: Vec<Dispatch>,
}

impl ComputePassSubmitData {
    pub fn new(compute_pass: CompiledComputePassId) -> Self {
        ComputePassSubmitData {
            compute_pass,
            dispatches: vec![],
        }
    }

    /// Fills in the basic options for a non-blocking dispatch.
    /// Subsequent dispatches MAY NOT wait for this one.
    /// Also returns a [`Dispatch`] with additional options.
    pub fn dispatch(
        &mut self,
        compute_program: ComputeProgramId,
        workgroup_count_x: usize,
        workgroup_count_y: usize,
        workgroup_count_z: usize,
    ) -> &mut Dispatch {
        self.dispatches.push(Dispatch {
            ty: DispatchType::NonBlocking,
            program: compute_program,
            workgroup_count_x,
            workgroup_count_y,
            workgroup_count_z,
            dynamic_buffer_indices: HashMap::new(),
        });
        self.dispatches.last_mut().unwrap()
    }

    /// Fills in the basic options for dispatches.
    /// Subsequent dispatches much wait for this one.
    /// Also returns a [`Dispatch`] with additional options.
    pub fn dispatch_blocking(
        &mut self,
        compute_program: ComputeProgramId,
        workgroup_count_x: usize,
        workgroup_count_y: usize,
        workgroup_count_z: usize,
    ) -> &mut Dispatch {
        self.dispatches.push(Dispatch {
            ty: DispatchType::Blocking,
            program: compute_program,
            workgroup_count_x,
            workgroup_count_y,
            workgroup_count_z,
            dynamic_buffer_indices: HashMap::new(),
        });
        self.dispatches.last_mut().unwrap()
    }
}

/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct NewComputeProgramExt {}
/// Currently has extra extension options.
#[derive(Default, Debug, Clone)]
pub struct CompileComputePassExt {}

impl Context {
    pub fn new_compute_program(
        &mut self,
        code: &[u8],
        uniforms: &[ShaderUniform],
        ext: Option<NewComputeProgramExt>,
    ) -> GResult<ComputeProgramId> {
        match self {
            Context::Vulkan(vk) => vk.new_compute_program(code, uniforms, ext),
            Context::WebGpu(wgpu) => wgpu.new_compute_program(code, uniforms, ext),
        }
    }

    pub fn compile_compute_pass(
        &mut self,
        compute_pass: ComputePass,
        ext: Option<CompileComputePassExt>,
    ) -> GResult<CompiledComputePassId> {
        match self {
            Context::Vulkan(vk) => vk.compile_compute_pass(compute_pass, ext),
            Context::WebGpu(wgpu) => wgpu.compile_compute_pass(compute_pass, ext),
        }
    }
}