blade-graphics 0.8.0

Graphics abstraction for Blade
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use glow::HasContext as _;
use std::{ptr, slice};

impl super::Context {
    pub fn get_bottom_level_acceleration_structure_sizes(
        &self,
        _meshes: &[crate::AccelerationStructureMesh],
    ) -> crate::AccelerationStructureSizes {
        unimplemented!()
    }

    pub fn get_top_level_acceleration_structure_sizes(
        &self,
        _instance_count: u32,
    ) -> crate::AccelerationStructureSizes {
        unimplemented!()
    }

    pub fn create_acceleration_structure_instance_buffer(
        &self,
        _instances: &[crate::AccelerationStructureInstance],
        _bottom_level: &[super::AccelerationStructure],
    ) -> super::Buffer {
        unimplemented!()
    }
}

#[hidden_trait::expose]
impl crate::traits::ResourceDevice for super::Context {
    type Buffer = super::Buffer;
    type Texture = super::Texture;
    type TextureView = super::TextureView;
    type Sampler = super::Sampler;
    type AccelerationStructure = super::AccelerationStructure;

    fn create_buffer(&self, desc: crate::BufferDesc) -> super::Buffer {
        let gl = self.lock();

        let raw = unsafe { gl.create_buffer() }.unwrap();
        let mut data = ptr::null_mut();

        let mut storage_flags = 0;
        let mut map_flags = 0;
        let usage = match desc.memory {
            crate::Memory::Device => glow::STATIC_DRAW,
            crate::Memory::Shared => {
                map_flags = glow::MAP_READ_BIT | glow::MAP_WRITE_BIT | glow::MAP_PERSISTENT_BIT;
                storage_flags = glow::MAP_PERSISTENT_BIT
                    | glow::MAP_COHERENT_BIT
                    | glow::MAP_READ_BIT
                    | glow::MAP_WRITE_BIT;
                glow::DYNAMIC_DRAW //TEMP
            }
            crate::Memory::Upload => {
                map_flags =
                    glow::MAP_WRITE_BIT | glow::MAP_PERSISTENT_BIT | glow::MAP_UNSYNCHRONIZED_BIT;
                storage_flags =
                    glow::MAP_PERSISTENT_BIT | glow::MAP_COHERENT_BIT | glow::MAP_WRITE_BIT;
                glow::DYNAMIC_DRAW
            }
            crate::Memory::External(_) => unimplemented!(),
        };

        unsafe {
            gl.bind_buffer(glow::ARRAY_BUFFER, Some(raw));
            if self
                .capabilities
                .contains(super::Capabilities::BUFFER_STORAGE)
            {
                gl.buffer_storage(glow::ARRAY_BUFFER, desc.size as _, None, storage_flags);
                if map_flags != 0 {
                    data = gl.map_buffer_range(glow::ARRAY_BUFFER, 0, desc.size as _, map_flags);
                    assert!(!data.is_null());
                }
            } else {
                gl.buffer_data_size(glow::ARRAY_BUFFER, desc.size as _, usage);
                let data_vec = vec![0; desc.size as usize];
                data = Vec::leak(data_vec).as_mut_ptr();
            }
            gl.bind_buffer(glow::ARRAY_BUFFER, None);
            #[cfg(not(target_arch = "wasm32"))]
            if !desc.name.is_empty() && gl.supports_debug() {
                gl.object_label(
                    glow::BUFFER,
                    std::mem::transmute::<glow::NativeBuffer, u32>(raw),
                    Some(desc.name),
                );
            }
        }
        super::Buffer {
            raw,
            size: desc.size,
            data,
        }
    }

    fn sync_buffer(&self, buffer: super::Buffer) {
        if !self
            .capabilities
            .contains(super::Capabilities::BUFFER_STORAGE)
        {
            let gl = self.lock();
            unsafe {
                let data = slice::from_raw_parts(buffer.data, buffer.size as usize);
                gl.bind_buffer(glow::ARRAY_BUFFER, Some(buffer.raw));
                gl.buffer_sub_data_u8_slice(glow::ARRAY_BUFFER, 0, data);
            }
        }
    }

    fn destroy_buffer(&self, buffer: super::Buffer) {
        let gl = self.lock();
        unsafe { gl.delete_buffer(buffer.raw) };
        if !buffer.data.is_null()
            && !self
                .capabilities
                .contains(super::Capabilities::BUFFER_STORAGE)
        {
            unsafe {
                Vec::from_raw_parts(buffer.data, buffer.size as usize, buffer.size as usize);
            }
        }
    }

    fn create_texture(&self, desc: crate::TextureDesc) -> super::Texture {
        let gl = self.lock();
        let format_desc = super::describe_texture_format(desc.format);

        let inner = if crate::TextureUsage::TARGET.contains(desc.usage)
            && desc.dimension == crate::TextureDimension::D2
            && desc.array_layer_count == 1
        {
            let raw = unsafe { gl.create_renderbuffer().unwrap() };
            unsafe {
                gl.bind_renderbuffer(glow::RENDERBUFFER, Some(raw));

                if desc.sample_count <= 1 {
                    gl.renderbuffer_storage(
                        glow::RENDERBUFFER,
                        format_desc.internal,
                        desc.size.width as i32,
                        desc.size.height as i32,
                    );
                } else {
                    gl.renderbuffer_storage_multisample(
                        glow::RENDERBUFFER,
                        desc.sample_count as i32,
                        format_desc.internal,
                        desc.size.width as i32,
                        desc.size.height as i32,
                    );
                }

                gl.bind_renderbuffer(glow::RENDERBUFFER, None);
                #[cfg(not(target_arch = "wasm32"))]
                if !desc.name.is_empty() && gl.supports_debug() {
                    gl.object_label(
                        glow::RENDERBUFFER,
                        std::mem::transmute::<glow::NativeRenderbuffer, u32>(raw),
                        Some(desc.name),
                    );
                }
            }

            super::TextureInner::Renderbuffer { raw }
        } else {
            let raw = unsafe { gl.create_texture().unwrap() };

            let target = match desc.dimension {
                crate::TextureDimension::D1 => {
                    if desc.sample_count > 1 {
                        log::warn!("Sample count is ignored: not supported for 1D textures",);
                    }
                    if desc.array_layer_count > 1 {
                        glow::TEXTURE_1D_ARRAY
                    } else {
                        glow::TEXTURE_1D
                    }
                }
                crate::TextureDimension::D2 => {
                    if desc.array_layer_count > 1 {
                        if desc.sample_count <= 1 {
                            glow::TEXTURE_2D_ARRAY
                        } else {
                            glow::TEXTURE_2D_MULTISAMPLE_ARRAY
                        }
                    } else if desc.sample_count <= 1 {
                        glow::TEXTURE_2D
                    } else {
                        glow::TEXTURE_2D_MULTISAMPLE
                    }
                }
                crate::TextureDimension::D3 => {
                    if desc.sample_count > 1 {
                        log::warn!("Sample count is ignored: not supported for 3D textures",);
                    }
                    glow::TEXTURE_3D
                }
            };

            unsafe {
                gl.bind_texture(target, Some(raw));
                // Reset default filtering mode. This has to be done before
                // assigning the storage.
                gl.tex_parameter_i32(target, glow::TEXTURE_MIN_FILTER, glow::NEAREST as i32);
                gl.tex_parameter_i32(target, glow::TEXTURE_MAG_FILTER, glow::NEAREST as i32);

                match desc.dimension {
                    crate::TextureDimension::D3 => {
                        gl.tex_storage_3d(
                            target,
                            desc.mip_level_count as i32,
                            format_desc.internal,
                            desc.size.width as i32,
                            desc.size.height as i32,
                            desc.size.depth as i32,
                        );
                    }
                    crate::TextureDimension::D2 => {
                        if desc.sample_count <= 1 {
                            gl.tex_storage_2d(
                                target,
                                desc.mip_level_count as i32,
                                format_desc.internal,
                                desc.size.width as i32,
                                desc.size.height as i32,
                            );
                        } else {
                            assert_eq!(desc.mip_level_count, 1);
                            gl.tex_storage_2d_multisample(
                                target,
                                desc.sample_count as i32,
                                format_desc.internal,
                                desc.size.width as i32,
                                desc.size.height as i32,
                                true,
                            );
                        }
                    }
                    crate::TextureDimension::D1 => {
                        gl.tex_storage_1d(
                            target,
                            desc.mip_level_count as i32,
                            format_desc.internal,
                            desc.size.width as i32,
                        );
                    }
                }

                gl.bind_texture(target, None);
                #[cfg(not(target_arch = "wasm32"))]
                if !desc.name.is_empty() && gl.supports_debug() {
                    gl.object_label(
                        glow::TEXTURE,
                        std::mem::transmute::<glow::NativeTexture, u32>(raw),
                        Some(desc.name),
                    );
                }
            }

            super::TextureInner::Texture { raw, target }
        };

        super::Texture {
            inner,
            target_size: [desc.size.width as u16, desc.size.height as u16],
            format: desc.format,
        }
    }

    fn destroy_texture(&self, texture: super::Texture) {
        let gl = self.lock();
        match texture.inner {
            super::TextureInner::Renderbuffer { raw, .. } => unsafe {
                gl.delete_renderbuffer(raw);
            },
            super::TextureInner::Texture { raw, .. } => unsafe {
                gl.delete_texture(raw);
            },
        }
    }

    fn create_texture_view(
        &self,
        texture: super::Texture,
        desc: crate::TextureViewDesc,
    ) -> super::TextureView {
        //TODO: actual reinterpretation
        super::TextureView {
            inner: texture.inner,
            target_size: texture.target_size,
            aspects: desc.format.aspects(),
        }
    }

    fn destroy_texture_view(&self, _view: super::TextureView) {}

    fn create_sampler(&self, desc: crate::SamplerDesc) -> super::Sampler {
        let gl = self.lock();

        let wrap_enums = [
            glow::TEXTURE_WRAP_S,
            glow::TEXTURE_WRAP_T,
            glow::TEXTURE_WRAP_R,
        ];
        let (min, mag) = map_filter_modes(desc.min_filter, desc.mag_filter, desc.mipmap_filter);
        let border = match desc.border_color {
            None | Some(crate::TextureColor::TransparentBlack) => [0.0; 4],
            Some(crate::TextureColor::OpaqueBlack) => [0.0, 0.0, 0.0, 1.0],
            Some(crate::TextureColor::White) => [1.0; 4],
        };

        let raw = unsafe { gl.create_sampler().unwrap() };
        unsafe {
            gl.sampler_parameter_i32(raw, glow::TEXTURE_MIN_FILTER, min as i32);
            gl.sampler_parameter_i32(raw, glow::TEXTURE_MAG_FILTER, mag as i32);

            for (&address_mode, wrap_enum) in desc.address_modes.iter().zip(wrap_enums) {
                gl.sampler_parameter_i32(raw, wrap_enum, map_address_mode(address_mode) as i32)
            }
            if desc.border_color.is_some() {
                gl.sampler_parameter_f32_slice(raw, glow::TEXTURE_BORDER_COLOR, &border)
            }
            gl.sampler_parameter_f32(raw, glow::TEXTURE_MIN_LOD, desc.lod_min_clamp);
            if let Some(clamp) = desc.lod_max_clamp {
                gl.sampler_parameter_f32(raw, glow::TEXTURE_MAX_LOD, clamp);
            }
            if desc.anisotropy_clamp > 1 {
                gl.sampler_parameter_i32(
                    raw,
                    glow::TEXTURE_MAX_ANISOTROPY,
                    desc.anisotropy_clamp as i32,
                );
            }

            if let Some(compare) = desc.compare {
                gl.sampler_parameter_i32(
                    raw,
                    glow::TEXTURE_COMPARE_MODE,
                    glow::COMPARE_REF_TO_TEXTURE as i32,
                );
                gl.sampler_parameter_i32(
                    raw,
                    glow::TEXTURE_COMPARE_FUNC,
                    super::map_compare_func(compare) as i32,
                );
            }

            #[cfg(not(target_arch = "wasm32"))]
            if !desc.name.is_empty() && gl.supports_debug() {
                gl.object_label(
                    glow::SAMPLER,
                    std::mem::transmute::<glow::NativeSampler, u32>(raw),
                    Some(desc.name),
                );
            }
        }
        super::Sampler { raw }
    }

    fn destroy_sampler(&self, sampler: super::Sampler) {
        let gl = self.lock();
        unsafe { gl.delete_sampler(sampler.raw) };
    }

    fn create_acceleration_structure(
        &self,
        _desc: crate::AccelerationStructureDesc,
    ) -> super::AccelerationStructure {
        unimplemented!()
    }

    fn destroy_acceleration_structure(
        &self,
        _acceleration_structure: super::AccelerationStructure,
    ) {
        unimplemented!()
    }
}

fn map_filter_modes(
    min: crate::FilterMode,
    mag: crate::FilterMode,
    mip: crate::FilterMode,
) -> (u32, u32) {
    use crate::FilterMode as Fm;

    let mag_filter = match mag {
        Fm::Nearest => glow::NEAREST,
        Fm::Linear => glow::LINEAR,
    };

    let min_filter = match (min, mip) {
        (Fm::Nearest, Fm::Nearest) => glow::NEAREST_MIPMAP_NEAREST,
        (Fm::Nearest, Fm::Linear) => glow::NEAREST_MIPMAP_LINEAR,
        (Fm::Linear, Fm::Nearest) => glow::LINEAR_MIPMAP_NEAREST,
        (Fm::Linear, Fm::Linear) => glow::LINEAR_MIPMAP_LINEAR,
    };

    (min_filter, mag_filter)
}

fn map_address_mode(mode: crate::AddressMode) -> u32 {
    match mode {
        crate::AddressMode::Repeat => glow::REPEAT,
        crate::AddressMode::MirrorRepeat => glow::MIRRORED_REPEAT,
        crate::AddressMode::ClampToEdge => glow::CLAMP_TO_EDGE,
        crate::AddressMode::ClampToBorder => glow::CLAMP_TO_BORDER,
    }
}