<feed xmlns='http://www.w3.org/2005/Atom'>
<title>slang.git/docs/api-users-guide.md, branch master</title>
<subtitle>Making it easier to work with shaders</subtitle>
<id>https://git.yummers.dev/slang.git/atom?h=master</id>
<link rel='self' href='https://git.yummers.dev/slang.git/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/'/>
<updated>2024-03-17T22:17:28+00:00</updated>
<entry>
<title>Remove out of date documentation on compilation API. (#3785)</title>
<updated>2024-03-17T22:17:28+00:00</updated>
<author>
<name>Yong He</name>
<email>yonghe@outlook.com</email>
</author>
<published>2024-03-17T22:17:28+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=667e209bc714761eb2f48b65f0153574bd0b65f2'/>
<id>urn:sha1:667e209bc714761eb2f48b65f0153574bd0b65f2</id>
<content type='text'>
* Remove out of date documentation on compilation API.

* Update toc.</content>
</entry>
<entry>
<title>Correct user guide's section on preprocessor directives (#2565)</title>
<updated>2022-12-19T16:20:24+00:00</updated>
<author>
<name>Ellie Hermaszewska</name>
<email>ellieh@nvidia.com</email>
</author>
<published>2022-12-19T16:20:24+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=145a0f634ac8fb5cefe081237be1610740dd339a'/>
<id>urn:sha1:145a0f634ac8fb5cefe081237be1610740dd339a</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Atomic ref counting for ISlangSharedLibrary (#2332)</title>
<updated>2022-07-18T19:44:29+00:00</updated>
<author>
<name>jsmall-nvidia</name>
<email>jsmall@nvidia.com</email>
</author>
<published>2022-07-18T19:44:29+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=2e4b5770fa7e6dbf56845382706b33a22d6a025b'/>
<id>urn:sha1:2e4b5770fa7e6dbf56845382706b33a22d6a025b</id>
<content type='text'>
* #include an absolute path didn't work - because paths were taken to always be relative.

* Make ISlangSharedLibrary atomic ref counted.
Update docs to say most COM interfaces are *not* atomic ref counted.

* Upgrade slang-llvm to use version that atomic ref counts ISlangSharedLibrary.

* Fix some typos in docs.

* Fix ref count typo.

* Fix missing 'override'</content>
</entry>
<entry>
<title>Add multithreading doc section (#2298)</title>
<updated>2022-06-24T19:29:34+00:00</updated>
<author>
<name>jsmall-nvidia</name>
<email>jsmall@nvidia.com</email>
</author>
<published>2022-06-24T19:29:34+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=c12c0ad7fbb0272283f224493dbc28d9d60e7b91'/>
<id>urn:sha1:c12c0ad7fbb0272283f224493dbc28d9d60e7b91</id>
<content type='text'>
* #include an absolute path didn't work - because paths were taken to always be relative.

* Attempt to describe how to multi-thread slang.

* Fix HTML typo.

* Improve multithreading doc.

* Small typo fix.</content>
</entry>
<entry>
<title>Generate Visual Studio projects using Premake (#557)</title>
<updated>2018-05-11T23:34:19+00:00</updated>
<author>
<name>Tim Foley</name>
<email>tfoleyNV@users.noreply.github.com</email>
</author>
<published>2018-05-11T23:34:19+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=e2c2c220c642cc5f1c622f909d0ddfd22e6c04d4'/>
<id>urn:sha1:e2c2c220c642cc5f1c622f909d0ddfd22e6c04d4</id>
<content type='text'>
* Generate Visual Studio projects using Premake

This change adds a `premake5.lua` file that allows us to generate our Visual Studio solution using Premake 5 (https://premake.github.io/).
The existing Visual Studio solution/projects are now replaced with the Premake-generated ones, and project contributors will be expected to update these by running premake after adding/removing files.

I have *not* changed the Linux `Makefile` build at all, because that file is also used for things like running our tests, so that clobbering it with a premake-generated `Makefile` would break our continuous testing.
Hopefully future changes can switch to a generated `Makefile` and perhaps even add an XCode project as well.

Notes:

* The `build/slang-build.props` file is no longer needed/used, so it has been removed.

* The `slang-eval-test` test fixture wasn't following our naming conventions for its directory path, so it was updated to streamline the Premake build configuration work. This required changes to the `Makefile` as well

* Some seemingly unncessary preprocessor definitions that were specified for `core` and `slang-glslang` have been dropped. We will see if anything breaks from that.

* Possible fixup for Premake vpath issue

Premake's `vpath` feature seems to be nondeterministic about the order it applies filters (because Lua isn't deterministic about the order of entries in a key/value table), and as a result we can end up in a weird case where it decides that a `foo.cpp.h` file matches the `**.cpp` filter (I'm not sure why) before it tests against the `**.h` filter.

This change uses an (undocumented) Premake facility to set `vpath` using a list of singleton tables, which seems to fix the order in which things get tested.

* Remove support for "single-file" build of Slang

The `hello` example was the only bit of code that uses the "single-file" way of building Slang, and this had already run up against limitations of the Visual Studio compilers in its Debug|x64 build.
Rather than mess with Premake to make it pass through the `/bigobj` linker flag that is needed to work around the issue, it makes more sense just to stop using/supporting the feature since we wouldn't want users to depend on it anyway (our documentation no longer refers to it).

While I was at it I went ahead and made sure that the `SLANG_DYNAMIC` flag doesn't need to be set manually, so that instead there is a non-default `SLANG_STATIC` option (not that we have a static-library build of Slang at the moment).
</content>
</entry>
<entry>
<title>Fixed some small typos in api-users-guide.md (#446)</title>
<updated>2018-03-16T19:02:55+00:00</updated>
<author>
<name>jsmall-nvidia</name>
<email>jsmall@nvidia.com</email>
</author>
<published>2018-03-16T19:02:55+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=04c9476622cc22daa0994c8141f686405858c8a7'/>
<id>urn:sha1:04c9476622cc22daa0994c8141f686405858c8a7</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Typos (#444)</title>
<updated>2018-03-16T16:06:01+00:00</updated>
<author>
<name>Tim Foley</name>
<email>tfoleyNV@users.noreply.github.com</email>
</author>
<published>2018-03-16T16:06:01+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=4c23ba2af6dfb244bbf193f2e540e5e70e13f629'/>
<id>urn:sha1:4c23ba2af6dfb244bbf193f2e540e5e70e13f629</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Revamp documentation (#395)</title>
<updated>2018-02-02T18:38:22+00:00</updated>
<author>
<name>Tim Foley</name>
<email>tfoleyNV@users.noreply.github.com</email>
</author>
<published>2018-02-02T18:38:22+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=58475a8aa42284722a3763aa3bde49f2fa40366e'/>
<id>urn:sha1:58475a8aa42284722a3763aa3bde49f2fa40366e</id>
<content type='text'>
- Remove references to building by embedding source (not recommended at this point)

- Push users more toward binary builds rather than building from source (but include a document that talks about how to build)

- Remove most (all?) references to supporting GLSL input

- Expand the language guide to talk about the new features

- Add a document that talks about the parameter layout algorithm</content>
</entry>
<entry>
<title>Update documentation.</title>
<updated>2017-07-26T21:56:45+00:00</updated>
<author>
<name>Tim Foley</name>
<email>tfoley@nvidia.com</email>
</author>
<published>2017-07-26T21:21:29+00:00</published>
<link rel='alternate' type='text/html' href='https://git.yummers.dev/slang.git/commit/?id=92463c8f235e41a226943c629ed2d89a21935cf1'/>
<id>urn:sha1:92463c8f235e41a226943c629ed2d89a21935cf1</id>
<content type='text'>
- Update readme to fill out some of the `TODO` sections

- Add an API user's guide that gives the basics of linking against Slang and using it to compile and reflect shaders

- Add a bit of usage info for the command-line `slangc` program

- Add an overview of the Slang language as it stands today

- Add an initial FAQ, mostly to help answer the "why should I use this?" question
</content>
</entry>
</feed>
