Skip to content

Commit 11fd16d

Browse files
devshgraphicsprogrammingdevshgraphicsprogramming
authored
Create Readme.md for examples
Draft Example Table
1 parent 2f75a8d commit 11fd16d

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

‎examples_tests/Readme.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Examples and Tests
2+
3+
The Nabla Examples are documentation-by-example and building blocks for our future Continuous Integration GPU Integration Tests.
4+
5+
## Where can I find the makefiles or IDE projects/solutions?
6+
7+
Given an example in folder `XY.ExampleName`, CMake will generate either a target or a separate makefile/project/solution called `examplename` (no number, always lowercase).
8+
9+
Whenever CMake generates separate makefiles/solutions/projects, they will be generated in the `./examples_tests` under the build directory you supplied to CMake.
10+
11+
**Samples are meant to be built into the `./bin` directory in the source (its git-ignored) and invoked with that Current Working Directory.**
12+
13+
**WARNING:** If you're using an IDE different than Visual Studio you need to set the CWD correctly for when you start the example for Debugging!
14+
15+
**WARNING:** Only generation of IDE projects by standalone CMake is supported, we do not use or rely on IDE integrations of CMake.
16+
17+
## Maintenance Matrix
18+
19+
In the future we expect this matrix to be kept up to date, live by our CI.
20+
21+
Y = Already Works
22+
B = Has a known bug
23+
W = Work-In-Progress, sample logic not complete or temporarily modifed
24+
S = Intended to be Supported (requires some work to port after an API change)
25+
N = No support
26+
| | Win32 OpenGL | Win32 OpenGL ES* | Win32 Vulkan | X11** OpenGL | X11** OpenGL ES | X11** Vulkan | Android OpenGL ES | Android Vulkan | Required NBL_* CMake Options |
27+
|---------------------------------|--------------|------------------|--------------|--------------|-----------------|--------------|-------------------|----------------|------------------------------|
28+
| 01.HelloWorld | Y | Y | Y | S | S | S | Y | S | None |
29+
| 02.ComputeShader | B | B | Y | S | S | S | Y | S | None |
30+
| 03.GPU_Mesh | | | | | | | | | |
31+
| 04.Keyframe | | | | | | | | | |
32+
| 05.NablaTutorialExample | | | | | | | | | |
33+
| 06.MeshLoaders | | | | | | | | | |
34+
| 07.SubpassBaking | | | | | | | | | |
35+
| FREE_SLOT | | | | | | | | | |
36+
| 09.ColorSpaceTest | | | | | | | | | |
37+
| 10.AllocatorTest | | | | | | | | | |
38+
| 11.LoDSystem | | | | | | | | | |
39+
| 12.glTF | | | | | | | | | |
40+
| FREE_SLOT | | | | | | | | | |
41+
| 14.ComputeScan | | | | | | | | | |
42+
| FREE_SLOT | | | | | | | | | |
43+
| 16.OrderIndependentTransparency | | | | | | | | | |
44+
| 17.SimpleBulletIntegration | | | | | | | | | |
45+
| 18.MitsubaLoader | | | | | | | | | |
46+
| | | | | | | | | | |
47+
| | | | | | | | | | |
48+
| | | | | | | | | | |
49+
| | | | | | | | | | |
50+
| | | | | | | | | | |
51+
| | | | | | | | | | |
52+
| | | | | | | | | | |
53+
| | | | | | | | | | |
54+
| | | | | | | | | | |
55+
| | | | | | | | | | |
56+
| 58.MediaUnpackingOnAndroid | N | N | N | N | N | N | Y | Y | None |
57+
58+
* Only Nvidia provides a working GLES 3.1 driver with OES_texture_view on Windows, so we only test there.

0 commit comments

Comments
 (0)