summaryrefslogtreecommitdiffstats
path: root/docs/user-guide
Commit message (Collapse)AuthorAge
* Fix tiny typos (#5944)Yuki Nishidate2024-12-28
|
* Add base vertex and base instance system values (#5918)Darren Wihandi2024-12-19
| | | | | * Add base vertex and base instance system values * Fixed incorrect stage in tests
* Support explicit `[vk::location(n)]` binding on metal/wgsl. (#5907)Yong He2024-12-18
|
* Update 09-reflection.md (#5886)Yong He2024-12-17
|
* Update reflection API chapter in User Guide (#5868)Theresa Foley2024-12-13
| | | | | | | | | | | * Update reflection API chapter in User guide The new version of the chapter is intended to accompany the `reflection-api` example program, and reflects (pun intended) the best practices that the Slang project team wants to encourage for interacting with the reflection API. * Rebuild TOCs
* Add SV_DrawIndex. (#5787)Yong He2024-12-09
| | | Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* Support specialization constant on WGSL and Metal. (#5780)Yong He2024-12-06
|
* Implement explciit binding for metal and wgsl. (#5778)Yong He2024-12-06
| | | | | | | | | | | | | | | * Respect explicit bindings in wgsl emit. * Implement explciit binding generation for metal and wgsl. * Update toc. * Fix warnings in tests. * Fix tests. --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* Conform non-suffixed integer literals (#5717)Darren Wihandi2024-12-03
| | | | | | | | | | | | | | | | | | | | | * Make non-suffixed integer literal type resolution conform to C * Update integer literal tests * Clean up integer literal implementation a bit * Update docs on integer literals * Clean up docs update * Clean up docs update * Add comment on INT64_MIN edge case * Fixed failing test, fixed formatting and cleaned up code --------- Co-authored-by: Yong He <yonghe@outlook.com>
* [Docs] Fix dead links when subsection title have underscore (#5662)Ica2024-12-02
| | | | | | | | | | | | | | * [Docs] Fix dead links when subsection title have underscore a minor change on build toc script: add underscore to link instead of replacing with "-" then I re-run the script also I tested on local server * Update toc.html --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com> Co-authored-by: Yong He <yonghe@outlook.com>
* Add WebGPU target doc (#5708)Anders Leino2024-12-02
| | | | | | | * Add WebGPU target doc This closes #5698. * Update ToC
* [Docs] Minor fixes to auto-diff documentation (#5621)Sai Praveen Bangaru2024-12-01
| | | | | | | | | | | | * Minor fixes to AD documentation * Add a note warning about experimental behavior * Update vulkan --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com> Co-authored-by: Yong He <yonghe@outlook.com>
* Fix markdown mistakes on user guide (#5672)Jay Kwak2024-11-29
| | | | | | | | | | | | | | | * Fix markdown typos * Fix indentation * Fix indentation 2 * Fix indentation 3 * Fix indentation more --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* docs: Reduce typo count (#5671)Bruce Mitchener2024-11-29
| | | Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* Document the restrictions for vector size (#5673)Jay Kwak2024-11-26
| | | Added a note to clarify that vector types cannot have size bigger than 4.
* Fix broken link in 09-reflection.md (#5655)Elie Michel2024-11-25
| | | | | | | | | * Fix broken link in 09-reflection.md * Fix another link on 08-compiling.md --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* [Docs] Re-run build_toc and fix dead links (#5647)Ica2024-11-25
| | | | | | | | | * re-run build_toc.ps1 * fix dead link of readme --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
* Fixed type (#5639)KoT2024-11-22
| | | | | vec3x4 to mat3x4 Co-authored-by: Yong He <yonghe@outlook.com>
* [Docs] fix spirv dead links on toc.html (#5638)Ica2024-11-22
| | | | | I believe this will fix the dead links that occurred because of sub section renames. Co-authored-by: Yong He <yonghe@outlook.com>
* [Docs] Optional<T> - fix small typo on example (#5637)Ica2024-11-21
| | | Co-authored-by: Yong He <yonghe@outlook.com>
* [Docs] Extensions - better wording for c# equivalent (#5636)Ica2024-11-21
| | | | | slang extensions look pretty same c# extension methods, not partial classes. Partial classes allow extending types to introduce more variables unlike slang extensions. Also c# users that use extension methods much more than partial types, probably. Co-authored-by: Yong He <yonghe@outlook.com>
* Add datalayout for constant buffers. (#5608)Yong He2024-11-21
| | | | | | | | | | | | | | | | | | | * Add datalayout for constant buffers. * Fixes. * Fix test. * Fix glsl codegen. * Update spirv-specific doc. * Fix test. * Fix binding in the presense of specialization constants. * address comments. * Add a test for constant buffer layout.
* Add description on write-only textures in wgsl doc.Yong He2024-11-20
|
* Small docs corrections (#5615)Ellie Hermaszewska2024-11-20
| | | | | | | | | * Small docs corrections * fix typo. --------- Co-authored-by: Yong He <yonghe@outlook.com>
* 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
|