diff options
Diffstat (limited to 'examples/hello/README.md')
| -rw-r--r-- | examples/hello/README.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/examples/hello/README.md b/examples/hello/README.md index a571bb274..31a983428 100644 --- a/examples/hello/README.md +++ b/examples/hello/README.md @@ -1,9 +1,12 @@ Slang "Hello World" Example =========================== -The goal of this example is to demonstrate an almost minimal application that uses Slang for shading, and D3D11 for rendering. +The goal of this example is to demonstrate an almost minimal application that uses Slang for shading. + +The `hello.slang` file contains simple vertex and fragment shader entry points. The shader code should compile as either Slang or HLSL code (that is, this example does not show off any new Slang language features). -The `hello.slang` file contains simple vertex and fragment shader entry points. The `hello.cpp` file contains the C++ application code, showing how to use the Slang C API to load and compile the shader code to DirectX shader bytecode (DXBC). +The application perform rendering using the D3D11 API, through a platform and graphics API abstraction layer that is implemented in `tools/slang-graphics`. +Note that this abstraction layer is *not* required in order to work with Slang, and it is just there to help us write example applications more conveniently. -Note that this example is not intended to demonstrate good practices for integrating Slang into a production engine; the goal is merely to use the minimum amount of code possible to demonstrate a complete applicaiton that uses Slang. +This example is not necessarily representative of best practices for integrating Slang into a production engine; the goal is merely to use the minimum amount of code possible to demonstrate a complete applicaiton that uses Slang. |