-
Notifications
You must be signed in to change notification settings - Fork 25
/
NRIDescs.h
1504 lines (1286 loc) · 53.9 KB
/
NRIDescs.h
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
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// © 2021 NVIDIA Corporation
#pragma once
#include <stdint.h>
#if defined(_WIN32)
#define NRI_CALL __stdcall
#else
#define NRI_CALL
#endif
#ifndef NRI_API
#if defined(__cplusplus)
#define NRI_API extern "C"
#else
#define NRI_API extern
#endif
#endif
#ifdef __cplusplus
#if !defined(NRI_FORCE_C)
#define NRI_CPP
#endif
#else
#include <stdbool.h>
#endif
#include "NRIMacro.h"
#define NRI_INTERFACE(name) #name, sizeof(name)
// TIP: designated initializers are highly recommended
NriNamespaceBegin
// Entities
NriForwardStruct(Fence);
NriForwardStruct(Memory); // heap
NriForwardStruct(Buffer);
NriForwardStruct(Device);
NriForwardStruct(Texture);
NriForwardStruct(Pipeline);
NriForwardStruct(QueryPool);
NriForwardStruct(Descriptor);
NriForwardStruct(CommandQueue);
NriForwardStruct(CommandBuffer); // command list
NriForwardStruct(DescriptorSet); // continuous set of descriptors in a descriptor heap
NriForwardStruct(DescriptorPool); // descriptor heap
NriForwardStruct(PipelineLayout); // root signature
NriForwardStruct(CommandAllocator);
// Types
typedef uint8_t Nri(Mip_t);
typedef uint8_t Nri(Sample_t);
typedef uint16_t Nri(Dim_t);
typedef uint32_t Nri(MemoryType);
// Aliases
static const uint32_t NriConstant(ALL_SAMPLES) = 0; // only for "sampleMask"
static const uint32_t NriConstant(ONE_VIEWPORT) = 0; // only for "viewportNum"
static const Nri(Dim_t) NriConstant(WHOLE_SIZE) = 0; // only for "Dim_t" and "size"
static const Nri(Mip_t) NriConstant(REMAINING_MIPS) = 0; // only for "mipNum"
static const Nri(Dim_t) NriConstant(REMAINING_LAYERS) = 0; // only for "layerNum"
// Readability
#define NriOptional // i.e. can be 0 (keep an eye on comments)
#define NriOut // highlights an output argument
//============================================================================================================================================================================================
#pragma region [ Common ]
//============================================================================================================================================================================================
NriEnum(GraphicsAPI, uint8_t,
NONE, // Supports everything, does nothing, returns dummy non-NULL objects and ~0-filled descs, available if "NRI_ENABLE_NONE_SUPPORT = ON" in CMake
D3D11, // Direct3D 11 (feature set 11.1), available if "NRI_ENABLE_D3D11_SUPPORT = ON" in CMake
D3D12, // Direct3D 12 (feature set 11.1+), available if "NRI_ENABLE_D3D12_SUPPORT = ON" in CMake
VK // Vulkan 1.3 or 1.2+ (can be used on MacOS via MoltenVK), available if "NRI_ENABLE_VK_SUPPORT = ON" in CMake
);
NriEnum(Result, uint8_t,
SUCCESS,
FAILURE,
INVALID_ARGUMENT,
OUT_OF_MEMORY,
UNSUPPORTED,
DEVICE_LOST,
OUT_OF_DATE // VK only: swap chain is out of date
);
// left -> right : low -> high bits
// Expected (but not guaranteed) "FormatSupportBits" are provided, but "GetFormatSupport" should be used for querying real HW support
// To demote sRGB use the previous format, i.e. "format - 1"
// STORAGE_BUFFER_ATOMICS
// VERTEX_BUFFER |
// STORAGE_BUFFER | |
// BUFFER | | |
// STORAGE_TEXTURE_ATOMICS | | | |
// BLEND | | | | |
// DEPTH_STENCIL_ATTACHMENT | | | | | |
// COLOR_ATTACHMENT | | | | | | |
// STORAGE_TEXTURE | | | | | | | |
// TEXTURE | | | | | | | | |
// | | | | | | | | | |
// | FormatSupportBits |
NriEnum(Format, uint8_t,
UNKNOWN, // - - - - - - - - - -
// Plain: 8 bits per channel
R8_UNORM, // + + + - + - + + + -
R8_SNORM, // + + + - + - + + + -
R8_UINT, // + + + - - - + + + - // SHADING_RATE compatible, see NRI_SHADING_RATE macro
R8_SINT, // + + + - - - + + + -
RG8_UNORM, // + + + - + - + + + -
RG8_SNORM, // + + + - + - + + + -
RG8_UINT, // + + + - - - + + + -
RG8_SINT, // + + + - - - + + + -
BGRA8_UNORM, // + + + - + - + + + -
BGRA8_SRGB, // + - + - + - - - - -
RGBA8_UNORM, // + + + - + - + + + -
RGBA8_SRGB, // + - + - + - - - - -
RGBA8_SNORM, // + + + - + - + + + -
RGBA8_UINT, // + + + - - - + + + -
RGBA8_SINT, // + + + - - - + + + -
// Plain: 16 bits per channel
R16_UNORM, // + + + - + - + + + -
R16_SNORM, // + + + - + - + + + -
R16_UINT, // + + + - - - + + + -
R16_SINT, // + + + - - - + + + -
R16_SFLOAT, // + + + - + - + + + -
RG16_UNORM, // + + + - + - + + + -
RG16_SNORM, // + + + - + - + + + -
RG16_UINT, // + + + - - - + + + -
RG16_SINT, // + + + - - - + + + -
RG16_SFLOAT, // + + + - + - + + + -
RGBA16_UNORM, // + + + - + - + + + -
RGBA16_SNORM, // + + + - + - + + + -
RGBA16_UINT, // + + + - - - + + + -
RGBA16_SINT, // + + + - - - + + + -
RGBA16_SFLOAT, // + + + - + - + + + -
// Plain: 32 bits per channel
R32_UINT, // + + + - - + + + + +
R32_SINT, // + + + - - + + + + +
R32_SFLOAT, // + + + - + + + + + +
RG32_UINT, // + + + - - - + + + -
RG32_SINT, // + + + - - - + + + -
RG32_SFLOAT, // + + + - + - + + + -
RGB32_UINT, // + - - - - - + - + -
RGB32_SINT, // + - - - - - + - + -
RGB32_SFLOAT, // + - - - - - + - + -
RGBA32_UINT, // + + + - - - + + + -
RGBA32_SINT, // + + + - - - + + + -
RGBA32_SFLOAT, // + + + - + - + + + -
// Packed: 16 bits per pixel
B5_G6_R5_UNORM, // + - + - + - - - - -
B5_G5_R5_A1_UNORM, // + - + - + - - - - -
B4_G4_R4_A4_UNORM, // + - + - + - - - - -
// Packed: 32 bits per pixel
R10_G10_B10_A2_UNORM, // + + + - + - + + + -
R10_G10_B10_A2_UINT, // + + + - - - + + + -
R11_G11_B10_UFLOAT, // + + + - + - + + + -
R9_G9_B9_E5_UFLOAT, // + - - - - - - - - -
// Block-compressed
BC1_RGBA_UNORM, // + - - - - - - - - -
BC1_RGBA_SRGB, // + - - - - - - - - -
BC2_RGBA_UNORM, // + - - - - - - - - -
BC2_RGBA_SRGB, // + - - - - - - - - -
BC3_RGBA_UNORM, // + - - - - - - - - -
BC3_RGBA_SRGB, // + - - - - - - - - -
BC4_R_UNORM, // + - - - - - - - - -
BC4_R_SNORM, // + - - - - - - - - -
BC5_RG_UNORM, // + - - - - - - - - -
BC5_RG_SNORM, // + - - - - - - - - -
BC6H_RGB_UFLOAT, // + - - - - - - - - -
BC6H_RGB_SFLOAT, // + - - - - - - - - -
BC7_RGBA_UNORM, // + - - - - - - - - -
BC7_RGBA_SRGB, // + - - - - - - - - -
// Depth-stencil
D16_UNORM, // - - - + - - - - - -
D24_UNORM_S8_UINT, // - - - + - - - - - -
D32_SFLOAT, // - - - + - - - - - -
D32_SFLOAT_S8_UINT_X24, // - - - + - - - - - -
// Depth-stencil (SHADER_RESOURCE)
R24_UNORM_X8, // .x - depth // + - - - - - - - - -
X24_G8_UINT, // .y - stencil // + - - - - - - - - -
R32_SFLOAT_X8_X24, // .x - depth // + - - - - - - - - -
X32_G8_UINT_X24 // .y - stencil // + - - - - - - - - -
);
NriBits(PlaneBits, uint8_t,
ALL = 0,
COLOR = NriBit(0),
DEPTH = NriBit(1),
STENCIL = NriBit(2)
);
NriBits(FormatSupportBits, uint16_t,
UNSUPPORTED = 0,
// Texture
TEXTURE = NriBit(0),
STORAGE_TEXTURE = NriBit(1),
COLOR_ATTACHMENT = NriBit(2),
DEPTH_STENCIL_ATTACHMENT = NriBit(3),
BLEND = NriBit(4),
STORAGE_TEXTURE_ATOMICS = NriBit(5), // other than Load / Store
// Buffer
BUFFER = NriBit(6),
STORAGE_BUFFER = NriBit(7),
VERTEX_BUFFER = NriBit(8),
STORAGE_BUFFER_ATOMICS = NriBit(9) // other than Load / Store
);
NriBits(StageBits, uint32_t,
// Special
ALL = 0, // Lazy default for barriers
NONE = 0x7FFFFFFF,
// Graphics // Invoked by "CmdDraw*"
INDEX_INPUT = NriBit(0), // Index buffer consumption
VERTEX_SHADER = NriBit(1), // Vertex shader
TESS_CONTROL_SHADER = NriBit(2), // Tessellation control (hull) shader
TESS_EVALUATION_SHADER = NriBit(3), // Tessellation evaluation (domain) shader
GEOMETRY_SHADER = NriBit(4), // Geometry shader
MESH_CONTROL_SHADER = NriBit(5), // Mesh control (task) shader
MESH_EVALUATION_SHADER = NriBit(6), // Mesh evaluation (amplification) shader
FRAGMENT_SHADER = NriBit(7), // Fragment (pixel) shader
DEPTH_STENCIL_ATTACHMENT = NriBit(8), // Depth-stencil R/W operations
COLOR_ATTACHMENT = NriBit(9), // Color R/W operations
// Compute // Invoked by "CmdDispatch*" (not Rays)
COMPUTE_SHADER = NriBit(10), // Compute shader
// Ray tracing // Invoked by "CmdDispatchRays*"
RAYGEN_SHADER = NriBit(11), // Ray generation shader
MISS_SHADER = NriBit(12), // Miss shader
INTERSECTION_SHADER = NriBit(13), // Intersection shader
CLOSEST_HIT_SHADER = NriBit(14), // Closest hit shader
ANY_HIT_SHADER = NriBit(15), // Any hit shader
CALLABLE_SHADER = NriBit(16), // Callable shader
// Other stages
COPY = NriBit(17), // Invoked by "CmdCopy*", "CmdUpload*" and "CmdReadback*"
CLEAR_STORAGE = NriBit(18), // Invoked by "CmdClearStorage*"
ACCELERATION_STRUCTURE = NriBit(19), // Invoked by "Cmd*AccelerationStructure*"
// Modifiers
INDIRECT = NriBit(20), // Invoked by "Indirect" command (used in addition to other bits)
// Umbrella stages
TESSELLATION_SHADERS = NriMember(StageBits, TESS_CONTROL_SHADER) |
NriMember(StageBits, TESS_EVALUATION_SHADER),
MESH_SHADERS = NriMember(StageBits, MESH_CONTROL_SHADER) |
NriMember(StageBits, MESH_EVALUATION_SHADER),
GRAPHICS_SHADERS = NriMember(StageBits, VERTEX_SHADER) |
NriMember(StageBits, TESSELLATION_SHADERS) |
NriMember(StageBits, GEOMETRY_SHADER) |
NriMember(StageBits, MESH_SHADERS) |
NriMember(StageBits, FRAGMENT_SHADER),
// Invoked by "CmdDispatchRays"
RAY_TRACING_SHADERS = NriMember(StageBits, RAYGEN_SHADER) |
NriMember(StageBits, MISS_SHADER) |
NriMember(StageBits, INTERSECTION_SHADER) |
NriMember(StageBits, CLOSEST_HIT_SHADER) |
NriMember(StageBits, ANY_HIT_SHADER) |
NriMember(StageBits, CALLABLE_SHADER),
// Invoked by "CmdDraw*"
DRAW = NriMember(StageBits, INDEX_INPUT) |
NriMember(StageBits, GRAPHICS_SHADERS) |
NriMember(StageBits, DEPTH_STENCIL_ATTACHMENT) |
NriMember(StageBits, COLOR_ATTACHMENT)
);
// The viewport origin is top-left (D3D native) by default, but can be changed to bottom-left (VK native)
NriStruct(Viewport) {
float x;
float y;
float width;
float height;
float depthMin;
float depthMax;
bool originBottomLeft; // expects "isViewportOriginBottomLeftSupported"
};
NriStruct(Rect) {
int16_t x;
int16_t y;
Nri(Dim_t) width;
Nri(Dim_t) height;
};
NriStruct(Color32f) {
float x, y, z, w;
};
NriStruct(Color32ui) {
uint32_t x, y, z, w;
};
NriStruct(Color32i) {
int32_t x, y, z, w;
};
NriStruct(DepthStencil) {
float depth;
uint8_t stencil;
};
NriUnion(Color) {
Nri(Color32f) f;
Nri(Color32ui) ui;
Nri(Color32i) i;
};
NriUnion(ClearValue) {
Nri(DepthStencil) depthStencil;
Nri(Color) color;
};
NriStruct(SampleLocation) {
int8_t x, y; // [-8; 7]
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Creation ]
//============================================================================================================================================================================================
NriEnum(CommandQueueType, uint8_t,
GRAPHICS,
COMPUTE,
COPY,
HIGH_PRIORITY_COPY
);
NriEnum(MemoryLocation, uint8_t,
DEVICE,
DEVICE_UPLOAD, // soft fallback to HOST_UPLOAD
HOST_UPLOAD,
HOST_READBACK
);
NriEnum(TextureType, uint8_t,
TEXTURE_1D,
TEXTURE_2D,
TEXTURE_3D
);
NriEnum(Texture1DViewType, uint8_t,
SHADER_RESOURCE_1D,
SHADER_RESOURCE_1D_ARRAY,
SHADER_RESOURCE_STORAGE_1D,
SHADER_RESOURCE_STORAGE_1D_ARRAY,
COLOR_ATTACHMENT,
DEPTH_STENCIL_ATTACHMENT,
DEPTH_READONLY_STENCIL_ATTACHMENT,
DEPTH_ATTACHMENT_STENCIL_READONLY,
DEPTH_STENCIL_READONLY
);
NriEnum(Texture2DViewType, uint8_t,
SHADER_RESOURCE_2D,
SHADER_RESOURCE_2D_ARRAY,
SHADER_RESOURCE_CUBE,
SHADER_RESOURCE_CUBE_ARRAY,
SHADER_RESOURCE_STORAGE_2D,
SHADER_RESOURCE_STORAGE_2D_ARRAY,
COLOR_ATTACHMENT,
DEPTH_STENCIL_ATTACHMENT,
DEPTH_READONLY_STENCIL_ATTACHMENT,
DEPTH_ATTACHMENT_STENCIL_READONLY,
DEPTH_STENCIL_READONLY,
SHADING_RATE_ATTACHMENT
);
NriEnum(Texture3DViewType, uint8_t,
SHADER_RESOURCE_3D,
SHADER_RESOURCE_STORAGE_3D,
COLOR_ATTACHMENT
);
NriEnum(BufferViewType, uint8_t,
SHADER_RESOURCE,
SHADER_RESOURCE_STORAGE,
CONSTANT
);
NriEnum(DescriptorType, uint8_t,
SAMPLER,
CONSTANT_BUFFER,
TEXTURE,
STORAGE_TEXTURE,
BUFFER,
STORAGE_BUFFER,
STRUCTURED_BUFFER,
STORAGE_STRUCTURED_BUFFER,
ACCELERATION_STRUCTURE
);
NriBits(TextureUsageBits, uint8_t,
NONE = 0,
SHADER_RESOURCE = NriBit(0),
SHADER_RESOURCE_STORAGE = NriBit(1),
COLOR_ATTACHMENT = NriBit(2),
DEPTH_STENCIL_ATTACHMENT = NriBit(3),
SHADING_RATE_ATTACHMENT = NriBit(4)
);
NriBits(BufferUsageBits, uint16_t,
NONE = 0,
SHADER_RESOURCE = NriBit(0),
SHADER_RESOURCE_STORAGE = NriBit(1),
VERTEX_BUFFER = NriBit(2),
INDEX_BUFFER = NriBit(3),
CONSTANT_BUFFER = NriBit(4),
ARGUMENT_BUFFER = NriBit(5),
// Ray tracing
SCRATCH_BUFFER = NriBit(6),
SHADER_BINDING_TABLE = NriBit(7),
ACCELERATION_STRUCTURE_BUILD_INPUT = NriBit(8), // read-only input for an acceleration structure build or update
ACCELERATION_STRUCTURE_STORAGE = NriBit(9) // (INTERNAL) acceleration structure storage
);
// Resources
NriStruct(TextureDesc) {
Nri(TextureType) type;
Nri(TextureUsageBits) usage;
Nri(Format) format;
Nri(Dim_t) width;
NriOptional Nri(Dim_t) height;
NriOptional Nri(Dim_t) depth;
NriOptional Nri(Mip_t) mipNum;
NriOptional Nri(Dim_t) layerNum;
NriOptional Nri(Sample_t) sampleNum;
};
NriStruct(BufferDesc) {
uint64_t size;
NriOptional uint32_t structureStride; // use 4 to allow "byte address" (raw) views
Nri(BufferUsageBits) usage;
};
// Descriptors (Views)
NriStruct(Texture1DViewDesc) {
const NriPtr(Texture) texture;
Nri(Texture1DViewType) viewType;
Nri(Format) format;
Nri(Mip_t) mipOffset;
Nri(Mip_t) mipNum;
Nri(Dim_t) layerOffset;
Nri(Dim_t) layerNum;
};
NriStruct(Texture2DViewDesc) {
const NriPtr(Texture) texture;
Nri(Texture2DViewType) viewType;
Nri(Format) format;
Nri(Mip_t) mipOffset;
Nri(Mip_t) mipNum;
Nri(Dim_t) layerOffset;
Nri(Dim_t) layerNum;
};
NriStruct(Texture3DViewDesc) {
const NriPtr(Texture) texture;
Nri(Texture3DViewType) viewType;
Nri(Format) format;
Nri(Mip_t) mipOffset;
Nri(Mip_t) mipNum;
Nri(Dim_t) sliceOffset;
Nri(Dim_t) sliceNum;
};
NriStruct(BufferViewDesc) {
const NriPtr(Buffer) buffer;
Nri(BufferViewType) viewType;
Nri(Format) format;
uint64_t offset;
uint64_t size;
};
// Descriptor pool
NriStruct(DescriptorPoolDesc) {
uint32_t descriptorSetMaxNum;
uint32_t samplerMaxNum;
uint32_t constantBufferMaxNum;
uint32_t dynamicConstantBufferMaxNum;
uint32_t textureMaxNum;
uint32_t storageTextureMaxNum;
uint32_t bufferMaxNum;
uint32_t storageBufferMaxNum;
uint32_t structuredBufferMaxNum;
uint32_t storageStructuredBufferMaxNum;
uint32_t accelerationStructureMaxNum;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Pipeline layout and descriptors management ]
//============================================================================================================================================================================================
/*
All indices are local in the currently bound pipeline layout.
Pipeline layout example:
Descriptor set #0 // "setIndex" - a descriptor set index in the pipeline layout, provided as an argument or bound to the pipeline
Descriptor range #0 // "rangeIndex" and "baseRange" - a descriptor range (base) index in the descriptor set
Descriptor #0 // "descriptorIndex" and "baseDescriptor" - a descriptor (base) index in the descriptor range
Descriptor #1
Descriptor #2
Descriptor range #1
Descriptor #0
Descriptor #1
Dynamic constant buffer #0 // "baseDynamicConstantBuffer" - an offset in "dynamicConstantBuffers" in the currently bound pipeline layout for the provided descriptor set
Dynamic constant buffer #1
Descriptor set #1
Descriptor range #0
Descriptor #0
Descriptor set #2
Descriptor range #0
Descriptor #0
Descriptor #1
Descriptor #2
Descriptor range #1
Descriptor #0
Descriptor #1
Descriptor range #2
Descriptor #0
Dynamic constant buffer #0
RootConstantDesc #0 // "rootConstantIndex" - an index in "rootConstants" in the currently bound pipeline layout
RootDescriptorDesc #0 // "rootDescriptorIndex" - an index in "rootDescriptors" in the currently bound pipeline layout
RootDescriptorDesc #1
*/
// "DescriptorRange" consists of "Descriptor" entities
NriBits(DescriptorRangeBits, uint8_t,
NONE = 0,
PARTIALLY_BOUND = NriBit(0), // descriptors in range may not contain valid descriptors at the time the descriptors are consumed (but referenced descriptors must be valid)
ARRAY = NriBit(1), // descriptors in range are organized into an array
VARIABLE_SIZED_ARRAY = NriBit(2) // descriptors in range are organized into a variable-sized array, whose size is specified via "variableDescriptorNum" argument of "AllocateDescriptorSets" function
);
NriStruct(DescriptorRangeDesc) {
uint32_t baseRegisterIndex;
uint32_t descriptorNum; // treated as max size if "VARIABLE_SIZED_ARRAY" flag is set
Nri(DescriptorType) descriptorType;
Nri(StageBits) shaderStages;
Nri(DescriptorRangeBits) flags;
};
// "DescriptorSet" consists of "DescriptorRange" entities
NriStruct(DynamicConstantBufferDesc) {
uint32_t registerIndex;
Nri(StageBits) shaderStages;
};
NriStruct(DescriptorSetDesc) {
uint32_t registerSpace; // must be unique, avoid big gaps
const NriPtr(DescriptorRangeDesc) ranges;
uint32_t rangeNum;
const NriPtr(DynamicConstantBufferDesc) dynamicConstantBuffers; // a dynamic constant buffer allows to dynamically specify an offset in the buffer via "CmdSetDescriptorSet" call
uint32_t dynamicConstantBufferNum;
};
// "PipelineLayout" consists of "DescriptorSet" descriptions and root parameters
NriStruct(RootConstantDesc) { // aka push constants block
uint32_t registerIndex;
uint32_t size;
Nri(StageBits) shaderStages;
};
NriStruct(RootDescriptorDesc) { // aka push descriptor
uint32_t registerIndex;
Nri(DescriptorType) descriptorType; // CONSTANT_BUFFER, STRUCTURED_BUFFER or STORAGE_STRUCTURED_BUFFER
Nri(StageBits) shaderStages;
};
NriStruct(PipelineLayoutDesc) {
uint32_t rootRegisterSpace;
const NriPtr(RootConstantDesc) rootConstants;
uint32_t rootConstantNum;
const NriPtr(RootDescriptorDesc) rootDescriptors;
uint32_t rootDescriptorNum;
const NriPtr(DescriptorSetDesc) descriptorSets;
uint32_t descriptorSetNum;
Nri(StageBits) shaderStages;
bool ignoreGlobalSPIRVOffsets;
bool enableD3D12DrawParametersEmulation; // implicitly expects "enableD3D12DrawParametersEmulation" passed during device creation
};
// Updating descriptors
NriStruct(DescriptorRangeUpdateDesc) {
const NriPtr(Descriptor) const* descriptors;
uint32_t descriptorNum;
uint32_t baseDescriptor;
};
NriStruct(DescriptorSetCopyDesc) {
const NriPtr(DescriptorSet) srcDescriptorSet;
uint32_t srcBaseRange;
uint32_t dstBaseRange;
uint32_t rangeNum;
uint32_t srcBaseDynamicConstantBuffer;
uint32_t dstBaseDynamicConstantBuffer;
uint32_t dynamicConstantBufferNum;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Input assembly ]
//============================================================================================================================================================================================
NriEnum(VertexStreamStepRate, uint8_t,
PER_VERTEX,
PER_INSTANCE
);
NriEnum(IndexType, uint8_t,
UINT16,
UINT32
);
NriEnum(PrimitiveRestart, uint8_t,
DISABLED,
INDICES_UINT16,
INDICES_UINT32
);
NriEnum(Topology, uint8_t,
POINT_LIST,
LINE_LIST,
LINE_STRIP,
TRIANGLE_LIST,
TRIANGLE_STRIP,
LINE_LIST_WITH_ADJACENCY,
LINE_STRIP_WITH_ADJACENCY,
TRIANGLE_LIST_WITH_ADJACENCY,
TRIANGLE_STRIP_WITH_ADJACENCY,
PATCH_LIST
);
NriStruct(InputAssemblyDesc) {
Nri(Topology) topology;
uint8_t tessControlPointNum;
Nri(PrimitiveRestart) primitiveRestart;
};
NriStruct(VertexAttributeD3D) {
const char* semanticName;
uint32_t semanticIndex;
};
NriStruct(VertexAttributeVK) {
uint32_t location;
};
NriStruct(VertexAttributeDesc) {
Nri(VertexAttributeD3D) d3d;
Nri(VertexAttributeVK) vk;
uint32_t offset;
Nri(Format) format;
uint16_t streamIndex;
};
NriStruct(VertexStreamDesc) {
uint16_t stride;
uint16_t bindingSlot;
Nri(VertexStreamStepRate) stepRate;
};
NriStruct(VertexInputDesc) {
const NriPtr(VertexAttributeDesc) attributes;
uint8_t attributeNum;
const NriPtr(VertexStreamDesc) streams;
uint8_t streamNum;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Rasterization ]
//============================================================================================================================================================================================
NriEnum(FillMode, uint8_t,
SOLID,
WIREFRAME
);
NriEnum(CullMode, uint8_t,
NONE,
FRONT,
BACK
);
NriEnum(ShadingRate, uint8_t,
FRAGMENT_SIZE_1X1,
FRAGMENT_SIZE_1X2,
FRAGMENT_SIZE_2X1,
FRAGMENT_SIZE_2X2,
// Require "isAdditionalShadingRatesSupported"
FRAGMENT_SIZE_2X4,
FRAGMENT_SIZE_4X2,
FRAGMENT_SIZE_4X4
);
NriEnum(ShadingRateCombiner, uint8_t,
REPLACE,
KEEP,
MIN,
MAX,
SUM
);
/*
R - minimum resolvable difference
S - maximum slope
bias = constant * R + slopeFactor * S
if (clamp > 0)
bias = min(bias, clamp)
else if (clamp < 0)
bias = max(bias, clamp)
enabled if constant != 0 or slope != 0
*/
NriStruct(DepthBiasDesc) {
float constant;
float clamp;
float slope;
};
NriStruct(RasterizationDesc) {
uint32_t viewportNum;
Nri(DepthBiasDesc) depthBias;
Nri(FillMode) fillMode;
Nri(CullMode) cullMode;
bool frontCounterClockwise;
bool depthClamp;
bool lineSmoothing; // requires "isLineSmoothingSupported"
bool conservativeRaster; // requires "conservativeRasterTier != 0"
bool shadingRate; // requires "shadingRateTier != 0", expects "CmdSetShadingRate" and optionally "AttachmentsDesc::shadingRate"
};
NriStruct(MultisampleDesc) {
uint32_t sampleMask;
Nri(Sample_t) sampleNum;
bool alphaToCoverage;
bool sampleLocations; // requires "sampleLocationsTier != 0", expects "CmdSetSampleLocations"
};
NriStruct(ShadingRateDesc) {
Nri(ShadingRate) shadingRate;
Nri(ShadingRateCombiner) primitiveCombiner;
Nri(ShadingRateCombiner) attachmentCombiner;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Output merger ]
//============================================================================================================================================================================================
// S - source color 0
// D - destination color
NriEnum(LogicFunc, uint8_t,
NONE,
CLEAR, // 0
AND, // S & D
AND_REVERSE, // S & ~D
COPY, // S
AND_INVERTED, // ~S & D
XOR, // S ^ D
OR, // S | D
NOR, // ~(S | D)
EQUIVALENT, // ~(S ^ D)
INVERT, // ~D
OR_REVERSE, // S | ~D
COPY_INVERTED, // ~S
OR_INVERTED, // ~S | D
NAND, // ~(S & D)
SET // 1
);
// R - fragment's depth or stencil reference
// D - depth or stencil buffer
NriEnum(CompareFunc, uint8_t,
NONE, // test is disabled
ALWAYS, // true
NEVER, // false
EQUAL, // R == D
NOT_EQUAL, // R != D
LESS, // R < D
LESS_EQUAL, // R <= D
GREATER, // R > D
GREATER_EQUAL // R >= D
);
// R - reference, set by "CmdSetStencilReference"
// D - stencil buffer
NriEnum(StencilFunc, uint8_t,
KEEP, // D = D
ZERO, // D = 0
REPLACE, // D = R
INCREMENT_AND_CLAMP, // D = min(D++, 255)
DECREMENT_AND_CLAMP, // D = max(D--, 0)
INVERT, // D = ~D
INCREMENT_AND_WRAP, // D++
DECREMENT_AND_WRAP // D--
);
// S0 - source color 0
// S1 - source color 1
// D - destination color
// C - blend constants, set by "CmdSetBlendConstants"
NriEnum(BlendFactor, uint8_t, // RGB ALPHA
ZERO, // 0 0
ONE, // 1 1
SRC_COLOR, // S0.r, S0.g, S0.b S0.a
ONE_MINUS_SRC_COLOR, // 1 - S0.r, 1 - S0.g, 1 - S0.b 1 - S0.a
DST_COLOR, // D.r, D.g, D.b D.a
ONE_MINUS_DST_COLOR, // 1 - D.r, 1 - D.g, 1 - D.b 1 - D.a
SRC_ALPHA, // S0.a S0.a
ONE_MINUS_SRC_ALPHA, // 1 - S0.a 1 - S0.a
DST_ALPHA, // D.a D.a
ONE_MINUS_DST_ALPHA, // 1 - D.a 1 - D.a
CONSTANT_COLOR, // C.r, C.g, C.b C.a
ONE_MINUS_CONSTANT_COLOR, // 1 - C.r, 1 - C.g, 1 - C.b 1 - C.a
CONSTANT_ALPHA, // C.a C.a
ONE_MINUS_CONSTANT_ALPHA, // 1 - C.a 1 - C.a
SRC_ALPHA_SATURATE, // min(S0.a, 1 - D.a) 1
SRC1_COLOR, // S1.r, S1.g, S1.b S1.a
ONE_MINUS_SRC1_COLOR, // 1 - S1.r, 1 - S1.g, 1 - S1.b 1 - S1.a
SRC1_ALPHA, // S1.a S1.a
ONE_MINUS_SRC1_ALPHA // 1 - S1.a 1 - S1.a
);
// S - source color
// D - destination color
// Sf - source factor, produced by "BlendFactor"
// Df - destination factor, produced by "BlendFactor"
NriEnum(BlendFunc, uint8_t,
ADD, // S * Sf + D * Df
SUBTRACT, // S * Sf - D * Df
REVERSE_SUBTRACT, // D * Df - S * Sf
MIN, // min(S, D)
MAX // max(S, D)
);
NriBits(ColorWriteBits, uint8_t,
NONE = 0,
R = NriBit(0),
G = NriBit(1),
B = NriBit(2),
A = NriBit(3),
RGB = NriMember(ColorWriteBits, R) | // "wingdi.h" must not be included after
NriMember(ColorWriteBits, G) |
NriMember(ColorWriteBits, B),
RGBA = NriMember(ColorWriteBits, RGB) |
NriMember(ColorWriteBits, A)
);
NriStruct(ClearDesc) {
Nri(ClearValue) value;
Nri(PlaneBits) planes;
uint32_t colorAttachmentIndex;
};
NriStruct(StencilDesc) {
Nri(CompareFunc) compareFunc; // compareFunc != NONE, expects "CmdSetStencilReference"
Nri(StencilFunc) fail;
Nri(StencilFunc) pass;
Nri(StencilFunc) depthFail;
uint8_t writeMask;
uint8_t compareMask;
};
NriStruct(BlendingDesc) {
Nri(BlendFactor) srcFactor;
Nri(BlendFactor) dstFactor;
Nri(BlendFunc) func;
};
NriStruct(ColorAttachmentDesc) {
Nri(Format) format;
Nri(BlendingDesc) colorBlend;
Nri(BlendingDesc) alphaBlend;
Nri(ColorWriteBits) colorWriteMask;
bool blendEnabled;
};
NriStruct(DepthAttachmentDesc) {
Nri(CompareFunc) compareFunc;
bool write;
bool boundsTest; // requires "isDepthBoundsTestSupported", expects "CmdSetDepthBounds"
};
NriStruct(StencilAttachmentDesc) {
Nri(StencilDesc) front;
Nri(StencilDesc) back; // requires "isIndependentFrontAndBackStencilReferenceAndMasksSupported" for "back.writeMask"
};
NriStruct(OutputMergerDesc) {
const NriPtr(ColorAttachmentDesc) colors;
uint32_t colorNum;
Nri(DepthAttachmentDesc) depth;
Nri(StencilAttachmentDesc) stencil;
Nri(Format) depthStencilFormat;
Nri(LogicFunc) logicFunc; // requires "isLogicFuncSupported"
};
NriStruct(AttachmentsDesc) {
NriOptional const NriPtr(Descriptor) depthStencil;
NriOptional const NriPtr(Descriptor) shadingRate; // requires "shadingRateTier >= 2"
const NriPtr(Descriptor) const* colors;
uint32_t colorNum;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Sampler ]
//============================================================================================================================================================================================
NriEnum(Filter, uint8_t,
NEAREST,
LINEAR
);
NriEnum(FilterExt, uint8_t,
NONE,
MIN,
MAX
);
NriEnum(AddressMode, uint8_t,
REPEAT,
MIRRORED_REPEAT,
CLAMP_TO_EDGE,
CLAMP_TO_BORDER,
MIRROR_CLAMP_TO_EDGE
);
NriStruct(AddressModes) {
Nri(AddressMode) u, v, w;
};
NriStruct(Filters) {
Nri(Filter) min, mag, mip;
Nri(FilterExt) ext; // requires "isTextureFilterMinMaxSupported"
};
NriStruct(SamplerDesc) {
Nri(Filters) filters;
uint8_t anisotropy;
float mipBias;
float mipMin;
float mipMax;
Nri(AddressModes) addressModes;
Nri(CompareFunc) compareFunc;
Nri(Color) borderColor;
bool isInteger;
};
#pragma endregion
//============================================================================================================================================================================================
#pragma region [ Pipeline ]
//============================================================================================================================================================================================