Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes #85

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Documentation fixes #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97f2401
Fix small oversight in README.md
EliteCombineSoldier Dec 18, 2024
5c9bf90
Fix example files path
EliteCombineSoldier Dec 18, 2024
266b922
Oops missed one
EliteCombineSoldier Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,15 @@ To profile:
### Remix API

If there's an intent to use the Remix Renderer in projects with *available* source code, Direct3D 9 API can be utilized, since Remix's `d3d9.dll` implements the Direct3D 9 API.
Alternatively, Remix API can be used to programmatically pass the game data to the Remix Renderer, with *or* instead of Direct3D API. [Click for more info.](/tests/rtx/apps/README.md)
Alternatively, Remix API can be used to programmatically pass the game data to the Remix Renderer, with *or* instead of Direct3D API. [Click for more info.](/documentation/RemixSDK.md)

## Project Documentation

- [Anti-Culling System](/documentation/AntiCullingSystem.md)
- [Foliage System](/documentation/FoliageSystem.md)
- [GPU Print](/documentation/GpuPrint.md)
- [Opacity Micromap](/documentation/OpacityMicromap.md)
- [Remix API](/tests/rtx/apps/README.md)
- [Remix API](/documentation/RemixSDK.md)
- [Rtx Options](/RtxOptions.md)
- [Terrain System](/documentation/TerrainSystem.md)
- [Unit Test](/documentation/UnitTest.md)
6 changes: 3 additions & 3 deletions documentation/RemixSDK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ After a successful build, the necessary SDK files will be located in the public/
As with other rendering engines, there are common steps of
initialiazation, resource registration (meshes, materials, lights), and submitting the said resources to each frame to be rendered.

[remixapi_example_c.c](RemixAPI_C/remixapi_example_c.c) contains a minimal example in C to render a path traced triangle using the Remix API.
[remixapi_example_c.c](/tests/rtx/apps/RemixAPI_C/remixapi_example_c.c) contains a minimal example in C to render a path traced triangle using the Remix API.


<details>
Expand Down Expand Up @@ -112,7 +112,7 @@ Material:
* To register, call `remixapi_Interface::CreateMaterial` specifying `remixapi_MaterialInfo`, but `.pNext` must be a pointer to one of:
* `remixapi_MaterialInfoOpaqueEXT` -- for a generic material
* `remixapi_MaterialInfoTranslucentEXT` -- for a glass material
* For the default values, corresponding default constructors can be examined in the C++ wrapper [remix.h](../../../public/include/remix/remix.h)
* For the default values, corresponding default constructors can be examined in the C++ wrapper [remix.h](/public/include/remix/remix.h)
* *Note: at the time of writing, the material API is still not refined to work with non-file image data, and overall structure just reflects the internal representation of materials, which might be not as simple to use. The primary subject to change.*

Light:
Expand Down Expand Up @@ -144,7 +144,7 @@ Push a camera, mesh instances and lights to define a scene for the *current* fra

*Note: to set `rtx.conf` options at runtime, use `remixapi_Interface::SetConfigVariable`*

*Note: [remixapi_example_c.c](RemixAPI_C/remixapi_example_c.c) contains all the steps listed above, and should draw a triangle.*
*Note: [remixapi_example_c.c](/tests/rtx/apps/RemixAPI_C/remixapi_example_c.c) contains all the steps listed above, and should draw a triangle.*



Expand Down