summaryrefslogtreecommitdiffstats
path: root/docs/language-reference/08-attributes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/language-reference/08-attributes.md')
-rw-r--r--docs/language-reference/08-attributes.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/language-reference/08-attributes.md b/docs/language-reference/08-attributes.md
new file mode 100644
index 000000000..7ffe0f0fe
--- /dev/null
+++ b/docs/language-reference/08-attributes.md
@@ -0,0 +1,32 @@
+> Note: This document is a work in progress. It is both incomplete and, in many cases, inaccurate.
+
+Attributes
+==========
+
+> Note: This section is not yet complete.
+
+## [[vk::spirv_instruction]]
+
+** SPIR-V only **
+
+This attribute is only available for Vulkan SPIR-V output.
+
+The attibute allows access to SPIR-V intrinsics, by supplying a function declaration with the appropriate signature for the SPIR-V op and no body. The intrinsic takes a single parameter which is the integer value for the SPIR-V op.
+
+In the example below the add function, uses the mechanism to directly use the SPIR-V integer add 'op' which is 128 in this case.
+
+```HLSL
+// 128 is OpIAdd in SPIR-V
+[[vk::spirv_instruction(128)]]
+uint add(uint a, uint b);
+
+RWStructuredBuffer<uint> resultBuffer;
+
+[numthreads(4,1,1)]
+void computeMain(uint3 dispatchThreadID : SV_DispatchThreadID)
+{
+ uint threadId = dispatchThreadID.x;
+ resultBuffer[threadId] = add(threadId, threadId);
+}
+```
+