summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/user-guide/03-convenience-features.md25
-rw-r--r--tests/spirv/pointer-from-user-guide.slang31
2 files changed, 54 insertions, 2 deletions
diff --git a/docs/user-guide/03-convenience-features.md b/docs/user-guide/03-convenience-features.md
index 420db18c1..a145c407c 100644
--- a/docs/user-guide/03-convenience-features.md
+++ b/docs/user-guide/03-convenience-features.md
@@ -422,6 +422,23 @@ int test(MyType* pObj)
MyType* pNext2 = &pNext[1];
return pNext.a + pNext->a + (*pNext2).a + pNext2[0].a;
}
+
+cbuffer Constants
+{
+ MyType *ptr;
+};
+
+int validTest()
+{
+ return test(ptr);
+}
+
+int invalidTest()
+{
+ // cannot produce a pointer from a local variable
+ MyType obj;
+ return test(&obj); // !! ERROR !!
+}
```
Pointer types can also be specified using the generic syntax: `Ptr<MyType>` is equivalent to `MyType*`.
@@ -430,9 +447,13 @@ Pointer types can also be specified using the generic syntax: `Ptr<MyType>` is e
- Slang supports pointers to global memory, but not shared or local memory. For example, it is invalid to define a pointer to a local variable.
-- Coherent load/stores are unsupported
+- Slang supports pointers that are defined as shader parameters (e.g. as a constant buffer field).
+
+- Slang can produce pointers using the & operator from data in global memory.
+
+- Slang doesn't support coherent load/stores.
-- Custom alignment specification is unsupported.
+- Slang doesn't support custom alignment specification.
- Slang currently does not support pointers to immutable values, i.e. `const T*`.
diff --git a/tests/spirv/pointer-from-user-guide.slang b/tests/spirv/pointer-from-user-guide.slang
new file mode 100644
index 000000000..662579c2b
--- /dev/null
+++ b/tests/spirv/pointer-from-user-guide.slang
@@ -0,0 +1,31 @@
+//TEST(compute, vulkan):SIMPLE(filecheck=SPV): -stage compute -entry computeMain -target spirv -emit-spirv-directly
+
+// This test is to verify the example on the user guide
+// and prevent any regressions.
+
+//TEST_INPUT:ubuffer(data=[0], stride=4):out,name=outputBuffer
+RWStructuredBuffer<float> outputBuffer;
+
+struct MyType
+{
+ float a;
+};
+
+float test(MyType* pObj)
+{
+ //SPV: OpTypePointer
+ MyType* pNext = pObj + 1;
+ MyType* pNext2 = &pNext[1];
+ return pNext.a + pNext->a + (*pNext2).a + pNext2[0].a;
+}
+
+cbuffer Constants
+{
+ MyType *ptr;
+};
+
+[numthreads(1,1,1)]
+void computeMain()
+{
+ outputBuffer[0] = test(ptr);
+}