[PATCH] D134304: [Docs] [HLSL] Add IR reference for HLSL

Chris Bieneman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Sep 23 08:30:28 PDT 2022


This revision was automatically updated to reflect the committed changes.
Closed by commit rGd20f9f8d2177: [Docs] [HLSL] Add IR reference for HLSL (authored by beanz).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D134304/new/

https://reviews.llvm.org/D134304

Files:
  clang/docs/HLSL/HLSLDocs.rst
  clang/docs/HLSL/HLSLIRReference.rst


Index: clang/docs/HLSL/HLSLIRReference.rst
===================================================================
--- /dev/null
+++ 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).
Index: clang/docs/HLSL/HLSLDocs.rst
===================================================================
--- clang/docs/HLSL/HLSLDocs.rst
+++ clang/docs/HLSL/HLSLDocs.rst
@@ -11,5 +11,6 @@
 .. toctree::
    :maxdepth: 1
 
+   HLSLIRReference
    ResourceTypes
    EntryFunctions


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D134304.462501.patch
Type: text/x-patch
Size: 1163 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20220923/e1d18882/attachment-0001.bin>


More information about the cfe-commits mailing list