summaryrefslogtreecommitdiffstats
path: root/docs/user-guide
Commit message (Collapse)AuthorAge
...
* Add link to metal docs and regen TOC (#5616)Ellie Hermaszewska2024-11-20
| | | | | | | | | * Add link to metal docs * Regenerate TOC --------- Co-authored-by: Yong He <yonghe@outlook.com>
* Metal documentation (#5549)Ellie Hermaszewska2024-11-19
| | | | | Closes https://github.com/shader-slang/slang/issues/4262 Co-authored-by: Yong He <yonghe@outlook.com>
* Markdown emphasis corrections (#5588)Ellie Hermaszewska2024-11-19
| | | | | | | | | | | | | | | | | * Add markdown formatting to extras/formatting.sh * Correct formatting in markdown * Warn on unrecognized argument in formatting script * Print all diffs in formatting script * Correct markdown emph formatting * Don't format markdown by default --------- Co-authored-by: Yong He <yonghe@outlook.com>
* Document WGSL-specific features (#5571)Anders Leino2024-11-19
| | | | | Issue #5567. Co-authored-by: Yong He <yonghe@outlook.com>
* Update user-guide top bar nav links. (#5488)Yong He2024-11-04
|
* Increase slangc option visibility in docs (#5425)cheneym22024-10-29
| | | | | | | | | | | | | | | | | | * Increase slangc option visibility in docs Link to slangc command-line reference from readme. readme. Boost the visiblity of the link in the user-guide. Consolidates command-line-slangc.md into the user-guide. Fixes #4124 * Update README.md * Update 08-compiling.md --------- Co-authored-by: Yong He <yonghe@outlook.com>
* Add `InterlockedAddF64` intrinsic. (#5412)Yong He2024-10-27
|
* Swap the term StdLib with Core-Module or Standard-Module in documents (#5414)Jay Kwak2024-10-25
| | | | This PR is limited to documents. All use of "Standard library" or "StdLib" are replaced with either "core module" or "standard modules", depending on the context.
* Describe experimental COM interfaces (#5397)cheneym22024-10-24
| | | | | Fixes #5212 Co-authored-by: Yong He <yonghe@outlook.com>
* Misc build fixes. (#5271)Yong He2024-10-14
| | | | | | | | | | | | | | | | | * Don't use __assume for SLANG_ASSERT + build fixes. * Fix. * build slang-wasm conditionally * Fix. * revert retry open file * revert include. * another attempt of silencing compiler warnings. * revert assume change.
* reword documentation around precompiled modules. (#5249)Yong He2024-10-09
|
* Remove text on inheritance support in user-guide. (#5154)Yong He2024-09-25
|
* Update auto-diff user guide (#5071)Sai Praveen Bangaru2024-09-18
| | | | | | - Remove `dmul` entirely (will be deprecated soon) - Add text about `IDifferentiablePtrType` Co-authored-by: Yong He <yonghe@outlook.com>
* Add `IRWArray` interface, and make StructuredBuffer conform to them. (#5097)Yong He2024-09-18
| | | | | | | | | * Add `IRWArray` interface, and make StructuredBuffer conform to them. * Update user guide. * Fix. * Fixes.
* Fix doc build errors. (#5018)Yong He2024-09-05
|
* Various documentation improvements. (#5017)Yong He2024-09-05
|
* Support `where` clause and type equality constraint. (#4986)Yong He2024-09-05
| | | | | | | | | | | | | | | | | * Support `where` clause. * Fix. * Fix parser. * Enhance test to cover traditional __generic syntax. * Update user-guide. * Support `where` clause on associatedtype. * Fix. * Put in more comments.
* Document All Capability Atoms and Profiles (#5008)ArielG-NV2024-09-05
| | | | | | | | | | | | | | | | * Document All Capability Atoms and Profiles Fixes: #4125 Unimplemented Considerations: 1. This PR does not add support to query all capability-atom's from a command-line option. It is understood that this might be desired, due to this, the logic to generate `docs\user-guide\a3-02-reference-capability-atoms.md` was made to be "command-line friendly" so minimal changes are needed to pipe our documentation into a command-line option if this change is to be added. Changes: 1. Added a way to document atoms inside `.capdef`. Method to document is described under `source\slang\slang-capabilities.capdef`. The goal is to error if a public atom does not have any form of documentation to ensure we always have up-to-date documentation to guide user on what an atom is/does. * The following `.capdef` file syntax was added * /// [HEADER_GROUP] * /// regular comment 2. When capability generator runs it auto-generates `docs\user-guide\a3-02-reference-capability-atoms.md` 3. Added to the user-guide 3 sections: `Reference`, `Reference -> Capability Profiles`, `Reference -> Capability atoms` section
* Add Documentation For Auto-Generated Constructors & Initializer Lists (#4988)ArielG-NV2024-09-04
| | | | | | | | | | | | | * Add documentation for auto-generated constructors & Initializer Lists fixes: #4903 Add documentation for auto-generated constructors & Initializer Lists, the logic behind this PR is on #4854 * clean up documentation as per review comments --------- Co-authored-by: Yong He <yonghe@outlook.com>
* Fix extension override behavior, and disallow extension on interface types. ↵Yong He2024-09-04
| | | | | | | | | | | | | (#4977) * Add a test to ensure extension does not override existing conformance. * Fix doc. * Update documentation. * Fix doc. * Add diagnostic test.
* User guide page for SPIR-V target specific information (#4815)Jay Kwak2024-08-30
| | | Adding a user guide page for SPIR-V specific features.
* Add functor syntax support. (#4926)Yong He2024-08-27
|
* Document notable `__ref` uss in stdlib. Remove user docs use of '__ref'. (#4799)ArielG-NV2024-08-27
| | | | | | | 1. Document `__ref` in stdlib. 2. Remove `__ref` example in `docs\user-guide\a1-04-interop.md` 3. New example in `docs\user-guide\a1-04-interop.md` to compensate for no longer providing an example that uses `&` and `OpCapability`/`OpExtension`. Co-authored-by: Yong He <yonghe@outlook.com>
* Tuple swizzling, concat, comparison and `countof`. (#4856)Yong He2024-08-19
| | | | | | | | | | | * Tuple swizzling and element access. * Update proposal status. * Cleanup. * Fix merrge error. * Address review.
* Update documentation for #include to indicate it is for legacy code and new ↵Ellie Hermaszewska2024-08-16
| | | | | code should use modules (#4862) Closes https://github.com/shader-slang/slang/issues/4281
* Allow passing sized array to unsized array parameter. (#4744)Yong He2024-07-26
|
* Add Metal to user-guide/09-targets.md (#4703)Jay Kwak2024-07-23
| | | | | | | * Add Metal to user-guide/09-targets.md Partially resolves #4262 The description of "Parameter passing" part for Metal is related to PR #4022
* Move if_let syntax to convenience-features section (#4628)kaizhangNV2024-07-15
| | | | | | | | | | | * Move if_let syntax to convenience-features section * Fix the syntax for setting up an anchor * update the comment on sample code * Add example for if_let syntax * Address the comments
* Add reflection API for functions. (#4587)Yong He2024-07-10
| | | | | | | | | | | * Add reflection API for functions. This change adds `SlangFunctionReflection` type in the reflection API that provides methods for querying function result type, parameters and user-defined attributes. `ProgramLayout::findFunctionByName` can now find a function with the given name and returns a `FunctionReflection`. `IEntryPoint` now has a `getFunctionReflection` method that returns an `FunctionReflection` for the entrypoint. * More modifiers; make reflection API consistent.
* Add user guide section on user-defined attributes. (#4557)Yong He2024-07-10
| | | | | * Add user guide section on user-defined attributes. * Update toc
* Adding a note about the keyword, class. (#4503)Jay Kwak2024-06-28
| | | Closes #4448
* Typo in 06-interfaces-generics.md (#4284)Elie Michel2024-06-06
| | | Co-authored-by: Jay Kwak <82421531+jkwak-work@users.noreply.github.com>
* Fix python syntax highlighting in slangpy chapter (#4282)Elie Michel2024-06-06
|
* Various issues in code snippets (#4247)Elie Michel2024-05-30
| | | | | Fixed as I was testing release `v2024.1.17` (latest) Co-authored-by: ArielG-NV <159081215+ArielG-NV@users.noreply.github.com>
* Update document regarding pointer (#4248)Jay Kwak2024-05-30
| | | And also add an actual test case from the User Guide example.
* Fix confusion in Translation Units doc (#4245)Elie Michel2024-05-30
| | | | | I think the sentence was saying the opposite of what it meant! Co-authored-by: Yong He <yonghe@outlook.com>
* Fix small typo (#4246)Elie Michel2024-05-30
|
* Fix pointer example (#4224)cheneym22024-05-24
| | | | | | | * Fix pointer example Make the example shown for pointers something that would compile. Don't redefine pNext and do define MyType. * Fix formatting of struct in pointer example
* Fix pointers link in userguide (#4217)cheneym22024-05-23
| | | | | Adding (limited) to the header in a previous doc change broke the link. Co-authored-by: Jay Kwak <82421531+jkwak-work@users.noreply.github.com>
* Update 03-convenience-features.md (#4179)ArielG-NV2024-05-16
| | | add member init expr and constructor logic to the docs
* Slang: update pointer related documentation (#4088)cheneym22024-05-02
| | | | | | | | | Slang does have some support for pointers. Remove an outdated comment stating the contratry, and update the section that describes pointer support to also list some relevant limitations. Fixes #3970 Co-authored-by: Yong He <yonghe@outlook.com>
* Implement if(let ...) syntax (#3673) (#3958)kaizhangNV2024-04-17
|
* Fix Slang documentation typos (#3961)cheneym22024-04-16
|
* Documentation: fix typos and grammar (#3945)bprb2024-04-13
|
* Rename slangpy -> slangtorch in documentation. (#3922)Yong He2024-04-09
|
* Delete out-of-date notes from user guide. (#3877)Yong He2024-04-03
| | | We support partial generic parameter inference today.
* Add documentation about constructors (#3879)Yong He2024-04-03
|
* Update user guilde for new features. (#3875)Yong He2024-04-02
|
* Support arrow operator `->` on pointers. (#3812)Yong He2024-03-21
|
* Update a1-01-matrix-layout.mdYong He2024-03-20
|
generated by cgit v1.2.3 (git 2.39.1) at 2026-06-02 08:30:59 +0000