nxdk_pgraph_tests/README.md

nxdk_pgraph_tests

Various tests for nv2a rendering.

Based on code from https://github.com/Ernegien/nxdk/tree/test/texture-formats/samples/texture-formats

Golden test results from XBOX hardware are available here

Usage

Tests will be executed automatically if no gamepad input is given within an initial timeout.

Individual tests may be executed via the menu.

Test configuration

Tests can optionally be determined via a configuration file loaded from the XBOX. The file follows a simple line-based format.

• A test suite and all of the tests within will be enabled if the suite name appears on a single line.
• A single test within an enabled suite may be disabled by prefixing its name with a - after the line containing the test suite containing it.
• Any line starting with # will be ignored.

The names used are the same as the names that appear in the nxdk_praph_tests menu.

If the entire file is empty (or commented out), it will be ignored and all tests will be enabled.

For example:

ThisTestSuiteIsEnabled
-ExceptThisTest

# This is ignored.

Controls

DPAD:

• Up - Move the menu cursor up. Inside of a test, go to the previous test in the active suite.
• Down - Move the menu cursor down. Inside of a test, go to the previous test in the active suite.
• Left - Move the menu cursor up by half a page.
• Right - Move the menu cursor down by half a page.
• A - Enter a submenu or test. Inside of a test, re-run the test.
• B - Go up one menu or leave a test. If pressed on the root menu, exit the application.
• X - Run all tests for the current suite.
• Y - Toggle saving of results and multi-frame rendering.
• Start - Enter a submenu or test.
• Back - Go up one menu or leave a test. If pressed on the root menu, exit the application.
• Black - Exit the application.

Build prerequisites

This test suite requires some modifications to the pbkit used by the nxdk in order to operate.

To facilitate this, the nxdk is included as a submodule of this project, referencing the pbkit_extensions branch from https://github.com/abaire/nxdk.

This project should be cloned with the --recursive flag to pull the submodules and their submodules, after the fact this can be achieved via git submodule update --init --recursive.

For macOS, the patched nxdk currently assumes that the Homebrew llvm@11 package has been installed.

Adding new tests

Using nv2a log events from xemu

1. Enable tracing of nv2a log events as normal (see xemu documentation) and exercise the event of interest within the game.
2. Duplicate an existing test as a skeleton.
3. Add the duplicated test to the Makefile and main.cpp (please preserve alphabetical ordering if possible).
4. Use nv2a_to_pbkit to get a rough set of pbkit invocations duplicating the behavior from the log. Take the interesting portions of the converted output and put them into the body of the test. You may wish to utilize some of the helper methods from TestHost and similar classes rather than using the raw output to improve readability.

Running with CLion

Create a build target

1. Create a new Embedded GDB Server target
2. Set the Target to all
3. Set the Executable to main.exe
4. Set Download executable to None
5. Set 'target remote' args to 127.0.0.1:1234
6. Set GDB Server to the path to the xemu binary
7. Set GDB Server args to -s -S (the -S is optional and will cause xemu to wait for the debugger to connnect)

To capture DbgPrint, additionally append -device lpc47m157 -serial tcp:127.0.0.1:9091 to GDB Server args and use something like pykdclient.

Deploying with xbdm_gdb_bridge

The Makefile contains a deploy target that will copy the finished binary to an XBOX running XBDM. This functionality requires the xbdm_gdb_bridge utility.