Commit 08e1f93f authored by Screwtape's avatar Screwtape

Update the rest of the settings docs to match the new Video settings.

parent 6caad914
......@@ -119,37 +119,46 @@ This tab contains options that affect
how higan reproduces
the emulated console's audio output.
- **Device**: allows you to choose
**Driver**
settings affect the
[the Audio driver](../guides/drivers.md).
- **Device** allows you to choose
which audio device higan sends
the emulated game's audio to.
- **Frequency**: controls the sample-rate that higan will use
- **Frequency** controls the sample-rate that higan will use
when generating audio.
If your PC's audio hardware has a "native" sample-rate
and you know what it is,
pick that.
Otherwise,
44.1kHz or 48kHz should be fine.
- **Latency**: controls how much audio output higan calculates in advance.
- **Latency** controls how much audio output higan calculates in advance.
Higher values reduce the chance of
"popping" or "glitching" noises,
but increase the delay between an action occurring on-screen
and the corresponding sound-effect being played.
- **Exclusive Mode**: appears
- **Exclusive Mode** appears
if the current audio driver
allows higan to take exclusive control of your PC's audio output,
so no other applications can play sounds.
This can improve audio quality,
and lower the effective audio latency.
- **Volume**: controls the overall loudness of
**Effects**
are applied to the emulated audio output
before it is sent to your computer's speakers.
- **Volume** controls the overall loudness of
the emulated console's audio,
where 100% is normal volume,
and 0% is complete silence.
- **Balance**: controls the relative loudness of
- **Balance** controls the relative loudness of
the left and right speakers,
where 0% means only the left speaker produces sound,
50% means both speakers produce sound equally,
and 100% means only the right speaker produces sound.
- **Reverb**: adds a slight reverberation effect
- **Reverb** adds a slight reverberation effect
to the emulated console's audio output,
as though the console were in a tunnel or small room.
......@@ -161,10 +170,12 @@ are used for which emulated controllers.
The exact PC inputs that can be mapped
depend on [the input driver](#drivers).
- **Pause Emulation**: automatically pauses emulation
General input settings:
- **Pause Emulation** automatically pauses emulation
when the main higan window
is not the current foreground window.
- **Allow Input**: can be ticked
- **Allow Input** can be ticked
when "Pause Emulation" is *not* ticked,
and allows configured inputs to keep affecting higan
even when higan is running in the background.
......@@ -176,6 +187,9 @@ depend on [the input driver](#drivers).
typing in that other application may affect
the emulated game running in higan
even though you can't see it!
Choosing which of the possible controllers to configure:
- The console selector chooses which console's inputs
to display in the mapping list below.
- The port selector chooses which port of the selected console
......@@ -183,13 +197,21 @@ depend on [the input driver](#drivers).
- The controller selector chooses which controller
associated with the given console and port
to display in the mapping list below.
Note that some consoles only allow particular controllers
to be used in a particular port.
For example,
the Super Scope controller for the Super Famicom
only works in Controller Port 2.
Configuring the selected controller:
- The mapping list includes
every button and axis on the selected controller,
and the PC inputs that are mapped to it
when it is connected to the selected port of the selected console.
- **Erase**: removes the mapping
- **Erase** removes the mapping
for the selected button or axis.
- **Reset**: removes all the mappings currently in the list.
- **Reset** removes all the mappings currently in the list.
- TODO: Mention that controllers must be connected
in the console menu
before they can be used.
......@@ -242,7 +264,9 @@ to exit the "Press a key or button to map..." mode
without actually mapping anything.
The "Rumble" setting
for the Game Boy Advance is treated like a button,
for the Game Boy
and Game Boy Advance
is treated like a button,
and can be mapped to a PC gamepad.
When the emulated Game Boy Advance
tries to use the rumble feature
......@@ -250,7 +274,6 @@ of the Game Boy Player,
higan will turn on the force-feedback
of whatever gamepad the mapped button is part of.
Hotkeys
=======
......@@ -258,36 +281,36 @@ This tab is like "Inputs" above,
except it contains controls for higan itself,
instead of for the emulated console.
- **Toggle Fullscreen**: puts higan into fullscreen mode,
- **Toggle Fullscreen** puts higan into fullscreen mode,
where the menu and status bar are hidden,
and the emulated console's video output
is enlarged to cover the entire screen.
Toggling fullscreen also automatically captures the mouse.
- **Toggle Mouse Capture**: hides the usual mouse-cursor,
- **Toggle Mouse Capture** hides the usual mouse-cursor,
and captures the mouse so it cannot leave the higan window.
This is useful when the mouse is being used to emulate
a light-gun controller like the Super Scope.
- **Save Quick State**: saves the current state of the emulated console
- **Save Quick State** saves the current state of the emulated console
to the currently-selected Quick State slot.
- **Load Quick State**: restores the emulated console
- **Load Quick State** restores the emulated console
to the state saved in the currently-selected Quick State slot.
- **Decrement Quick State**: selects the previous Quick State slot.
- **Decrement Quick State** selects the previous Quick State slot.
The status bar will briefly display the new current slot number.
- **Increment Quick State**: selects the next Quick State slot.
- **Increment Quick State** selects the next Quick State slot.
The status bar will briefly display the new current slot number.
- **Pause Emulation**: pauses the emulated console
- **Pause Emulation** pauses the emulated console
until the Pause Emulation hotkey is pressed a second time.
- **Fast Forward**: disables audio and video synchronisation
- **Fast Forward** disables audio and video synchronisation
for as long as it's held down,
so emulation proceeds as quickly as possible.
If your PC struggles to hit "real time"
(60fps for most emulated consoles),
this likely won't have any effect.
- **Power Cycle**: turns the emulated console off and back on,
- **Power Cycle** turns the emulated console off and back on,
(a "hard reset"),
just like the "Power Cycle" menu item
in [the console menu](#the-console-menu).
- **Rotate Display**: will toggle the display
- **Rotate Display** will toggle the display
of the Game Boy Advance
and WonderSwan (Color)
between the usual landscape orientation
......@@ -302,31 +325,39 @@ Advanced
This tab contains all the settings
that didn't fit into one of the other categories.
- **Video**: controls how higan will draw
**Driver Selection**
tells higan how to
accept input,
display video,
and play sound
on this computer.
- **Video** controls how higan will draw
the emulated console's video output
to the PC screen.
"None" means no video will be drawn.
See [Drivers](#drivers) for details.
- **Audio**: controls how higan will present
- **Audio** controls how higan will present
the emulated console's audio output.
"None" means no audio will be played.
See [Drivers](#drivers) for details.
- **Input**: controls how higan checks for input
- **Input** controls how higan checks for input
from the PC's input devices.
"None" means the emulated console cannot be controlled.
See [Drivers](#drivers) for details.
- **Location**: selects where the [Game Library](#the-game-library)
See [Choosing drivers](../guides/drivers.md)
for help choosing which drivers you should use.
**Game Library**
configures how higan interacts
with the [Game Library](../concepts/game-library.md).
- **Location** selects where the Game Library
looks for games to load.
See [Moving the Game Library](#moving-the-game-library)
See [Moving the Game Library](../concepts/game-library.md#moving-the-game-library)
for more information.
- **Ignore Manifests**: makes higan ignore the manifest file
in the a loaded game's [game folder](#why-game-folders)
- **Ignore Manifests** makes higan ignore the manifest file
in the a loaded game's
[game folder](../concepts/game-folders.md)
in favour of asking icarus
to guess a manifest on the fly.
This means that incompatible or incorrect manifests
generated by old versions of icarus
won't cause problems,
but means you can't fix incorrect manifests
generated by the current version of icarus.
See also the "Create Manifests" option in
[the icarus Settings dialog](#the-icarus-settings-dialog).
See [What is a manifest?](../concepts/game-folders#what-is-a-manifest)
for details.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment