diff --git a/clang/docs/HLSL/HLSLDocs.rst b/clang/docs/HLSL/HLSLDocs.rst --- a/clang/docs/HLSL/HLSLDocs.rst +++ b/clang/docs/HLSL/HLSLDocs.rst @@ -11,5 +11,6 @@ .. toctree:: :maxdepth: 1 + HLSLIRReference ResourceTypes EntryFunctions diff --git a/clang/docs/HLSL/HLSLIRReference.rst b/clang/docs/HLSL/HLSLIRReference.rst new file mode 100644 --- /dev/null +++ b/clang/docs/HLSL/HLSLIRReference.rst @@ -0,0 +1,31 @@ +================= +HLSL IR Reference +================= + +.. contents:: + :local: + +Introduction +============ + +The goal of this document is to provide a reference for all the special purpose +IR metadata and attributes used by the HLSL code generation path. + +IR Metadata +=========== + +``hlsl.uavs`` +------------- + +The ``hlsl.uavs`` metadata is a list of all the external global variables that +represent UAV resources. + +Function Attributes +=================== + +``hlsl.shader`` +--------------- + +The ``hlsl.shader`` function attribute is a string attribute applied to entry +functions. The value is the string representation of the shader stage (i.e. +``compute``, ``pixel``, etc).