mugl 0.1.2

Minimalistic Low-level WebGL 2.0 / WebGPU 3D graphics abstraction layer for Rust and WebAssembly
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

use alloc::vec::Vec;
use bitflags::bitflags;
use core::ops::Deref;

use crate::primitive::{Extent2D, PowerPreference, TextureDimension, TextureFormat};

bitflags! {
    /// WebGPU features.
    #[repr(transparent)]
    pub struct WGPUFeatures: u32 {
    }
}

/// WebGPU device descriptor.
#[derive(Clone, Copy, Debug, Default)]
pub struct WGPUDeviceDescriptor {
    pub power_preference: PowerPreference,
    pub force_fallback_adapter: bool,
}

/// WebGPU surface descriptor.
#[derive(Clone, Copy, Debug)]
pub struct WGPUSurfaceDescriptor {
    pub depth_stencil_format: Option<TextureFormat>,
    pub sample_count: u32,
    pub size: Extent2D,
}

impl Default for WGPUSurfaceDescriptor {
    fn default() -> Self {
        Self {
            depth_stencil_format: Some(TextureFormat::DEPTH24STENCIL8),
            sample_count: 1,
            size: Extent2D::default(),
        }
    }
}

/// WebGPU buffer.
#[derive(Debug)]
pub struct WGPUBuffer {
    pub(super) buffer: wgpu::Buffer,
}

/// Readonly WebGPU buffer view.
#[derive(Debug)]
pub struct WGPUBufferView<'a> {
    pub(super) buffer: &'a wgpu::Buffer,
    pub(super) view: Option<wgpu::BufferView<'a>>,
}

impl<'a> Deref for WGPUBufferView<'a> {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        if let Some(ref view) = self.view {
            view
        } else {
            &[]
        }
    }
}

impl<'a> Drop for WGPUBufferView<'a> {
    fn drop(&mut self) {
        self.buffer.unmap();
    }
}

/// WebGPU texture.
#[derive(Debug)]
pub struct WGPUTexture {
    pub(super) texture: wgpu::Texture,
    pub(super) view: wgpu::TextureView,
    pub(super) msaa_texture: Option<wgpu::Texture>,
    pub(super) format: TextureFormat,
    pub(super) dimension: TextureDimension,
}

/// WebGPU sampler.
#[derive(Debug)]
pub struct WGPUSampler {
    pub(super) sampler: wgpu::Sampler,
}

/// WebGPU shader.
#[derive(Debug)]
pub struct WGPUShader {
    pub(super) shader: wgpu::ShaderModule,
}

/// WebGPU render pipeline.
#[derive(Debug)]
pub struct WGPURenderPipeline {
    pub(super) pipeline: wgpu::RenderPipeline,
    pub(super) index_format: wgpu::IndexFormat,
}

/// WebGPU render pass.
#[derive(Debug)]
pub struct WGPURenderPass {
    pub(super) color_views: Vec<wgpu::TextureView>,
    pub(super) resolve_targets: Vec<Option<wgpu::TextureView>>,
    pub(super) color_ops: Vec<wgpu::Operations<wgpu::Color>>,
    pub(super) depth_view: Option<wgpu::TextureView>,
    pub(super) depth_ops: Option<wgpu::Operations<f32>>,
    pub(super) stencil_ops: Option<wgpu::Operations<u32>>,
}

/// WebGPU bind group.
#[derive(Debug)]
pub struct WGPUBindGroup {
    pub(super) bind_group: wgpu::BindGroup,
}

/// WebGPU bind group layout.
#[derive(Debug)]
pub struct WGPUBindGroupLayout {
    pub(super) layout: wgpu::BindGroupLayout,
}