From 0371deef52c2ef9ffda3c5ec11f5b1082c0b96e8 Mon Sep 17 00:00:00 2001 From: Yong He Date: Mon, 4 Mar 2024 14:15:22 -0800 Subject: Add user-guide section on pointers. (#3670) --- docs/user-guide/03-convenience-features.md | 15 +++++++++++++++ docs/user-guide/toc.html | 1 + 2 files changed, 16 insertions(+) (limited to 'docs/user-guide') diff --git a/docs/user-guide/03-convenience-features.md b/docs/user-guide/03-convenience-features.md index 948400731..ca4635df4 100644 --- a/docs/user-guide/03-convenience-features.md +++ b/docs/user-guide/03-convenience-features.md @@ -361,6 +361,21 @@ float4 myPackedVector = reinterpret(myVal); `reinterpret` can pack any type into any other type as long as the target type is no smaller than the source type. +## Pointers + +Slang supports pointers when generating code for SPIRV, C++ and CUDA targets. The syntax for pointers is similar to C, with the exception that operator `.` can also be used to dereference a member. Slang currently does not support the `->` operator. +For example: +```csharp +int test(MyType* pObj) +{ + MyType* pNext = pObj + 1; + MyType* pNext = &pNext[1]; + return pNext.a + (*pNext).a + pNext[0].a; +} +``` + +Pointer types can also be specified using the generic syntax: `Ptr` is equivalent to `MyType*`. + ## `struct` inheritance (limited) Slang supports a limited form of inheritance. A derived `struct` type has all the members defined in the base type it is inherited from: diff --git a/docs/user-guide/toc.html b/docs/user-guide/toc.html index c9aa4cafb..3564ccf69 100644 --- a/docs/user-guide/toc.html +++ b/docs/user-guide/toc.html @@ -40,6 +40,7 @@
  • Subscript Operator
  • `Optional<T>` type
  • `reinterpret<T>` operation
    • +
  • Pointers
  • `struct` inheritance (limited)
  • Extensions
  • Multi-level break
    • -- cgit v1.2.3