diff options
Diffstat (limited to 'docs/source/advanced')
-rw-r--r-- | docs/source/advanced/bgfx.rst | 6 | ||||
-rw-r--r-- | docs/source/advanced/glsl.rst | 14 | ||||
-rw-r--r-- | docs/source/advanced/hlsl.rst | 162 | ||||
-rw-r--r-- | docs/source/advanced/multiconfig.rst | 4 |
4 files changed, 93 insertions, 93 deletions
diff --git a/docs/source/advanced/bgfx.rst b/docs/source/advanced/bgfx.rst index 67f03937221..5508ee01d53 100644 --- a/docs/source/advanced/bgfx.rst +++ b/docs/source/advanced/bgfx.rst @@ -41,7 +41,7 @@ Configuration Settings ---------------------- | **bgfx_path** -| +| | This is where your BGFX shader files are stored. By default, this will be the BGFX folder in your MAME installation. | | **bgfx_backend** @@ -54,7 +54,7 @@ Configuration Settings | **metal** -- Metal Apple Graphics API (Requires OS X 10.11 El Capitan or newer) | | **bgfx_debug** -| +| | Enables BGFX debugging features. Most users will not need to use this. | | **bgfx_screen_chains** @@ -116,4 +116,4 @@ Start by loading MAME with the game of your choice (e.g. **mame pacman**) The tilde key (**~**) brings up the on-screen display options. Use up and down to go through the various settings, while left and right will allow you to change that setting. Results will be shown in real time as you're changing these settings. -Note that settings are individually changable on a per-screen basis.
\ No newline at end of file +Note that settings are individually changable on a per-screen basis. diff --git a/docs/source/advanced/glsl.rst b/docs/source/advanced/glsl.rst index 543538d4ef7..033403cb150 100644 --- a/docs/source/advanced/glsl.rst +++ b/docs/source/advanced/glsl.rst @@ -63,23 +63,23 @@ Configuration Settings ---------------------- | **gl_glsl** -| +| | Enables GLSL when set to 1, disabled if set to 0. Defaults to *0*. -| +| | **gl_glsl_filter** -| +| | Enables filtering to GLSL output. Reduces jagginess at the cost of blurriness. -| +| | **glsl_shader_mame0** | ... | **glsl_shader_mame9** -| +| | Specifies the shaders to run, in the order from 0 to 9. See your shader pack author for details on which to run in which order for best effect. -| +| | **glsl_shader_screen0** | ... | **glsl_shader_screen9** -| +| | Specifies screen to apply the shaders on. | diff --git a/docs/source/advanced/hlsl.rst b/docs/source/advanced/hlsl.rst index c1536dc3d8f..3fb25578e2e 100644 --- a/docs/source/advanced/hlsl.rst +++ b/docs/source/advanced/hlsl.rst @@ -65,22 +65,22 @@ Configuration Settings ---------------------- | **hlslpath** -| +| | This is where your HLSL files are stored. By default, this will be the HLSL folder in your MAME installation. -| +| | **hlsl_snap_width** | **hlsl_snap_height** -| +| | Sets the resolution that Alt+F12 HLSL screenshots are output at. -| +| | **shadow_mask_alpha** (*Shadow Mask Amount*) -| +| | This defines how strong the effect of the shadowmask is. Acceptable range is from 0 to 1, where 0 will show no shadowmask effect, 1 will be a completely opaque shadowmask, and 0.5 will be 50% transparent. -| +| | **shadow_mask_tile_mode** (*Shadow Mask Tile Mode*) -| +| | This defines whether the shadowmask should be tiled based on the screen resolution of your monitor or based on the source resolution of the emulated system. Valid values are 0 for *Screen* mode and 1 for *Source* mode. -| +| | **shadow_mask_texture** | **shadow_mask_x_count** (*Shadow Mask Pixel X Count*) | **shadow_mask_y_count** (*Shadow Mask Pixel Y Count*) @@ -88,177 +88,177 @@ Configuration Settings | **shadow_mask_vsize** (*Shadow Mask V Size*) | **shadow_mask_x_count** (*Shadow Mask U Offset*) | **shadow_mask_y_count** (*Shadow Mask V Offset*) -| +| | These settings need to be set in unison with one another. In particular, **shadow_mask_texture** sets rules for how you need to set the other options. -| +| | **shadow_mask_texture** sets the texture of the shadowmask effect. Three shadowmasks are included with MAME: *aperture-grille.png*, *shadow-mask.png*, and *slot-mask.png* -| +| | **shadow_mask_usize** and **shadow_mask_vsize** define the used size of the shadow_mask_texture in percentage, staring at the top-left corner. The means for a texture with the actual size of 24x24 pixel and an u/v size of 0.5,0.5 the top-left 12x12 pixel will be used. Keep in mind to define an u/v size that makes is possible to tile the texture without gaps or glitches. 0.5,0.5 is fine for any shadowmask texture that is included with MAME. -| +| | **shadow_mask_x_count** and **shadow_mask_y_count** define how many screen pixel should be used to display the u/v sized texture. e.g. if you use the example from above and define a x/y count of 12,12 every pixel of the texture will be displayed 1:1 on the screen, if you define a x/y count of 24,24 the texture will be displayed twice as large. -| +| | example settings for **shadow_mask.png**: -| +| | shadow_mask_texture shadow-mask.png | shadow_mask_x_count 12 | shadow_mask_y_count 6 or 12 | shadow_mask_usize 0.5 | shadow_mask_vsize 0.5 -| +| | example settings for **slot-mask.png**: -| +| | shadow_mask_texture slot-mask.png | shadow_mask_x_count 12 | shadow_mask_y_count 8 or 16 | shadow_mask_usize 0.5 | shadow_mask_vsize 0.5 -| +| | example settings for **aperture-grille**: -| +| | shadow_mask_texture aperture-grille.png | shadow_mask_x_count 12 | shadow_mask_y_count 12 or any | shadow_mask_usize 0.5 | shadow_mask_vsize 0.5 -| +| | **shadow_mask_uoffset** and **shadow_mask_voffset** can be used to tweak the alignment of the final shadowmask in subpixel range. Range is from -1.00 to 1.00, where 0.5 moves the shadowmask by 50 percent of the u/v sized texture. -| +| | **distortion** (*Quadric Distortion Amount*) -| +| | This setting determines strength of the quadric distortion of the screen image. -| +| | **cubic_distortion** (*Cubic Distortion Amount*) -| +| | This setting determines strength of the qubic distortion of the screen image. -| +| | Both distortion factors can be negative to compensate each other. e.g. distortion 0.5 and cubic_distortion -0.5 -| +| | **distort_corner** (*Distorted Corner Amount*) -| +| | This setting determines strength of distortion of the screen corners, which does not affect the distortion of screen image itself. -| +| | **round_corner** (*Rounded Corner Amount*) -| +| | The corners of the display can be rounded off through the use of this setting. -| +| | **smooth_border** (*Smooth Border Amount*) -| +| | Sets a smoothened/blurred border around the edges of the screen. -| +| | **reflection** (*Reflection Amount*) -| +| | If set above 0, this creates a white reflective blotch on the display. By default, this is put in the upper right corner of the display. By editing the POST.FX file's GetSpotAddend section, you can change the location. Range is from 0.00 to 1.00. -| +| | **vignetting** (*Vignetting Amount*) -| +| | When set above 0, will increasingly darken the outer edges of the display in a pseudo-3D effect. Range is from 0.00 to 1.00. -| +| | **scanline_alpha** (*Scanline Amount*) -| +| | This defines how strong the effect of the scanlines are. Acceptable range is from 0 to 1, where 0 will show no scanline effect, 1 will be a completely black line, and 0.5 will be 50% transparent. Note that arcade monitors did not have completely black scanlines. -| +| | **scanline_size** (*Overall Scanline Scale*) -| +| | The overall spacing of the scanlines is set with this option. Setting it at 1 represents consistent alternating spacing between display lines and scanlines. | | **scanline_height** (*Individual Scanline Scale*) -| +| | This determines the overall size of each scanline. Setting lower than 1 makes them thinner, larger than 1 makes them thicker. -| +| | **scanline_variation** (*Scanline Variation*) -| +| | This affects the size of each scanline depending on its brightness. Brighter scanlines will be thicker than darker scanline. Acceptable range is from 0 to 2.0, with the default being 1.0. At 0.0 all scanlines will have the same size independent of their brightness. -| +| | **scanline_bright_scale** (*Scanline Brightness Scale*) -| +| | Specifies how bright the scanlines are. Larger than 1 will make them brighter, lower will make them dimmer. Setting to 0 will make scanlines disappear entirely. -| +| | **scanline_bright_offset** (*Scanline Brightness Offset*) -| +| | This will give scanlines a glow/overdrive effect, softening and smoothing the top and bottom of each scanline. -| +| | **scanline_jitter** (*Scanline Jitter Amount*) -| +| | Specifies the wobble or jitter of the scanlines, causing them to jitter on the monitor. Warning: Higher settings may hurt your eyes. -| +| | **hum_bar_alpha** (*Hum Bar Amount*) -| +| | Defines the strength of the hum bar effect. -| +| | **defocus** (*Defocus*) -| +| | This option will defocus the display, blurring individual pixels like an extremely badly maintained monitor. Specify as X,Y values (e.g. **defocus 1,1**) -| +| | **converge_x** (*Linear Convergence X, RGB*) | **converge_y** (*Linear Convergence Y, RGB*) | **radial_converge_x** (*Radial Convergence X, RGB*) | **radial_converge_y** (*Radial Convergence Y, RGB*) -| +| | Adjust the convergence of the red, green, and blue channels in a given direction. Many badly maintained monitors with bad convergence would bleed colored ghosting off-center of a sprite, and this simulates that. -| +| | **red_ratio** (*Red Output from RGB*) | **grn_ratio** (*Green Output from RGB*) | **blu_ratio** (*Blue Output from RGB*) -| +| | Defines a 3x3 matrix that is multiplied with the RGB signals to simulate color channel interference. For instance, a green channel of (0.100, 1.000, 0.250) is weakened 10% by the red channel and strengthened 25% through the blue channel. -| +| | **offset** (*Signal Offset*) -| +| | Strengthen or weakens the current color value of a given channel. For instance, a red signal of 0.5 with an offset of 0.2 will be raised to 0.7 -| +| | **scale** (*Signal Scale*) -| +| | Applies scaling to the current color value of the channel. For instance, a red signal of 0.5 with a scale of 1.1 will result in a red signal of 0.55 -| +| | **power** (*Signal Exponent, RGB*) -| +| | Exponentiate the current color value of the channel, also called gamma. For instance, a red signal of 0.5 with red power of 2 will result in a red signal of 0.25 -| +| | This setting also can be used to adjust line thickness in vector games. -| +| | **floor** (*Signal Floor, RGB*) -| +| | Sets the absolute minimum color value of a channel. For instance, a red signal of 0.0 (total absence of red) with a red floor of 0.2 will result in a red signal of 0.2 -| +| | Typically used in conjunction with artwork turned on to make the screen have a dim raster glow. -| +| | **phosphor_life** (*Phosphor Persistence, RGB*) -| +| | How long the color channel stays on the screen, also called phosphor ghosting. 0 gives absolutely no ghost effect, and 1 will leave a contrail behind that is only overwritten by a higher color value. -| +| | This also affects vector games quite a bit. -| +| | **saturation** (*Color Saturation*) -| +| | Color saturation can be adjusted here. -| +| | **bloom_blend_mode** (*Bloom Blend Mode*) -| +| | Determines the mode of the bloom effect. Valid values are 0 for *Brighten* mode and 1 for *Darken* mode, last is only useful for systems with STN LCD. -| +| | **bloom_scale** (*Bloom Scale*) -| +| | Determines the intensity of bloom effect. Arcade CRT displays had a tendency towards bloom, where bright colors could bleed out into neighboring pixels. This effect is extremely graphics card intensive, and can be turned completely off to save GPU power by setting it to 0 -| +| | **bloom_overdrive** (*Bloom Overdrive, RGB*) -| +| | Sets a RGB color, separated by commas, that has reached the brightest possible color and will be overdriven to white. This is only useful on color raster, color LCD, or color vector games. -| +| | **bloom_lvl0_weight** (*Bloom Level 0 Scale*) | **bloom_lvl1_weight** (*Bloom Level 1 Scale*) | . . . . | **bloom_lvl7_weight** (*Bloom Level 7 Scale*) | **bloom_lvl8_weight** (*Bloom Level 8 Scale*) -| +| | These define the bloom effect. Range is from 0.00 to 1.00. If used carefully in conjunction with phosphor_life, glowing/ghosting for moving objects can be achieved. | | **hlsl_write** -| +| | Enables writing of an uncompressed AVI video with the HLSL effects included with set to *1*. This uses a massive amount of disk space very quickly, so a large HD with fast write speeds is highly recommended. Default is *0*, which is off. | | Suggested defaults for raster-based games: -| +| +-------------------------------+-------------------------+------------------------------------+ | | bloom_lvl0_weight 1.00 | | Bloom level 0 weight | | Full-size target. | @@ -301,7 +301,7 @@ In the Vector Post-Processing Options section: Suggested settings for vector games: * **bloom_scale** should typically be set higher for vector games than raster games. Try between 0.4 and 1.0 for best effect. -* **bloom_overdrive** should only be used with color vector games. +* **bloom_overdrive** should only be used with color vector games. * **bloom_lvl_weights** should be set as follows: diff --git a/docs/source/advanced/multiconfig.rst b/docs/source/advanced/multiconfig.rst index 707d980d1fc..3424f1fb4ee 100644 --- a/docs/source/advanced/multiconfig.rst +++ b/docs/source/advanced/multiconfig.rst @@ -12,7 +12,7 @@ Order of Config Loading 2. **MAME.INI** (or other platform INI; e.g. **MESS.INI**) is parsed twice. The first pass may change various path settings, so the second pass is done to see if there is a valid config file at that new location (and if so, change settings using that file) 3. **DEBUG.INI** if in debug mode. - This is an advanced config file, most people won't need to use it or be concerned by it. + This is an advanced config file, most people won't need to use it or be concerned by it. 4. System-specific INI files where appropriate (e.g. **NEOGEO_NOSLOT.INI** or **CPS2.INI**) As an example, Street Fighter Alpha is a CPS2 game, and so **CPS2.INI** would be loaded here. 5. Monitor orientation INI file (either **HORIZONT.INI** or **VERTICAL.INI**) @@ -21,7 +21,7 @@ Order of Config Loading Both Pac-Man and Street Fighter Alpha are arcade games, so **ARCADE.INI** would be loaded here. Atari 2600 would load **CONSOLE.INI**. 7. Screen-type INI file (**VECTOR.INI** for vector games, **RASTER.INI** for raster games, **LCD.INI** for LCD games) Pac-Man and Street Fighter Alpha are raster, so **RASTER.INI** gets loaded here. Tempest is a vector monitor game, and **VECTOR.INI** would be loaded here. -8. Source INI files. +8. Source INI files. This is an advanced config file, most people won't need to use it and it can be safely ignored. MAME will attempt to load **SOURCE/SOURCEFILE.INI** and **SOURCEFILE.INI**, where sourcefile is the actual filename of the source code file. *mame -listsource <game>* will show the source file for a given game. |