summaryrefslogtreecommitdiff
path: root/docs/user-guide/02-conventional-features.md
AgeCommit message (Collapse)Author
2025-07-27Fix broken links in User Guide (#7938)aidanfnv
* Fix broken links in User Guide * Fix link text with filename, use title
2025-07-23Added small section about default values of `struct` members (#7844)Šimon
* Added small section about default values of `struct` members * Added one more example and made `int a` to be brace initilised as well * Implemented suggested changes * Update docs/user-guide/02-conventional-features.md Co-authored-by: Yong He <yonghe@outlook.com> --------- Co-authored-by: Yong He <yonghe@outlook.com>
2025-05-08Fix broken links in Slang docs (#7039)aidanfnv
This change fixes some broken links/anchors in the Slang docs that I found after running a link checker tool on the readthedocs site. Some of these were broken on GitHub Pages as well, such as anchors with apostrophes or docs that were moved. The doc writer change adds an explicit .html extension to Parameter links, so that Sphinx/RTD does not treat it as an anchor.
2025-04-11Fix user-guide typos (#6789)Gangzheng Tong
* Fix user-guide typos Use LLM to scan each of the markdown files to fix typos. Try not to change anything but the typos in this CL. * typo not caught by LLM * add output of ./build_toc.ps1
2025-04-06Add defer statement (#6619)Julius Ikkala
2025-02-26Improve entry point lookup function documentation (#6451)Anders Leino
* Document that findEntryPointByName is not applicable if there is no [shader(...)] attribute * Update the user guide to mention findAndCheckEntryPoint for entry points without [shader(...)] attributes * format code --------- Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com> Co-authored-by: Yong He <yonghe@outlook.com>
2024-12-28Fix tiny typos (#5944)Yuki Nishidate
2024-12-03Conform non-suffixed integer literals (#5717)Darren Wihandi
* 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>
2024-11-29Fix markdown mistakes on user guide (#5672)Jay Kwak
* Fix markdown typos * Fix indentation * Fix indentation 2 * Fix indentation 3 * Fix indentation more --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-11-29docs: Reduce typo count (#5671)Bruce Mitchener
Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-11-26Document the restrictions for vector size (#5673)Jay Kwak
Added a note to clarify that vector types cannot have size bigger than 4.
2024-11-22Fixed type (#5639)KoT
vec3x4 to mat3x4 Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-25Swap the term StdLib with Core-Module or Standard-Module in documents (#5414)Jay Kwak
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.
2024-09-05Fix doc build errors. (#5018)Yong He
2024-09-04Add Documentation For Auto-Generated Constructors & Initializer Lists (#4988)ArielG-NV
* 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>
2024-08-16Update documentation for #include to indicate it is for legacy code and new ↵Ellie Hermaszewska
code should use modules (#4862) Closes https://github.com/shader-slang/slang/issues/4281
2024-07-26Allow passing sized array to unsized array parameter. (#4744)Yong He
2024-06-28Adding a note about the keyword, class. (#4503)Jay Kwak
Closes #4448
2024-05-02Slang: update pointer related documentation (#4088)cheneym2
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>
2024-04-16Fix Slang documentation typos (#3961)cheneym2
2024-04-13Documentation: fix typos and grammar (#3945)bprb
2024-04-03Add documentation about constructors (#3879)Yong He
2024-04-02Update user guilde for new features. (#3875)Yong He
2024-03-14Support unscoped enums. (#3771)Yong He
2024-02-05Add documentation on capability system. (#3549)Yong He
Fixes #3454.
2024-01-18Docs for local vs global uniform parameters (#3459)Nathan V. Morrical
2024-01-17updated docs to more clearly define differences in sizeof(bool) depending on ↵Nathan V. Morrical
the target platform (#3458) Co-authored-by: Yong He <yonghe@outlook.com>
2023-11-27typo re: global variables (#3351)mighdoll
Co-authored-by: Yong He <yonghe@outlook.com>
2023-04-12Update 02-conventional-features.mdYong He
2021-12-22Hotfix/doc typo5 (#2070)jsmall-nvidia
* #include an absolute path didn't work - because paths were taken to always be relative. * Fix typos in introduction and conventional features. * Struct inheritance is allowed. Fix some typos.
2021-03-30Add layout front matter specifier for user-guide docs (#1770)Yong He
2021-02-12Further documentation work (#1703)Tim Foley
* Move around the conventional/convenience features chapters * Add a first draft of a section on compilation using `slangc` and the COM-lite API Co-authored-by: Yong He <yonghe@outlook.com>