summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2024-11-19Metal documentation (#5549)Ellie Hermaszewska
Closes https://github.com/shader-slang/slang/issues/4262 Co-authored-by: Yong He <yonghe@outlook.com>
2024-11-19Markdown emphasis corrections (#5588)Ellie Hermaszewska
* 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>
2024-11-19Document WGSL-specific features (#5571)Anders Leino
Issue #5567. Co-authored-by: Yong He <yonghe@outlook.com>
2024-11-14Proposal for a language version directive. (#5555)Theresa Foley
2024-11-11Reflection compiler option (#5507)tareksander
* Moved the pretty writer code from slang-reflection-test into core * Moved reflection test code into the slang codebase and added the compiler option -reflection-json to store the reflection data in a separate file. * Documented -reflection-json command line option * moved PrettyWriter from core to compiler-core * Fixed variable shadowing warning * Use File::writeAllText instead of OSFilesystem and write to stdout if - is used as the path * format code * Fixed linker error * Fix COM Ptr life time issues. * Move enum to the end. * Fix formatting. --------- Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com> Co-authored-by: Yong He <yonghe@outlook.com>
2024-11-11mention code formatting in contribution guidelines (#5514)Ellie Hermaszewska
Co-authored-by: Yong He <yonghe@outlook.com>
2024-11-04Update user-guide top bar nav links. (#5488)Yong He
2024-10-30fix javascript error on doc layout. (#5464)Yong He
2024-10-30Find slangc in more places in doc generation script (#5461)Ellie Hermaszewska
Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-30Add design doc for write-only textures. (#5455)Yong He
* Add design doc for write-only textures. * Minor tweaks.
2024-10-30Add google analytics. (#5438)Yong He
2024-10-30format yaml and json (#5428)Ellie Hermaszewska
* format yaml and json * format shell scripts
2024-10-29Put debug symbols in releases (#5370)Ellie Hermaszewska
2024-10-29Increase slangc option visibility in docs (#5425)cheneym2
* 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>
2024-10-27Add `InterlockedAddF64` intrinsic. (#5412)Yong He
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-10-25Replace stdlib with core-module on files and projects (#5411)Jay Kwak
This commit renames the files and projects to prefer "core-module" over "stdlib". The directory name `source/slang-stdlib` needs to be renamed too, and there will be another commit for it soon.
2024-10-25Replace stdlib on Slang API with CoreModule (#5405)Jay Kwak
This is a breaking change in a way that the Slang API function names are changed. All of them are commented as "experimental" and we wouldn't provide a back-ward compatibility for them. Following functions are renamed: compileStdLib() -> compileCoreModule() loadStdLib() -> loadCoreModule() saveStdLib() -> saveCoreModule() slang_createGlobalSessionWithoutStdLib() -> slang_createGlobalSessionWithoutCoreModule() slang_getEmbeddedStdLib() -> slang_getEmbeddedCoreModule() hasDeferredStdLib() -> hasDeferredCoreModule() Following command-line arguments are renamed: "-load-stdlib" -> "-load-core-module" "-save-stdlib" -> "-save-core-module" "-save-stdlib-bin-source" -> "-save-core-module-bin-source" "-compile-stdlib" -> "-compile-core-module"
2024-10-24Describe experimental COM interfaces (#5397)cheneym2
Fixes #5212 Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-24Fix a few documentation typos (#5396)cheneym2
2024-10-22Update update_spirv.mdJay Kwak
Rewording the document to make the testing step mandatory.
2024-10-22Update the document, `update_spirv.md` (#5368)Jay Kwak
This commit updates the document about how to update the SPIRV submodules.
2024-10-18Make slang-llvm fetching and failure more robust (#5346)Ellie Hermaszewska
* Make slang-llvm fetching and failure more robust Improve error reporting when things go wrong. Fall back by default to a non-llvm build Closes https://github.com/shader-slang/slang/issues/5247 Tested sensible behavior with: - `FETCH_BINARY_IF_POSSIBLE`, valid tag - No errors or warnings, successful build with llvm - `FETCH_BINARY_IF_POSSIBLE`, no valid tag - Warning message, successful llvm build with slang-llvm from latest release - `FETCH_BINARY_IF_POSSIBLE`, no valid tag, bad `SLANG_SLANG_LLVM_BINARY_URL` specified - Warning message, successful no-llvm build - `FETCH_BINARY_IF_POSSIBLE`, no valid tag, unable to fetch release information - Warning message, successful no-llvm build - `FETCH_BINARY`, valid tag - No errors or warnings, successful build with llvm - `FETCH_BINARY`, no valid tag - Warning message, successful llvm build with slang-llvm from latest release - `FETCH_BINARY`, no valid tag, bad `SLANG_SLANG_LLVM_BINARY_URL` specified - Error, explaining that we couldn't fetch it - `FETCH_BINARY`, no valid tag, unable to fetch release info - Error, explaining that we couldn't fetch it * Allow downloading from a local file --------- Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-18Remove sccache (#5206)Ellie Hermaszewska
* Remove sccache * CI docs
2024-10-15Add docgen documentation. (#5318)Yong He
2024-10-15Add stdlib documentation for attributes and interfaces. (#5297)Yong He
* Add stdlib documentation for attributes and interfaces. * Fix name mangling to avoid collision of functions in different extensions. * Fix doc.
2024-10-15review and revise building instructions (#5302)Ellie Hermaszewska
Closes https://github.com/shader-slang/slang/issues/3905 Would be good to tackle this as a follow on https://github.com/shader-slang/slang/issues/5247 Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-15Lower minimum CMake version to 3.22 (#5295)Ellie Hermaszewska
* Lower minimum CMake version to 3.22 Reverts https://github.com/shader-slang/slang/pull/4193 * Update build instructions to mention older CMake versions
2024-10-14Misc build fixes. (#5271)Yong He
* 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.
2024-10-11Add slang-wasm target (#5237)Anders Leino
Support for exceptions is enabled, since Slang uses them for diagnostics. The size optimization arguments ('-Os') resolves some internal emscripten error during the slang-wasm.wasm linking step, which happens when enabling exceptions. ("parse exception: too many locals")
2024-10-09reword documentation around precompiled modules. (#5249)Yong He
2024-10-08Overhaul docgen tool and setup CI to generate stdlib reference. (#5232)Yong He
* Overhaul docgen tool and setup CI to generate stdlib reference. * Fix build error. * Write parsed doc for all decls. * fix. * fix callout. * Fix. * Fix comment. * Fix. * Delete obsolete doc tests. * Fix. * Categorize functions and types. * Fix CI. * Update comments.
2024-09-27Add CI step to build WebAssembly version of Slang (#5164)Jay Kwak
Closes #5117 This adds a build step of WebAssembly version of Slang. Currently it is enabled only for Linux/Release to reduce the time cost of CI, but the builds were all successful on all platforms and configurations when tested.
2024-09-27Design proposal for initialization. (#5142)Yong He
* Design proposal for initialization. * extension * QA * wording * Update design. * more revisions. * revise text. * rewording to be more accurate. * Fix wording and add explanation to examples. * clarify on zero initialization. * refine the rules and examples. * update status.
2024-09-25Remove text on inheritance support in user-guide. (#5154)Yong He
2024-09-25Make release note generation script shebang portable (#5145)Ellie Hermaszewska
Co-authored-by: Jay Kwak <82421531+jkwak-work@users.noreply.github.com>
2024-09-25Enable emscripten builds to compile slang.dll to WebAssembly. (#5131)Anders Leino
* Compile fixes for Wasm The issues are all are due to 'long' types being 32 bits on WASM. - class members redeclared errors - << with StringBuilder and unsigned long is ambiguous This helps to address issue #5115. * Use the host executable suffix for generators Since the generators are run at build-time, we should not use CMAKE_EXECUTABLE_SUFFIX, which is the suffix for the target platform. Instead, define CMAKE_HOST_EXECUTABLE_SUFFIX as appropriate, and use that suffix instead. This helps to address issue #5115. * Add support for Wasm as a platform This helps to address issue #5115. * Add emscripten build This closes #5115.
2024-09-20Update 003-atomic-t.mdYong He
2024-09-20Initial `Atomic<T>` type implementation. (#5125)Yong He
* Initial Atomic<T> type implementation. * Update design doc. * Fix. * Add test. * Fixes and add tests. * Fix WGSL. * Fix glsl. * Fix metal. * experiemnt with github metal. * experiment github metal 2 * github metal experiment 3 * experiment with github metal 4. * experiment with metal 5. * experiment 7. * metal experiment 8. * Fix metal tests. --------- Co-authored-by: Yong He <yhe@nvidia.com>
2024-09-19Add design doc for atomic<T> type. (#5101)Yong He
* Add design doc for atomic<T> type. * Update design doc. * Fix. * More comment on parameters.
2024-09-18Update auto-diff user guide (#5071)Sai Praveen Bangaru
- Remove `dmul` entirely (will be deprecated soon) - Add text about `IDifferentiablePtrType` Co-authored-by: Yong He <yonghe@outlook.com>
2024-09-18Add `IRWArray` interface, and make StructuredBuffer conform to them. (#5097)Yong He
* Add `IRWArray` interface, and make StructuredBuffer conform to them. * Update user guide. * Fix. * Fixes.
2024-09-16release-note.sh fixes (#5068)cheneym2
Add a gh.exe search path that works with cygwin installations. Do not bail out from the breaking changes loop when a change is found without PR#. Instead, continue to the next one. This fixes an issue where [BREAKING] changes appear in the detailed change list by not in the summary of breaking changes.
2024-09-09Add proposal for equality constraints (#5043)Theresa Foley
This proposal builds on the other proposal for `where` clauses. Co-authored-by: Yong He <yonghe@outlook.com>
2024-09-05Update 000-template.mdYong He
2024-09-05Update 010-new-diff-type-system.mdYong He
2024-09-05Update 007-variadic-generics.mdYong He
2024-09-05Update 001-where-clauses.mdYong He
2024-09-05Update proposal templateYong He
2024-09-05Fix doc build errors. (#5018)Yong He