diff options
| author | cheneym2 <acheney@nvidia.com> | 2024-10-25 00:32:03 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-24 21:32:03 -0700 |
| commit | 1f06fb2918374cb25d96949cb55826756e934276 (patch) | |
| tree | 5ecae0c304f032b383d7f0ac521acbc205d801f2 /docs/user-guide | |
| parent | a2a201e327559e6a24b081fee73096b2a3b3e33f (diff) | |
Describe experimental COM interfaces (#5397)
Fixes #5212
Co-authored-by: Yong He <yonghe@outlook.com>
Diffstat (limited to 'docs/user-guide')
| -rw-r--r-- | docs/user-guide/08-compiling.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/user-guide/08-compiling.md b/docs/user-guide/08-compiling.md index 0160cd4df..623a3111f 100644 --- a/docs/user-guide/08-compiling.md +++ b/docs/user-guide/08-compiling.md @@ -314,6 +314,9 @@ Application code is expected to correctly maintain the reference counts of `ISla Many Slang API calls return `SlangResult` values; this type is equivalent to (and binary-compatible with) the standard COM `HRESULT` type. As a matter of convention, Slang API calls return a zero value (`SLANG_OK`) on success, and a negative value on errors. +> #### Note #### +> Slang API interfaces may be named with the suffix "_Experimental", indicating that the interface is not complete, may have known bugs, and may change or be removed between Slang API releases. + ### Creating a Global Session A Slang _global session_ uses the interface `slang::IGlobalSession` and it represents a connection from an application to a particular implementation of the Slang API. |