Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 25 additions & 25 deletions docs/SWITCHES.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ NVIDIA DLAA before the game's bloom and tone map (HeyListen, after Longshot a762

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:322` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:333` and 1 more place.

#### `RX_VK_FORCE_UPSCALE_STUB` - developer

Expand Down Expand Up @@ -369,7 +369,7 @@ No frame generation whatever the menu says; over the options file: its multiplie

**When a player would use it:** The upscaler causes artifacts: `=0` to `2` choose the filter for one run.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2511`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2588`.

### Frame generation

Expand Down Expand Up @@ -451,7 +451,7 @@ No frame generation whatever the menu says; over the options file: its multiplie

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2504`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2581`.

#### `RX_VK_FRAMEGEN_RADIUS` - developer

Expand Down Expand Up @@ -507,13 +507,13 @@ Over the options file: the output resolution (0 2048x1152, 1 2560x1440, 2 3840x2

#### `HOS_DPI_UNAWARE` - player

undocumented: host/display.c:111 (in `dpi_aware_thread()`) reads it as an on/off switch: `if (getenv("HOS_DPI_UNAWARE")) return;`. No comment in the source says what it changes.
undocumented: host/display.c:179 (in `dpi_aware_thread()`) reads it as an on/off switch: `if (getenv("HOS_DPI_UNAWARE")) return;`. No comment in the source says what it changes.

**Values:** on or off (0, false, off, no and empty are off). **Default:** off (unset).

**When a player would use it:** Windows scaling makes the picture or the mouse wrong: the process ignores DPI scaling.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:111` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:179` and 1 more place.

#### `HOS_FIX_RES` - developer

Expand Down Expand Up @@ -543,7 +543,7 @@ Starts in fullscreen; the Insert menu's Fullscreen row is then left alone.

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2606` and 2 more places.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2694` and 2 more places.

#### `HOS_HUD_FULL_RATIO` - developer

Expand Down Expand Up @@ -573,7 +573,7 @@ Over the HUD's two limits: how far its sides reach on a wider picture (2.4, 12:5

**When a player would use it:** For a bug report or a measurement: set it only when a maintainer asks, and keep the log, dump or numbers it writes.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:197`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:265`.

#### `HOS_NO_SDL` - diagnostic

Expand All @@ -593,7 +593,7 @@ Over the options file: the output resolution (0 2048x1152, 1 2560x1440, 2 3840x2

**When a player would use it:** The output resolution is wrong or the game starts at a size the screen cannot show: `0` to `4` pick a resolution for one run.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2516` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2593` and 1 more place.

#### `HOS_PRESENT_NOWAIT` - diagnostic

Expand Down Expand Up @@ -643,7 +643,7 @@ The HUD's layout on a screen that is not 16:9, over the menu's HUD layout row: `

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:448` and 2 more places.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:459` and 2 more places.

#### `HOS_WINDOW_NOACTIVATE` - diagnostic

Expand All @@ -653,7 +653,7 @@ The window opens behind the others and does not take the focus (Windows).

**When a player would use it:** For a bug report or a measurement: set it only when a maintainer asks, and keep the log, dump or numbers it writes.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:341`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:412`.

#### `HOS_WINDOW_SIZE` - player

Expand All @@ -663,7 +663,7 @@ The window's size in pixels (1280x720 by default, wider for an ultrawide picture

**When a player would use it:** The window is too large or too small for the screen: `1280x720` (or another size) for one run.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:335` and 3 more places.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:406` and 3 more places.

#### `RX_ASPECT` - developer

Expand Down Expand Up @@ -703,7 +703,7 @@ The Insert menu's HDR row for one run (the ini keeps the player's choice).

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2506`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2583`.

#### `RX_VK_HDR_FIND` - developer

Expand Down Expand Up @@ -743,7 +743,7 @@ No frame generation whatever the menu says; over the options file: its multiplie

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2505`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2582`.

#### `RX_VK_PRESENT_QUEUE` - diagnostic

Expand Down Expand Up @@ -803,7 +803,7 @@ The menu's button prompts for a controller or the keys, whatever was used last (

**When a player would use it:** Screenshots need one set of button prompts: `pad` or `keys`.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2775`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2864`.

#### `SDL_VIDEODRIVER` - diagnostic

Expand All @@ -813,7 +813,7 @@ The menu's button prompts for a controller or the keys, whatever was used last (

**When a player would use it:** For a bug report or a measurement: set it only when a maintainer asks, and keep the log, dump or numbers it writes.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/posix/display_sdl.c:199`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/posix/display_sdl.c:267`.

#### `WAYLAND_DISPLAY` - diagnostic

Expand Down Expand Up @@ -2865,7 +2865,7 @@ Timed Insert menu keys: `INS`, `UP`, `DOWN`, `LEFT`, `RIGHT`, `ESC`, `ENTER`, `T

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2803`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2892`.

#### `RX_VK_METER_HOLD` - player

Expand Down Expand Up @@ -3295,7 +3295,7 @@ DLAA only (DLSS's other modes draw the scene smaller than the output), and not w

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:327` and 2 more places.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:338` and 2 more places.

#### `RX_VK_PARALLEL_AFFINITY` - developer

Expand Down Expand Up @@ -4465,7 +4465,7 @@ The map of GPU buffer writes (it drops its lowest-addressed range past 65,536, c

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/posix/display_sdl.c:199`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/posix/display_sdl.c:267`.

#### `shader_spilling_rate` - developer

Expand Down Expand Up @@ -7655,7 +7655,7 @@ S16LE F32LE (both's numbers).

**When a player would use it:** For a bug report or a measurement: set it only when a maintainer asks, and keep the log, dump or numbers it writes.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/hos_sdl.c:375`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/hos_sdl.c:424`.

## Input and controllers

Expand Down Expand Up @@ -8495,7 +8495,7 @@ The Frame rate limit for the run, over the row and Unlimited: the rate presented

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2523` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2601` and 1 more place.

#### `HOS_FPS_LOOP` - developer

Expand Down Expand Up @@ -9203,7 +9203,7 @@ Over the options file: Resolution 100% (non-zero: Auto), Game speed Per frame (1

**When a player would use it:** The dynamic resolution makes the picture soft: `=0` holds 100% for one run.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2515`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2592`.

#### `HOS_EVENT_FAST` - developer

Expand Down Expand Up @@ -9453,7 +9453,7 @@ undocumented: host/hos_thread.c:132 (in `hos_thread_boost()`) reads it as an on/

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:375` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `host/display.c:446` and 1 more place.

#### `HOS_NO_THP` - developer

Expand Down Expand Up @@ -9523,7 +9523,7 @@ To enable the debug tools, turn **Debug tools** on in the menu's Debug tab (or a

**When a player would use it:** The Debug tab's tools should show without turning them on in the menu.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2432`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2509`.

#### `HOS_OOT_PROTECT_HEARTS` - developer

Expand All @@ -9533,7 +9533,7 @@ To enable the debug tools, turn **Debug tools** on in the menu's Debug tab (or a

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2435` and 1 more place.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2512` and 1 more place.

#### `HOS_OOT_TELEPORT_EVENT` - developer

Expand Down Expand Up @@ -9623,7 +9623,7 @@ Over the options file: Resolution 100% (non-zero: Auto), Game speed Per frame (1

**When a player would use it:** Not for players: an internal experiment or A/B switch, changed only by a developer.

**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2514`.
**Set it:** In `hookshot_env.txt`, or in the environment. **Read at:** `gpu/vk/vk_menu.cpp:2591`.

#### `HOS_RESTART_OF` - developer

Expand Down
Loading