Sprinter/mame
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation update for vector options.

Browse Source
This commit is contained in:
Aaron Giles 2020-08-05 16:41:08 -07:00
parent db6f784a0e
commit 01d5d49518
1 changed files with 84 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
docs/source/commandline/commandline-all.rst
View File

@ -237,9 +237,9 @@ overwritten.
</mame> </mame>
.. Tip:: Output from this command is typically more useful if redirected to .. Tip:: Output from this command is typically more useful if redirected to
an output file. For instance, doing an output file. For instance, doing
**mame64 -listxml galaxian > galax.xml** will make ``galax.xml`` or **mame64 -listxml galaxian > galax.xml** will make ``galax.xml`` or
overwrite any existing data in the file with the results of overwrite any existing data in the file with the results of
**-listxml**; this will allow you to view it in a text editor or parse **-listxml**; this will allow you to view it in a text editor or parse
it with external tools. it with external tools.
@ -607,7 +607,7 @@ overwritten.
**-getsoftlist** / **-glist** [<*pattern*>] **-getsoftlist** / **-glist** [<*pattern*>]
Displays the contents of a specific softlist with the filename represented Displays the contents of a specific softlist with the filename represented
by *pattern*. by *pattern*.
Example: Example:
@ -698,21 +698,21 @@ OSD-related Options
- dwrite - dwrite
- none - none
- auto - auto
- -
- sdl [#UIFPSDLWindows]_. - sdl [#UIFPSDLWindows]_.
* - **macOS** * - **macOS**
- -
- -
- none - none
- auto - auto
- osx - osx
- sdl - sdl
* - **Linux** * - **Linux**
- -
- -
- none - none
- auto - auto
- -
- sdl - sdl
.. rubric:: Footnotes .. rubric:: Footnotes
@ -745,16 +745,16 @@ Example:
- sdl [#KBIPSDLWindows]_. - sdl [#KBIPSDLWindows]_.
* - **SDL (macOS and Linux)** * - **SDL (macOS and Linux)**
- auto [#KBIPAutoSDL]_. - auto [#KBIPAutoSDL]_.
- -
- -
- -
- none - none
- sdl - sdl
* - **Linux** * - **Linux**
- auto [#KBIPAutoSDL]_. - auto [#KBIPAutoSDL]_.
- -
- -
- -
- none - none
- sdl - sdl
@ -797,16 +797,16 @@ Example:
- sdl [#MIPSDLWindows]_. - sdl [#MIPSDLWindows]_.
* - **SDL (macOS and Linux)** * - **SDL (macOS and Linux)**
- auto [#MIPAutoSDL]_. - auto [#MIPAutoSDL]_.
- -
- -
- -
- none - none
- sdl - sdl
* - **Linux** * - **Linux**
- auto [#MIPAutoSDL]_. - auto [#MIPAutoSDL]_.
- -
- -
- -
- none - none
- sdl - sdl
@ -841,21 +841,21 @@ Example:
- rawinput - rawinput
- win32 - win32
- none - none
- -
- -
* - **macOS** * - **macOS**
- auto [#LGIPAutoSDL]_. - auto [#LGIPAutoSDL]_.
- -
- -
- none - none
- -
- -
* - **Linux** * - **Linux**
- auto [#LGIPAutoLinux]_. - auto [#LGIPAutoLinux]_.
- -
- -
- none - none
- -
- x11 - x11
.. rubric:: Footnotes .. rubric:: Footnotes
@ -892,9 +892,9 @@ Example:
- sdl - sdl
* - **SDL** * - **SDL**
- auto [#JIPAutoSDL]_. - auto [#JIPAutoSDL]_.
- -
- -
- -
- none - none
- sdl - sdl
@ -1878,7 +1878,7 @@ Core Performance Options
latency. This is particularly effective with VRR (Variable Refresh Rate) latency. This is particularly effective with VRR (Variable Refresh Rate)
displays. displays.
This may cause frame pacing issues in the form of jitter with some This may cause frame pacing issues in the form of jitter with some
systems (especially newer 3D-based systems or systems that run software systems (especially newer 3D-based systems or systems that run software
akin to an operating system), so the default is off (**-nolowlatency**). akin to an operating system), so the default is off (**-nolowlatency**).
@ -1959,7 +1959,7 @@ Core Rotation Options
mame64 pacman -autorol mame64 pacman -autorol
.. Tip:: If you have a display that can be rotated, **-autorol** or .. Tip:: If you have a display that can be rotated, **-autorol** or
**-autoror** will allow you to get a larger display for both horizontal **-autoror** will allow you to get a larger display for both horizontal
and vertical systems. and vertical systems.
@ -2039,9 +2039,9 @@ Core Video Options
**-numscreens** *<count>* **-numscreens** *<count>*
Tells MAME how many output windows or screens to create. For most systems, Tells MAME how many output windows or screens to create. For most systems,
a single output window is all you need, but some systems originally used a single output window is all you need, but some systems originally used
multiple screens (*e.g. Darius and PlayChoice-10 arcade machines*). Some multiple screens (*e.g. Darius and PlayChoice-10 arcade machines*). Some
systems with front panel controls and/or status lights also may let you put systems with front panel controls and/or status lights also may let you put
these in different windows/screens. Each screen (up to 4) has its own these in different windows/screens. Each screen (up to 4) has its own
independent settings for physical monitor, aspect ratio, resolution, and independent settings for physical monitor, aspect ratio, resolution, and
@ -2520,7 +2520,7 @@ Core Screen Options
ramp, for the system screens. This option does not affect the artwork or ramp, for the system screens. This option does not affect the artwork or
other parts of the display. Using the MAME UI, you can individually set other parts of the display. Using the MAME UI, you can individually set
the gamma for each system screen; this option controls the initial value for the gamma for each system screen; this option controls the initial value for
all visible system screens. The standard and default value is ``1.0``, all visible system screens. The standard and default value is ``1.0``,
which gives a linear ramp from black to white. Selecting lower values which gives a linear ramp from black to white. Selecting lower values
(down to 0.1) will increase the nonlinearity toward black, while (down to 0.1) will increase the nonlinearity toward black, while
selecting higher values (up to 3.0) will push the nonlinearity toward white. selecting higher values (up to 3.0) will push the nonlinearity toward white.
@ -2576,7 +2576,10 @@ Core Vector Options
**-beam_width_min** *<width>* **-beam_width_min** *<width>*
Sets the vector beam minimum width. Sets the vector beam minimum width. The beam width varies between
the minimum and maximum beam widths as the intensity of the vector
drawn changes. To disable vector width changes based on intensity,
set the maximum equal to the minimum.
Example: Example:
.. code-block:: bash .. code-block:: bash
@ -2587,7 +2590,10 @@ Core Vector Options
**-beam_width_max** *<width>* **-beam_width_max** *<width>*
Sets the vector beam maximum width. Sets the vector beam maximum width. The beam width varies between
the minimum and maximum beam widths as the intensity of the vector
drawn changes. To disable vector width changes based on intensity,
set the maximum equal to the minimum.
Example: Example:
.. code-block:: bash .. code-block:: bash
@ -2598,13 +2604,35 @@ Core Vector Options
**-beam_intensity_weight** *<weight>* **-beam_intensity_weight** *<weight>*
Sets the vector beam intensity weight. Sets the vector beam intensity weight. This value determines how the
intensity of the vector drawn affects the width. A value of 0 creates
a linear mapping from intensity to width. Negative values mean that
lower intensities will increase the width toward maximum faster,
while positive values will increase the width toward maximum more
slowly.
Example: Example:
.. code-block:: bash .. code-block:: bash
mame64 asteroid -beam_intensity_weight 0.5 mame64 asteroid -beam_intensity_weight 0.5
.. _mame-commandline-beamdotsize:
**-beam_dot_size** *<scale>*
Scale factor to apply to the size of single-point dots in vector games.
Normally these are rendered according to the computed beam width; however,
it is common for this to produce dots that are difficult to see. The
beam_dot_size option applies a scale factor on top of the beam width to
help them show up better.
The default is ``1``.
Example:
.. code-block:: bash
mame64 asteroid -beam_dot_size 2
.. _mame-commandline-flicker: .. _mame-commandline-flicker:
**-flicker** *<value>* **-flicker** *<value>*
@ -2828,21 +2856,21 @@ Core Sound Options
- dsound - dsound
- xaudio2 - xaudio2
- portaudio - portaudio
- -
- sdl [#SoundWinSDL]_. - sdl [#SoundWinSDL]_.
- none - none
* - **macOS** * - **macOS**
- -
- -
- portaudio - portaudio
- coreaudio - coreaudio
- sdl - sdl
- none - none
* - **Linux** and others * - **Linux** and others
- -
- -
- portaudio - portaudio
- -
- sdl - sdl
- none - none
@ -2860,7 +2888,7 @@ Core Sound Options
Higher values increase audio delay but may help avoid buffer under-runs and Higher values increase audio delay but may help avoid buffer under-runs and
audio interruptions. audio interruptions.
The default is ``1``. The default is ``1``.
| For PortAudio, see :ref:`mame-commandline-pa-latency`. | For PortAudio, see :ref:`mame-commandline-pa-latency`.
| XAudio2 calculates audio_latency as 10ms steps. | XAudio2 calculates audio_latency as 10ms steps.
@ -3045,8 +3073,8 @@ Core Input Options
**-joystick_map** *<map>* / **-joymap** *<map>* **-joystick_map** *<map>* / **-joymap** *<map>*
Controls how analog joystick values map to digital joystick controls. Controls how analog joystick values map to digital joystick controls.
Systems such as Pac-Man use a 4-way digital joystick and will exhibit Systems such as Pac-Man use a 4-way digital joystick and will exhibit
undesired behavior when a diagonal is triggered; in the case of Pac-Man, undesired behavior when a diagonal is triggered; in the case of Pac-Man,
movement will stop completely at intersections when diagonals are triggered movement will stop completely at intersections when diagonals are triggered
@ -3055,12 +3083,12 @@ Core Input Options
joysticks), so for true analog joysticks such as flight sticks and analog joysticks), so for true analog joysticks such as flight sticks and analog
thumb sticks, this then needs to be mapped down to the expected thumb sticks, this then needs to be mapped down to the expected
4-way or 8-way digital joystick values. 4-way or 8-way digital joystick values.
To do this, MAME divides the analog range into a 9x9 grid that looks To do this, MAME divides the analog range into a 9x9 grid that looks
like this: like this:
**insert 9x9 grid picture here** **insert 9x9 grid picture here**
MAME then takes the joystick axis position (for X and Y axes only), maps it MAME then takes the joystick axis position (for X and Y axes only), maps it
to this grid, and then looks up a translation from a joystick map. This to this grid, and then looks up a translation from a joystick map. This
parameter allows you to specify the map. parameter allows you to specify the map.
@ -3081,7 +3109,7 @@ Core Input Options
Generally you will want to set up the **-joystick_map** setting in the Generally you will want to set up the **-joystick_map** setting in the
per-system ``<system>.ini`` file as opposed to the main ``MAME.INI`` per-system ``<system>.ini`` file as opposed to the main ``MAME.INI``
file so that the mapping only affects the systems you want it to. See file so that the mapping only affects the systems you want it to. See
:ref:`Multiple Configuration Files <advanced-multi-CFG>` for further :ref:`Multiple Configuration Files <advanced-multi-CFG>` for further
details on per-system configuration. details on per-system configuration.
@ -3174,7 +3202,7 @@ Core Input Options
+------------------------------+ +------------------------------+
| **-joymap s8.4s8.44s8.4445** | | **-joymap s8.4s8.44s8.4445** |
+------------------------------+ +------------------------------+
.. _mame-commandline-joystickdeadzone: .. _mame-commandline-joystickdeadzone: