Skip to content

Commit

Permalink
Documentation Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
EliteCombineSoldier authored and Basil committed Feb 2, 2025
1 parent 6801315 commit ba01183
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
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
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
1 change: 1 addition & 0 deletions src/dxvk/imgui/dxvk_imgui_about.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ namespace dxvk {
"James 'jdswebb' Webb",
"David 'King David' Wiltos",
"Dayton 'watbulb'",
"Basil 'EliteCombineSoldier'",
}},
{ "Engineering",
{ "Riley Alston",
Expand Down

0 comments on commit ba01183

Please sign in to comment.