summaryrefslogtreecommitdiffstats
path: root/docs/user-guide
diff options
context:
space:
mode:
authorYong He <yonghe@outlook.com>2024-03-13 18:55:32 -0700
committerGitHub <noreply@github.com>2024-03-13 18:55:32 -0700
commit73c0cd17d98da9b76d346a4bc4a64f0ea4e976aa (patch)
tree1f13e71be9a483879ac5945c0358404bfc22ac3f /docs/user-guide
parent67704d0eee756be8647165ff2c73f1dc074874a2 (diff)
Add cautionary desclaimers on interop mechanisms. (#3763)
* Add cautionary desclaimers on interop mechanisms. * Fix.
Diffstat (limited to 'docs/user-guide')
-rw-r--r--docs/user-guide/a1-04-interop.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/user-guide/a1-04-interop.md b/docs/user-guide/a1-04-interop.md
index 1d86009ab..b7715779f 100644
--- a/docs/user-guide/a1-04-interop.md
+++ b/docs/user-guide/a1-04-interop.md
@@ -11,6 +11,11 @@ Slang provides low-level interoperation mechanisms to allow developers to use ta
- `__target_switch` construct to use different implementations for different targets.
- `spirv_asm` construct to define inline SPIRV assembly blocks.
+> #### Note
+> The language mechanisms described in this chapter are considered internal compiler features.
+> The compiler does not provide comprehensive checks around their uses. These mechanisms are also subject
+> to breaking changes in future releases.
+
## Defining Intrinsic Functions for Textual Targets
When using Slang to generate code for a textual target, e.g. HLSL, GLSL, CUDA or C++, you can use `__intrinsic_asm` to define what code to generate for an invocation to an intrinsic function. For example, the following Slang code defines an intrinsic function `myPrint`, that when called, will produce a call to `printf` in the target code: