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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
#![allow(
clippy::match_like_matches_macro,
clippy::redundant_pattern_matching,
clippy::needless_lifetimes,
clippy::new_without_default,
clippy::single_match,
clippy::vec_init_then_push,
clippy::if_then_panic,
)]
#![warn(
trivial_casts,
trivial_numeric_casts,
unused_extern_crates,
unused_qualifications,
clippy::pattern_type_mismatch,
)]
pub use naga::{StorageAccess, VectorSize};
#[cfg_attr(
all(not(vulkan), not(gles), any(target_os = "ios", target_os = "macos")),
path = "metal/mod.rs"
)]
#[cfg_attr(
all(
not(gles),
any(vulkan, windows, target_os = "linux", target_os = "android")
),
path = "vulkan/mod.rs"
)]
#[cfg_attr(any(gles, target_arch = "wasm32"), path = "gles/mod.rs")]
mod hal;
mod shader;
mod traits;
pub mod util;
pub mod limits {
pub const PLAIN_DATA_SIZE: u32 = 256;
pub const RESOURCES_IN_GROUP: u32 = 8;
}
pub use hal::*;
use std::num::NonZeroU32;
#[derive(Debug)]
pub struct ContextDesc {
pub validation: bool,
pub capture: bool,
}
#[derive(Debug)]
pub struct NotSupportedError;
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Memory {
Device,
Shared,
Upload,
}
impl Memory {
pub fn is_host_visible(&self) -> bool {
match *self {
Self::Device => false,
Self::Shared | Self::Upload => true,
}
}
}
#[derive(Debug)]
pub struct BufferDesc<'a> {
pub name: &'a str,
pub size: u64,
pub memory: Memory,
}
#[derive(Clone, Copy, Debug)]
pub struct BufferPiece {
pub buffer: Buffer,
pub offset: u64,
}
impl From<Buffer> for BufferPiece {
fn from(buffer: Buffer) -> Self {
Self { buffer, offset: 0 }
}
}
impl BufferPiece {
pub fn data(&self) -> *mut u8 {
let base = self.buffer.data();
assert!(!base.is_null());
unsafe { base.offset(self.offset as isize) }
}
}
impl Buffer {
pub fn at(self, offset: u64) -> BufferPiece {
BufferPiece {
buffer: self,
offset,
}
}
}
#[derive(Clone, Copy, Debug)]
pub struct TexturePiece {
pub texture: Texture,
pub mip_level: u32,
pub array_layer: u32,
pub origin: [u32; 3],
}
impl From<Texture> for TexturePiece {
fn from(texture: Texture) -> Self {
Self {
texture,
mip_level: 0,
array_layer: 0,
origin: [0; 3],
}
}
}
#[non_exhaustive]
#[derive(Clone, Copy, Debug, Hash, Eq, Ord, PartialEq, PartialOrd)]
pub enum TextureFormat {
Rgba8Unorm,
Rgba8UnormSrgb,
Bgra8UnormSrgb,
Depth32Float,
}
#[derive(Clone, Copy, Debug)]
pub struct TexelBlockInfo {
pub dimensions: (u8, u8),
pub size: u8,
}
bitflags::bitflags! {
pub struct TexelAspects: u8 {
const COLOR = 0 << 1;
const DEPTH = 1 << 1;
const STENCIL = 1 << 2;
}
}
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
pub enum TextureDimension {
D1,
D2,
D3,
}
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
pub enum ViewDimension {
D1,
D1Array,
D2,
D2Array,
Cube,
CubeArray,
D3,
}
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
pub struct Extent {
pub width: u32,
pub height: u32,
pub depth: u32,
}
impl Default for Extent {
fn default() -> Self {
Self {
width: 1,
height: 1,
depth: 1,
}
}
}
impl Extent {
pub fn max_mip_levels(&self) -> u32 {
self.width
.max(self.height)
.max(self.depth)
.next_power_of_two()
.trailing_zeros()
}
pub fn at_mip_level(&self, level: u32) -> Self {
Self {
width: (self.width >> level).max(1),
height: (self.height >> level).max(1),
depth: (self.depth >> level).max(1),
}
}
}
bitflags::bitflags! {
pub struct TextureUsage: u32 {
const COPY = 1 << 0;
const TARGET = 1 << 1;
const RESOURCE = 1 << 2;
const STORAGE = 1 << 3;
}
}
#[derive(Debug)]
pub struct TextureDesc<'a> {
pub name: &'a str,
pub format: TextureFormat,
pub size: Extent,
pub array_layer_count: u32,
pub mip_level_count: u32,
pub dimension: TextureDimension,
pub usage: TextureUsage,
}
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct TextureSubresources {
pub base_mip_level: u32,
pub mip_level_count: Option<NonZeroU32>,
pub base_array_layer: u32,
pub array_layer_count: Option<NonZeroU32>,
}
#[derive(Debug)]
pub struct TextureViewDesc<'a> {
pub name: &'a str,
pub texture: Texture,
pub format: TextureFormat,
pub dimension: ViewDimension,
pub subresources: &'a TextureSubresources,
}
bitflags::bitflags! {
#[derive(Default)]
struct ShaderVisibility: u32 {
const COMPUTE = 1 << 0;
const VERTEX = 1 << 1;
const FRAGMENT = 1 << 2;
}
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum AddressMode {
#[default]
ClampToEdge,
Repeat,
MirrorRepeat,
ClampToBorder,
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum FilterMode {
#[default]
Nearest,
Linear,
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum CompareFunction {
Never,
Less,
Equal,
LessEqual,
Greater,
NotEqual,
GreaterEqual,
#[default]
Always,
}
#[derive(Clone, Copy, Debug)]
pub enum TextureColor {
TransparentBlack,
OpaqueBlack,
White,
}
#[derive(Debug, Default)]
pub struct SamplerDesc<'a> {
pub name: &'a str,
pub address_modes: [AddressMode; 3],
pub mag_filter: FilterMode,
pub min_filter: FilterMode,
pub mipmap_filter: FilterMode,
pub lod_min_clamp: f32,
pub lod_max_clamp: Option<f32>,
pub compare: Option<CompareFunction>,
pub anisotropy_clamp: u32,
pub border_color: Option<TextureColor>,
}
pub struct Shader {
module: naga::Module,
info: naga::valid::ModuleInfo,
}
#[derive(Clone, Copy)]
pub struct ShaderFunction<'a> {
pub shader: &'a Shader,
pub entry_point: &'a str,
}
impl ShaderFunction<'_> {
fn entry_point_index(&self) -> usize {
self.shader
.module
.entry_points
.iter()
.position(|ep| ep.name == self.entry_point)
.expect("Entry point not found in the shader")
}
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ShaderBinding {
Texture,
Sampler,
Buffer,
Plain { size: u32 },
}
pub trait ShaderBindable: Clone + Copy {
fn bind_to(&self, context: &mut PipelineContext, index: u32);
}
pub trait HasShaderBinding: ShaderBindable {
const TYPE: ShaderBinding;
}
impl<T: bytemuck::Pod> HasShaderBinding for T {
const TYPE: ShaderBinding = ShaderBinding::Plain {
size: std::mem::size_of::<T>() as u32,
};
}
impl HasShaderBinding for TextureView {
const TYPE: ShaderBinding = ShaderBinding::Texture;
}
impl HasShaderBinding for Sampler {
const TYPE: ShaderBinding = ShaderBinding::Sampler;
}
impl HasShaderBinding for BufferPiece {
const TYPE: ShaderBinding = ShaderBinding::Buffer;
}
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ShaderDataLayout {
pub bindings: Vec<(&'static str, ShaderBinding)>,
}
impl ShaderDataLayout {
pub const EMPTY: &Self = &Self {
bindings: Vec::new(),
};
}
pub trait ShaderData {
fn layout() -> ShaderDataLayout;
fn fill(&self, context: PipelineContext);
}
pub struct ShaderDesc<'a> {
pub source: &'a str,
}
#[derive(Clone, Debug, Default, PartialEq)]
pub enum CommandType {
Transfer,
Compute,
#[default]
General,
}
pub struct CommandEncoderDesc<'a> {
pub name: &'a str,
pub buffer_count: u32,
}
pub struct ComputePipelineDesc<'a> {
pub name: &'a str,
pub data_layouts: &'a [&'a ShaderDataLayout],
pub compute: ShaderFunction<'a>,
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum PrimitiveTopology {
PointList,
LineList,
LineStrip,
#[default]
TriangleList,
TriangleStrip,
}
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub enum FrontFace {
#[default]
Ccw,
Cw,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum Face {
Front,
Back,
}
#[derive(Clone, Debug, Default)]
pub struct PrimitiveState {
pub topology: PrimitiveTopology,
pub front_face: FrontFace,
pub cull_mode: Option<Face>,
pub unclipped_depth: bool,
pub wireframe: bool,
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum StencilOperation {
#[default]
Keep,
Zero,
Replace,
Invert,
IncrementClamp,
DecrementClamp,
IncrementWrap,
DecrementWrap,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct StencilFaceState {
pub compare: CompareFunction,
pub fail_op: StencilOperation,
pub depth_fail_op: StencilOperation,
pub pass_op: StencilOperation,
}
impl StencilFaceState {
pub const IGNORE: Self = StencilFaceState {
compare: CompareFunction::Always,
fail_op: StencilOperation::Keep,
depth_fail_op: StencilOperation::Keep,
pass_op: StencilOperation::Keep,
};
}
impl Default for StencilFaceState {
fn default() -> Self {
Self::IGNORE
}
}
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct StencilState {
pub front: StencilFaceState,
pub back: StencilFaceState,
pub read_mask: u32,
pub write_mask: u32,
}
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct DepthBiasState {
pub constant: i32,
pub slope_scale: f32,
pub clamp: f32,
}
#[derive(Clone, Debug)]
pub struct DepthStencilState {
pub format: TextureFormat,
pub depth_write_enabled: bool,
pub depth_compare: CompareFunction,
pub stencil: StencilState,
pub bias: DepthBiasState,
}
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
pub enum BlendFactor {
Zero,
One,
Src,
OneMinusSrc,
SrcAlpha,
OneMinusSrcAlpha,
Dst,
OneMinusDst,
DstAlpha,
OneMinusDstAlpha,
SrcAlphaSaturated,
Constant,
OneMinusConstant,
}
#[derive(Copy, Clone, Debug, Default, Hash, Eq, PartialEq)]
pub enum BlendOperation {
#[default]
Add,
Subtract,
ReverseSubtract,
Min,
Max,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct BlendComponent {
pub src_factor: BlendFactor,
pub dst_factor: BlendFactor,
pub operation: BlendOperation,
}
impl BlendComponent {
pub const REPLACE: Self = Self {
src_factor: BlendFactor::One,
dst_factor: BlendFactor::Zero,
operation: BlendOperation::Add,
};
pub const OVER: Self = Self {
src_factor: BlendFactor::One,
dst_factor: BlendFactor::OneMinusSrcAlpha,
operation: BlendOperation::Add,
};
}
impl Default for BlendComponent {
fn default() -> Self {
Self::REPLACE
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct BlendState {
pub color: BlendComponent,
pub alpha: BlendComponent,
}
impl BlendState {
pub const REPLACE: Self = Self {
color: BlendComponent::REPLACE,
alpha: BlendComponent::REPLACE,
};
pub const ALPHA_BLENDING: Self = Self {
color: BlendComponent {
src_factor: BlendFactor::SrcAlpha,
dst_factor: BlendFactor::OneMinusSrcAlpha,
operation: BlendOperation::Add,
},
alpha: BlendComponent::OVER,
};
pub const PREMULTIPLIED_ALPHA_BLENDING: Self = Self {
color: BlendComponent::OVER,
alpha: BlendComponent::OVER,
};
}
bitflags::bitflags! {
#[repr(transparent)]
pub struct ColorWrites: u32 {
const RED = 1 << 0;
const GREEN = 1 << 1;
const BLUE = 1 << 2;
const ALPHA = 1 << 3;
const COLOR = Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits;
const ALL = Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits | Self::ALPHA.bits;
}
}
impl Default for ColorWrites {
fn default() -> Self {
Self::ALL
}
}
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ColorTargetState {
pub format: TextureFormat,
pub blend: Option<BlendState>,
pub write_mask: ColorWrites,
}
impl From<TextureFormat> for ColorTargetState {
fn from(format: TextureFormat) -> Self {
Self {
format,
blend: None,
write_mask: ColorWrites::ALL,
}
}
}
pub struct RenderPipelineDesc<'a> {
pub name: &'a str,
pub data_layouts: &'a [&'a ShaderDataLayout],
pub vertex: ShaderFunction<'a>,
pub primitive: PrimitiveState,
pub depth_stencil: Option<DepthStencilState>,
pub fragment: ShaderFunction<'a>,
pub color_targets: &'a [ColorTargetState],
}
#[derive(Clone, Copy, Debug)]
pub enum InitOp {
Load,
Clear(TextureColor),
}
#[derive(Clone, Copy, Debug)]
pub enum FinishOp {
Store,
Discard,
ResolveTo(TextureView),
Ignore,
}
#[derive(Debug)]
pub struct RenderTarget {
pub view: TextureView,
pub init_op: InitOp,
pub finish_op: FinishOp,
}
#[derive(Debug)]
pub struct RenderTargetSet<'a> {
pub colors: &'a [RenderTarget],
pub depth_stencil: Option<RenderTarget>,
}
#[derive(Debug)]
pub struct SurfaceConfig {
pub size: Extent,
pub usage: TextureUsage,
pub frame_count: u32,
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum IndexType {
U16,
U32,
}
#[derive(Clone, Debug, PartialEq)]
pub struct ScissorRect {
pub x: u32,
pub y: u32,
pub w: u32,
pub h: u32,
}