Skip to content

Commit c207c7b

Browse files
Icohedrontex3d
Icohedron
and
tex3d
authored
[NFC] Update Shader Flags section of DXIL.rst (#7295)
Fixes #7294 This PR updates DXIL.rst to list and describe all current shader flags in DXC (from `DxilShaderFlags.h`). Also adds extra columns to the table of shader flags to document the minimum shader model version and the conditions or criteria under which each shader flag is set (as seen in `DxilShaderFlags.cpp` and `DxilModule.cpp`). --------- Co-authored-by: Tex Riddell <texr@microsoft.com>
1 parent d6e0ca4 commit c207c7b

1 file changed

Lines changed: 46 additions & 27 deletions

File tree

‎docs/DXIL.rst‎

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -515,33 +515,52 @@ Additional shader properties are specified via tag-value pair list, which is the
515515
Shader Flags
516516
------------
517517

518-
Shaders have additional flags that covey their capabilities via tag-value pair with tag kDxilShaderFlagsTag (0), followed by an i64 bitmask integer. The bits have the following meaning:
519-
520-
=== =====================================================================
521-
Bit Description
522-
=== =====================================================================
523-
0 Disable shader optimizations
524-
1 Disable math refactoring
525-
2 Shader uses doubles
526-
3 Force early depth stencil
527-
4 Enable raw and structured buffers
528-
5 Shader uses min-precision, expressed as half and i16
529-
6 Shader uses double extension intrinsics
530-
7 Shader uses MSAD
531-
8 All resources must be bound for the duration of shader execution
532-
9 Enable view port and RT array index from any stage feeding rasterizer
533-
10 Shader uses inner coverage
534-
11 Shader uses stencil
535-
12 Shader uses intrinsics that access tiled resources
536-
13 Shader uses relaxed typed UAV load formats
537-
14 Shader uses Level9 comparison filtering
538-
15 Shader uses up to 64 UAVs
539-
16 Shader uses UAVs
540-
17 Shader uses CS4 raw and structured buffers
541-
18 Shader uses Rasterizer Ordered Views
542-
19 Shader uses wave intrinsics
543-
20 Shader uses int64 instructions
544-
=== =====================================================================
518+
Shaders have additional flags that convey their capabilities via a tag-value pair with tag kDxilShaderFlagsTag (0), followed by an i64 bitmask integer. The bits have the following meaning, Shader Model requirements, and criteria for being set:
519+
520+
=== ==== ======================================================================================== ==========================================================================================================================================================================================================================================================================================================================================================
521+
Bit SM Description Criteria to set shader flag
522+
=== ==== ======================================================================================== ==========================================================================================================================================================================================================================================================================================================================================================
523+
0 Disable shader optimizations Command-line flag ``/Od`` is provided to DXC
524+
1 Disable math refactoring Only used in Dxilconv; corresponds to ``~D3D10_SB_GLOBAL_FLAG_REFACTORING_ALLOWED`` in DXBC
525+
2 Double-precision floating point Use of the double data type
526+
3 Force early depth-stencil test Shader is a pixel shader, and the ``[earlydepthstencil]`` attribute is present in the HLSL source
527+
4 Raw and Structured buffers Use of RawBuffer or StructuredBuffer resource types
528+
5 Low-precision data types present Use of half or i16 data types
529+
6 Double-precision extensions for 11.1 Use of FDiv, UIToFP, SIToFP, FPToUI, FPToSI, or Fma instructions with a double type
530+
7 Shader extensions for 11.1 Use of the Msad instruction
531+
8 All resources bound for the duration of shader execution Command-line flag ``/all_resources_bound`` provided to DXC
532+
9 SV_RenderTargetArrayIndex or SV_ViewportArrayIndex from any shader feeding rasterizer ViewPortArrayIndex or RenderTargetArrayIndex semantics are present in the input signature of a geometry shader, or the output signature of a vertex, domain, or hull shader
533+
10 PS Inner Coverage Use of the InnerCoverage instruction, or the InnerCoverage semantic is present in the output signature of a pixel shader
534+
11 PS Output Stencil Ref The StencilRef semantic is present in the output signature of a pixel shader
535+
12 Tiled resources Use of the CheckAccessFullyMapped instruction, or the use of LodClamp in any of the instructions: SampleGrad, SampleCmpGrad, Sample, SampleBias, SampleCmp, or SampleCmpBias
536+
13 Typed UAV load additional formats Use of TextureLoad or BufferLoad on a UAV with a multi-component data type.
537+
14 Comparison filtering for feature level 9 Not set; unused legacy feature requirement flag
538+
15 64 UAV slots More than 8 UAVs are declared, enabling the extended (64-slot) UAV register space. Each UAV array (range) contributes its range size to the count
539+
16 UAVs at every shader stage This is set when a vertex, hull, domain, or geometry shader declares one or more UAVs
540+
17 CS4 raw and structured buffers Use of RawBuffer or StructuedBuffer in a Shader Model 4.x compute shader
541+
18 Raster Ordered UAVs Global presence of a rasterizer ordered view (ROV)
542+
19 Wave level operations Use of any wave or quad intrinsic: WaveIsFirstLane, WaveGetLaneIndex, WaveGetLaneCount, WaveAnyTrue, WaveAllTrue, WaveActiveAllEqual, WaveActiveBallot, WaveReadLaneAt, WaveReadLaneFirst, WaveActiveOp, WaveActiveBit, WavePrefixOp, QuadReadLaneAt, QuadOp, WaveAllBitCount, WavePrefixBitCount, WaveMatch, WaveMultiPrefixOp, WaveMultiPrefixBitCount, QuadVote
543+
20 64-Bit integers Use of i64 data types
544+
21 6.1+ View Instancing Use of the ViewID instruction
545+
22 6.1+ Barycentrics Use of the AttributeAtVertex instruction, or the Barcentrics semantic is present in the shader input signature
546+
23 6.2+ Enable native low-precision data types Command-line flag ``-enable-16bit-types`` is provided to DXC
547+
24 6.4+ ShadingRate The ShadingRate semantic is present in the shader input or output signature
548+
25 6.5+ Raytracing tier 1.1 features Use of the AllocateRayQuery, AllocateRayQuery2, or GeometryIndex instruction
549+
550+
26 6.5+ Sampler feedback Use of any sampler feedback instructions: WriteSamplerFeedback, WriteSamplerFeedbackBias, WriteSamplerFeedbackLevel, and WriteSamplerFeedbackGrad
551+
27 6.6+ 64-bit Atomics on Typed Resources Use of i64 AtomicBinOp or AtomicCompareExchange instructions on a typed resource
552+
28 6.6+ 64-bit Atomics on Group Shared Use of i64 AtomicBinOp or AtomicCompareExchange instructions on group shared memory
553+
29 6.6+ Derivatives in mesh and amplification shaders Use of instructions DerivFineX, DerivFineY, DerivCoarseX, DerivCoarseY, CalculateLOD, Sample, SampleBias, SampleCmp, or SampleCmpBias in a mesh or amplification shader
554+
30 6.6+ Resource descriptor heap indexing Use of the CreateHandleFromHeap instruction on a resource descriptor heap
555+
31 6.6+ Sampler descriptor heap indexing Use of the CreateHandleFromHeap instruction on a sampler descriptor heap
556+
32 6.6+ 64-bit Atomics on Heap Resources Use of i64 AtomicBinOp or AtomicCompareExchange instructions on a descriptor heap resource
557+
33 6.7+ Any UAV may not alias any other UAV Use of a UAV in any function, unless the ``-res-may-alias`` command-line flag is provided to DXC
558+
34 6.7+ Advanced Texture Ops Use of SampleCmpLevel or TextureGatherRaw instructions, or the use of TextureLoad, SampleLevel, SampleCmpLevelZero, Sample Grad, SampleCmpGrad, Sample, SampleBias, SampleCamp, or SampleCmpBias with non-constant offsets
559+
35 6.7+ Writeable MSAA Textures Set by use of the TextureStoreSample instruction or the presence of writeable MSAA texture resources accessed via a CreateHandle, CreateHandleForLib, or AnnotateHandle instruction
560+
36 6.9+ Reserved Unused
561+
37 6.8+ SampleCmp with gradient or bias Use of the instructions SampleCmpGrad or SampleCmpBias
562+
38 6.8+ Extended command info Use of the instructions StartVertexLocation or StartInstanceLocation
563+
=== ==== ======================================================================================== ==========================================================================================================================================================================================================================================================================================================================================================
545564

546565
Geometry Shader
547566
---------------

0 commit comments

Comments
 (0)