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
use super::*;
use crate::{RafxRootSignature, RafxSampler, RafxShader, RafxShaderModule};
use rafx_base::DecimalF32;
use std::hash::{Hash, Hasher};
use fnv::FnvHasher;
#[cfg(feature = "serde-support")]
use serde::{Deserialize, Serialize};
#[derive(Default)]
pub struct RafxApiDef {
}
#[derive(Clone, Debug, Default)]
pub struct RafxBufferElementData {
pub element_begin_index: u64,
pub element_count: u64,
pub element_stride: u64,
}
#[derive(Clone, Debug)]
pub struct RafxBufferDef {
pub size: u64,
pub alignment: u32,
pub memory_usage: RafxMemoryUsage,
pub queue_type: RafxQueueType,
pub resource_type: RafxResourceType,
pub always_mapped: bool,
pub format: RafxFormat,
pub elements: RafxBufferElementData,
}
impl Default for RafxBufferDef {
fn default() -> Self {
RafxBufferDef {
size: 0,
alignment: 0,
memory_usage: RafxMemoryUsage::Unknown,
queue_type: RafxQueueType::Graphics,
resource_type: RafxResourceType::UNDEFINED,
elements: Default::default(),
format: RafxFormat::UNDEFINED,
always_mapped: false,
}
}
}
impl RafxBufferDef {
pub fn verify(&self) {
assert_ne!(self.size, 0);
}
pub fn for_staging_buffer(
size: usize,
resource_type: RafxResourceType,
) -> RafxBufferDef {
RafxBufferDef {
size: size as u64,
alignment: 0,
memory_usage: RafxMemoryUsage::CpuToGpu,
queue_type: RafxQueueType::Graphics,
resource_type,
elements: Default::default(),
format: RafxFormat::UNDEFINED,
always_mapped: false,
}
}
pub fn for_staging_buffer_data<T: Copy>(
data: &[T],
resource_type: RafxResourceType,
) -> RafxBufferDef {
Self::for_staging_buffer(rafx_base::memory::slice_size_in_bytes(data), resource_type)
}
pub fn for_staging_vertex_buffer(size: usize) -> RafxBufferDef {
Self::for_staging_buffer(size, RafxResourceType::VERTEX_BUFFER)
}
pub fn for_staging_vertex_buffer_data<T: Copy>(data: &[T]) -> RafxBufferDef {
Self::for_staging_buffer_data(data, RafxResourceType::VERTEX_BUFFER)
}
pub fn for_staging_index_buffer(size: usize) -> RafxBufferDef {
Self::for_staging_buffer(size, RafxResourceType::INDEX_BUFFER)
}
pub fn for_staging_index_buffer_data<T: Copy>(data: &[T]) -> RafxBufferDef {
Self::for_staging_buffer_data(data, RafxResourceType::INDEX_BUFFER)
}
pub fn for_staging_uniform_buffer(size: usize) -> RafxBufferDef {
Self::for_staging_buffer(size, RafxResourceType::UNIFORM_BUFFER)
}
pub fn for_staging_uniform_buffer_data<T: Copy>(data: &[T]) -> RafxBufferDef {
Self::for_staging_buffer_data(data, RafxResourceType::UNIFORM_BUFFER)
}
}
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum RafxTextureDimensions {
Auto,
Dim1D,
Dim2D,
Dim3D,
}
impl Default for RafxTextureDimensions {
fn default() -> Self {
RafxTextureDimensions::Auto
}
}
impl RafxTextureDimensions {
pub fn determine_dimensions(
self,
extents: RafxExtents3D,
) -> RafxTextureDimensions {
match self {
RafxTextureDimensions::Auto => {
if extents.depth > 1 {
RafxTextureDimensions::Dim3D
} else {
RafxTextureDimensions::Dim2D
}
}
RafxTextureDimensions::Dim1D => {
assert_eq!(extents.height, 1);
assert_eq!(extents.depth, 1);
RafxTextureDimensions::Dim1D
}
RafxTextureDimensions::Dim2D => {
assert_eq!(extents.depth, 1);
RafxTextureDimensions::Dim2D
}
RafxTextureDimensions::Dim3D => RafxTextureDimensions::Dim3D,
}
}
}
#[derive(Clone, Debug)]
pub struct RafxTextureDef {
pub extents: RafxExtents3D,
pub array_length: u32,
pub mip_count: u32,
pub sample_count: RafxSampleCount,
pub format: RafxFormat,
pub resource_type: RafxResourceType,
pub dimensions: RafxTextureDimensions,
}
impl Default for RafxTextureDef {
fn default() -> Self {
RafxTextureDef {
extents: RafxExtents3D {
width: 0,
height: 0,
depth: 0,
},
array_length: 1,
mip_count: 1,
sample_count: RafxSampleCount::SampleCount1,
format: RafxFormat::UNDEFINED,
resource_type: RafxResourceType::TEXTURE,
dimensions: RafxTextureDimensions::Auto,
}
}
}
impl RafxTextureDef {
pub fn verify(&self) {
assert!(self.extents.width > 0);
assert!(self.extents.height > 0);
assert!(self.extents.depth > 0);
assert!(self.array_length > 0);
assert!(self.mip_count > 0);
assert!(self.mip_count < 2 || self.sample_count == RafxSampleCount::SampleCount1);
if self.resource_type.contains(RafxResourceType::TEXTURE_CUBE) {
assert_eq!(self.array_length % 6, 0);
}
assert!(
!(self.resource_type.contains(
RafxResourceType::RENDER_TARGET_ARRAY_SLICES
| RafxResourceType::RENDER_TARGET_DEPTH_SLICES
))
);
assert!(
!(self.format.has_depth()
&& self
.resource_type
.intersects(RafxResourceType::TEXTURE_READ_WRITE)),
"Cannot use depth stencil as UAV"
);
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RafxCommandPoolDef {
pub transient: bool,
}
#[derive(Debug, Clone, PartialEq)]
pub struct RafxCommandBufferDef {
pub is_secondary: bool,
}
#[derive(Clone, Debug)]
pub struct RafxSwapchainDef {
pub width: u32,
pub height: u32,
pub enable_vsync: bool,
}
#[derive(Clone, Debug)]
pub struct RafxShaderStageDef {
pub shader_module: RafxShaderModule,
pub reflection: RafxShaderStageReflection,
}
impl RafxShaderStageDef {
pub fn hash_definition<HasherT: std::hash::Hasher, ShaderModuleHashT: Hash>(
hasher: &mut HasherT,
reflection_data: &[&RafxShaderStageReflection],
shader_module_hashes: &[ShaderModuleHashT],
) {
assert_eq!(reflection_data.len(), shader_module_hashes.len());
fn hash_stage<HasherT: std::hash::Hasher, ShaderModuleHashT: Hash>(
hasher: &mut HasherT,
stage_flag: RafxShaderStageFlags,
reflection_data: &[&RafxShaderStageReflection],
shader_module_hashes: &[ShaderModuleHashT],
) {
for (reflection, shader_module_hash) in reflection_data.iter().zip(shader_module_hashes)
{
if reflection.shader_stage.intersects(stage_flag) {
reflection.shader_stage.hash(hasher);
reflection.entry_point_name.hash(hasher);
reflection.resources.hash(hasher);
shader_module_hash.hash(hasher);
break;
}
}
}
for stage_flag in &crate::ALL_SHADER_STAGE_FLAGS {
hash_stage(hasher, *stage_flag, reflection_data, shader_module_hashes);
}
}
}
#[derive(Clone, Hash)]
pub enum RafxImmutableSamplerKey<'a> {
Name(&'a str),
Binding(u32, u32),
}
impl<'a> RafxImmutableSamplerKey<'a> {
pub fn from_name(name: &'a str) -> RafxImmutableSamplerKey<'a> {
RafxImmutableSamplerKey::Name(name)
}
pub fn from_binding(
set_index: u32,
binding: u32,
) -> RafxImmutableSamplerKey<'a> {
RafxImmutableSamplerKey::Binding(set_index, binding)
}
}
pub struct RafxImmutableSamplers<'a> {
pub key: RafxImmutableSamplerKey<'a>,
pub samplers: &'a [RafxSampler],
}
impl<'a> RafxImmutableSamplers<'a> {
pub fn from_name(
name: &'a str,
samplers: &'a [RafxSampler],
) -> RafxImmutableSamplers<'a> {
RafxImmutableSamplers {
key: RafxImmutableSamplerKey::from_name(name),
samplers,
}
}
pub fn from_binding(
set_index: u32,
binding: u32,
samplers: &'a [RafxSampler],
) -> RafxImmutableSamplers<'a> {
RafxImmutableSamplers {
key: RafxImmutableSamplerKey::from_binding(set_index, binding),
samplers,
}
}
}
pub struct RafxRootSignatureDef<'a> {
pub shaders: &'a [RafxShader],
pub immutable_samplers: &'a [RafxImmutableSamplers<'a>],
}
impl<'a> RafxRootSignatureDef<'a> {
pub fn hash_definition<
HasherT: std::hash::Hasher,
ShaderHashT: Hash,
ImmutableSamplerHashT: Hash,
>(
hasher: &mut HasherT,
shader_hashes: &[ShaderHashT],
immutable_sampler_keys: &[RafxImmutableSamplerKey],
immutable_sampler_hashes: &[Vec<ImmutableSamplerHashT>],
) {
let mut combined_shaders_hash = 0;
for shader_hash in shader_hashes {
let mut h = FnvHasher::default();
shader_hash.hash(&mut h);
combined_shaders_hash ^= h.finish();
}
let mut combined_immutable_samplers_hash = 0;
for (key, samplers) in immutable_sampler_keys.iter().zip(immutable_sampler_hashes) {
let mut h = FnvHasher::default();
key.hash(&mut h);
samplers.hash(&mut h);
combined_immutable_samplers_hash ^= h.finish();
}
combined_shaders_hash.hash(hasher);
combined_immutable_samplers_hash.hash(hasher);
}
}
#[derive(Debug, Clone, PartialEq, Default)]
#[cfg_attr(feature = "serde-support", derive(Serialize, Deserialize))]
pub struct RafxSamplerDef {
#[cfg_attr(feature = "serde-support", serde(default))]
pub min_filter: RafxFilterType,
#[cfg_attr(feature = "serde-support", serde(default))]
pub mag_filter: RafxFilterType,
#[cfg_attr(feature = "serde-support", serde(default))]
pub mip_map_mode: RafxMipMapMode,
#[cfg_attr(feature = "serde-support", serde(default))]
pub address_mode_u: RafxAddressMode,
#[cfg_attr(feature = "serde-support", serde(default))]
pub address_mode_v: RafxAddressMode,
#[cfg_attr(feature = "serde-support", serde(default))]
pub address_mode_w: RafxAddressMode,
#[cfg_attr(feature = "serde-support", serde(default))]
pub mip_lod_bias: f32,
#[cfg_attr(feature = "serde-support", serde(default))]
pub max_anisotropy: f32,
#[cfg_attr(feature = "serde-support", serde(default))]
pub compare_op: RafxCompareOp,
}
impl Eq for RafxSamplerDef {}
impl Hash for RafxSamplerDef {
fn hash<H: Hasher>(
&self,
mut state: &mut H,
) {
self.min_filter.hash(&mut state);
self.mag_filter.hash(&mut state);
self.mip_map_mode.hash(&mut state);
self.address_mode_u.hash(&mut state);
self.address_mode_v.hash(&mut state);
self.address_mode_w.hash(&mut state);
DecimalF32(self.mip_lod_bias).hash(&mut state);
DecimalF32(self.max_anisotropy).hash(&mut state);
self.compare_op.hash(&mut state);
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RafxVertexLayoutAttribute {
pub format: RafxFormat,
pub buffer_index: u32,
pub location: u32,
pub byte_offset: u32,
pub gl_attribute_name: Option<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RafxVertexLayoutBuffer {
pub stride: u32,
pub rate: RafxVertexAttributeRate,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RafxVertexLayout {
pub attributes: Vec<RafxVertexLayoutAttribute>,
pub buffers: Vec<RafxVertexLayoutBuffer>,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde-support", derive(Serialize, Deserialize))]
pub struct RafxDepthState {
pub depth_test_enable: bool,
pub depth_write_enable: bool,
pub depth_compare_op: RafxCompareOp,
pub stencil_test_enable: bool,
pub stencil_read_mask: u8,
pub stencil_write_mask: u8,
pub front_depth_fail_op: RafxStencilOp,
pub front_stencil_compare_op: RafxCompareOp,
pub front_stencil_fail_op: RafxStencilOp,
pub front_stencil_pass_op: RafxStencilOp,
pub back_depth_fail_op: RafxStencilOp,
pub back_stencil_compare_op: RafxCompareOp,
pub back_stencil_fail_op: RafxStencilOp,
pub back_stencil_pass_op: RafxStencilOp,
}
impl Default for RafxDepthState {
fn default() -> Self {
RafxDepthState {
depth_test_enable: false,
depth_write_enable: false,
depth_compare_op: RafxCompareOp::LessOrEqual,
stencil_test_enable: false,
stencil_read_mask: 0xFF,
stencil_write_mask: 0xFF,
front_depth_fail_op: Default::default(),
front_stencil_compare_op: RafxCompareOp::Always,
front_stencil_fail_op: Default::default(),
front_stencil_pass_op: Default::default(),
back_depth_fail_op: Default::default(),
back_stencil_compare_op: RafxCompareOp::Always,
back_stencil_fail_op: Default::default(),
back_stencil_pass_op: Default::default(),
}
}
}
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde-support", derive(Serialize, Deserialize))]
pub struct RafxRasterizerState {
pub cull_mode: RafxCullMode,
pub front_face: RafxFrontFace,
pub fill_mode: RafxFillMode,
pub depth_bias: i32,
pub depth_bias_slope_scaled: f32,
pub depth_clamp_enable: bool,
pub multisample: bool,
pub scissor: bool,
}
impl Eq for RafxRasterizerState {}
impl Hash for RafxRasterizerState {
fn hash<H: Hasher>(
&self,
mut state: &mut H,
) {
self.cull_mode.hash(&mut state);
self.front_face.hash(&mut state);
self.fill_mode.hash(&mut state);
self.depth_bias.hash(&mut state);
DecimalF32(self.depth_bias_slope_scaled).hash(&mut state);
self.depth_clamp_enable.hash(&mut state);
self.multisample.hash(&mut state);
self.scissor.hash(&mut state);
}
}
impl Default for RafxRasterizerState {
fn default() -> Self {
RafxRasterizerState {
cull_mode: RafxCullMode::None,
front_face: Default::default(),
fill_mode: Default::default(),
depth_bias: 0,
depth_bias_slope_scaled: 0.0,
depth_clamp_enable: false,
multisample: false,
scissor: false,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde-support", derive(Serialize, Deserialize))]
pub struct RafxBlendStateRenderTarget {
pub src_factor: RafxBlendFactor,
pub dst_factor: RafxBlendFactor,
pub src_factor_alpha: RafxBlendFactor,
pub dst_factor_alpha: RafxBlendFactor,
pub blend_op: RafxBlendOp,
pub blend_op_alpha: RafxBlendOp,
pub masks: RafxColorFlags,
}
impl Default for RafxBlendStateRenderTarget {
fn default() -> Self {
RafxBlendStateRenderTarget {
blend_op: RafxBlendOp::Add,
blend_op_alpha: RafxBlendOp::Add,
src_factor: RafxBlendFactor::One,
src_factor_alpha: RafxBlendFactor::One,
dst_factor: RafxBlendFactor::Zero,
dst_factor_alpha: RafxBlendFactor::Zero,
masks: RafxColorFlags::ALL,
}
}
}
impl RafxBlendStateRenderTarget {
pub fn default_alpha_disabled() -> Self {
Default::default()
}
pub fn default_alpha_enabled() -> Self {
RafxBlendStateRenderTarget {
src_factor: RafxBlendFactor::SrcAlpha,
dst_factor: RafxBlendFactor::OneMinusSrcAlpha,
src_factor_alpha: RafxBlendFactor::One,
dst_factor_alpha: RafxBlendFactor::Zero,
blend_op: RafxBlendOp::Add,
blend_op_alpha: RafxBlendOp::Add,
masks: RafxColorFlags::ALL,
}
}
}
impl RafxBlendStateRenderTarget {
pub fn blend_enabled(&self) -> bool {
self.src_factor != RafxBlendFactor::One
|| self.src_factor_alpha != RafxBlendFactor::One
|| self.dst_factor != RafxBlendFactor::Zero
|| self.dst_factor_alpha != RafxBlendFactor::Zero
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde-support", derive(Serialize, Deserialize))]
pub struct RafxBlendState {
pub render_target_blend_states: Vec<RafxBlendStateRenderTarget>,
pub render_target_mask: RafxBlendStateTargets,
pub independent_blend: bool,
}
impl RafxBlendState {
pub fn default_alpha_disabled() -> Self {
RafxBlendState {
render_target_blend_states: vec![RafxBlendStateRenderTarget::default_alpha_disabled()],
render_target_mask: RafxBlendStateTargets::BLEND_STATE_TARGET_ALL,
independent_blend: false,
}
}
pub fn default_alpha_enabled() -> Self {
RafxBlendState {
render_target_blend_states: vec![RafxBlendStateRenderTarget::default_alpha_enabled()],
render_target_mask: RafxBlendStateTargets::BLEND_STATE_TARGET_ALL,
independent_blend: false,
}
}
}
impl Default for RafxBlendState {
fn default() -> Self {
Self::default_alpha_disabled()
}
}
impl RafxBlendState {
pub fn verify(
&self,
color_attachment_count: usize,
) {
if !self.independent_blend {
assert_eq!(self.render_target_blend_states.len(), 1, "If RafxBlendState::independent_blend is false, RafxBlendState::render_target_blend_states must be 1");
} else {
assert_eq!(self.render_target_blend_states.len(), color_attachment_count, "If RafxBlendState::independent_blend is true, RafxBlendState::render_target_blend_states length must match color attachment count");
}
}
}
#[derive(Debug)]
pub struct RafxGraphicsPipelineDef<'a> {
pub shader: &'a RafxShader,
pub root_signature: &'a RafxRootSignature,
pub vertex_layout: &'a RafxVertexLayout,
pub blend_state: &'a RafxBlendState,
pub depth_state: &'a RafxDepthState,
pub rasterizer_state: &'a RafxRasterizerState,
pub primitive_topology: RafxPrimitiveTopology,
pub color_formats: &'a [RafxFormat],
pub depth_stencil_format: Option<RafxFormat>,
pub sample_count: RafxSampleCount,
}
#[derive(Debug)]
pub struct RafxComputePipelineDef<'a> {
pub shader: &'a RafxShader,
pub root_signature: &'a RafxRootSignature,
}
pub struct RafxDescriptorSetArrayDef<'a> {
pub root_signature: &'a RafxRootSignature,
pub set_index: u32,
pub array_length: usize,
}