Difference between revisions of "Template:Config"

From Dolphin Emulator Wiki
Jump to: navigation, search
m (change vertex rounding ordering to match dolphin's ui ordering (top -> bottom, left -> right))
(5 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
{{{startfull|}}}
 
{{{startfull|}}}
 
{{{rendertomain|}}}
 
{{{rendertomain|}}}
 +
{{{shadercomp|}}}
 +
{{{compilefirst|}}}
 
{{{internalres|}}}
 
{{{internalres|}}}
 
{{{antialiasing|}}}
 
{{{antialiasing|}}}
 
{{{anisotropic|}}}
 
{{{anisotropic|}}}
{{{ubershaders|}}}
 
 
{{{efbscaledcopy|}}}
 
{{{efbscaledcopy|}}}
 
{{{pixellighting|}}}
 
{{{pixellighting|}}}
Line 24: Line 25:
 
{{{widescreenhack|}}}
 
{{{widescreenhack|}}}
 
{{{disablefog|}}}
 
{{{disablefog|}}}
 +
{{{arbmipmap|}}}
 
{{{skipcpuefbaccess|}}}
 
{{{skipcpuefbaccess|}}}
 
{{{formatchanges|}}}
 
{{{formatchanges|}}}
Line 90: Line 92:
 
{{{startfull|}}}
 
{{{startfull|}}}
 
{{{rendertomain|}}}
 
{{{rendertomain|}}}
 +
{{{shadercomp|}}}
 +
{{{compilefirst|}}}
 
{{{internalres|}}}
 
{{{internalres|}}}
 
{{{antialiasing|}}}
 
{{{antialiasing|}}}
 
{{{anisotropic|}}}
 
{{{anisotropic|}}}
{{{ubershaders|}}}
 
 
{{{efbscaledcopy|}}}
 
{{{efbscaledcopy|}}}
 
{{{pixellighting|}}}
 
{{{pixellighting|}}}
Line 99: Line 102:
 
{{{widescreenhack|}}}
 
{{{widescreenhack|}}}
 
{{{disablefog|}}}
 
{{{disablefog|}}}
 +
{{{arbmipmap|}}}
 
{{{skipcpuefbaccess|}}}
 
{{{skipcpuefbaccess|}}}
 
{{{formatchanges|}}}
 
{{{formatchanges|}}}
Line 116: Line 120:
 
!Config!!Setting!!Notes
 
!Config!!Setting!!Notes
 
{{!}}-
 
{{!}}-
{{#if:{{{gfxbackend|}}}|{{!}}[[Category:Video Back End (Config Required)]]{{Hover|Selects which graphical API interface should be used for display rendering (OpenGL, Direct3D11, Vulkan, Software)|'''Video Back End'''}}{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
+
{{#if:{{{gfxbackend|}}}|{{!}}[[Category:Video Back End (Config Required)]]{{Hover|Selects which graphical API interface should be used for display rendering (OpenGL, Direct3D11, Direct3D12, Vulkan, Software)|'''Video Back End'''}}{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
 
{{!}}-
 
{{!}}-
 
{{#if:{{{fullres|}}}|{{!}}[[Category:Fullscreen Resolution (Config Required)]]{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
 
{{#if:{{{fullres|}}}|{{!}}[[Category:Fullscreen Resolution (Config Required)]]{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
Line 127: Line 131:
 
{{!}}-
 
{{!}}-
 
{{#if:{{{rendertomain|}}}|{{!}}[[Category:Render to Main Window (Config Required)]]{{Hover|Displays games in the main window instead of a separate one (On, Off)|'''Render to Main Window'''}}{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
 
{{#if:{{{rendertomain|}}}|{{!}}[[Category:Render to Main Window (Config Required)]]{{Hover|Displays games in the main window instead of a separate one (On, Off)|'''Render to Main Window'''}}{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
 +
{{!}}-
 +
{{#if:{{{shadercomp|}}}|{{!}}[[Category:Shader Compilation (Config Required)]]{{Hover|Sets whether specialized shaders or ubershaders are used (Synchronous, Synchronous (Ubershaders), Asynchronous (Ubershaders), Asynchronous (Skip Drawing))|'''Shader Compilation'''}}{{!!}}{{{shadercomp|}}}{{!!}}{{{shadercompnotes|}}}}}
 +
{{!}}-
 +
{{#if:{{{compilefirst|}}}|{{!}}[[Category:Compile Shaders Before Starting (Config Required)]]{{Hover|Waits for all shaders to finish compiling before starting a game (On, Off)|'''Compile Shaders Before Starting'''}}{{!!}}{{{compilefirst|}}}{{!!}}{{{compilefirstnotes|}}}}}
 
{{!}}-
 
{{!}}-
 
{{#if:{{{internalres|}}}|{{!}}[[Category:Internal Resolution (Config Required)]]{{Hover|Sets the resolution the game will be rendered at behind-the-scenes (Window Size, Multiple of 640x528, 1x, 1.5x, 2x, 2.5x, 3x, 4x)|'''Internal Resolution'''}}{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
 
{{#if:{{{internalres|}}}|{{!}}[[Category:Internal Resolution (Config Required)]]{{Hover|Sets the resolution the game will be rendered at behind-the-scenes (Window Size, Multiple of 640x528, 1x, 1.5x, 2x, 2.5x, 3x, 4x)|'''Internal Resolution'''}}{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
Line 133: Line 141:
 
{{!}}-
 
{{!}}-
 
{{#if:{{{anisotropic|}}}|{{!}}[[Category:Anisotropic Filtering (Config Required)]]{{Hover|Reduces distortion when viewing textures at an angle (1x, 2x, 4x, 8x, 16x)|'''Anisotropic Filtering'''}}{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
 
{{#if:{{{anisotropic|}}}|{{!}}[[Category:Anisotropic Filtering (Config Required)]]{{Hover|Reduces distortion when viewing textures at an angle (1x, 2x, 4x, 8x, 16x)|'''Anisotropic Filtering'''}}{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
{{!}}-
 
{{#if:{{{ubershaders|}}}|{{!}}[[Category:Ubershaders (Config Required)]]{{Hover|Sets whether specialized shaders or ubershaders are used (Off, Hybrid, Exclusive)|'''Ubershaders'''}}{{!!}}{{{ubershaders|}}}{{!!}}{{{ubershadersnotes|}}}}}
 
 
{{!}}-
 
{{!}}-
 
{{#if:{{{efbscaledcopy|}}}|{{!}}[[Category:Scaled EFB Copy (Config Required)]]{{Hover|Greatly increase the quality of textures generated using render-to-texture effects (On, Off)|'''Scaled EFB Copy'''}}{{!!}}{{{efbscaledcopy|}}}{{!!}}{{{efbscaledcopynotes|}}}}}
 
{{#if:{{{efbscaledcopy|}}}|{{!}}[[Category:Scaled EFB Copy (Config Required)]]{{Hover|Greatly increase the quality of textures generated using render-to-texture effects (On, Off)|'''Scaled EFB Copy'''}}{{!!}}{{{efbscaledcopy|}}}{{!!}}{{{efbscaledcopynotes|}}}}}
Line 145: Line 151:
 
{{!}}-
 
{{!}}-
 
{{#if:{{{disablefog|}}}|{{!}}[[Category:Disable Fog (Config Required)]]{{Hover|Disables the fog used in some games to hide far-away objects (On, Off)|'''Disable Fog'''}}{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
 
{{#if:{{{disablefog|}}}|{{!}}[[Category:Disable Fog (Config Required)]]{{Hover|Disables the fog used in some games to hide far-away objects (On, Off)|'''Disable Fog'''}}{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
 +
{{!}}-
 +
{{#if:{{{arbmipmap|}}}|{{!}}[[Category:Arbitrary Mipmap Detection (Config Required)]]{{Hover|Enables detection of arbitrary mipmaps, which some games use for special distance-based effects (On, Off)|'''Arbitrary Mipmap Detection'''}}{{!!}}{{{arbmipmap|}}}{{!!}}{{{arbmipmapnotes|}}}}}
 
{{!}}-
 
{{!}}-
 
{{#if:{{{skipcpuefbaccess|}}}|{{!}}[[Category:Skip EFB Access from CPU (Config Required)]]{{Hover|Prevents the CPU from accessing the External Frame Buffer (On, Off)|'''Skip EFB Access from CPU'''}}{{!!}}{{{skipcpuefbaccess|}}}{{!!}}{{{skipcpuefbaccessnotes|}}}}}
 
{{#if:{{{skipcpuefbaccess|}}}|{{!}}[[Category:Skip EFB Access from CPU (Config Required)]]{{Hover|Prevents the CPU from accessing the External Frame Buffer (On, Off)|'''Skip EFB Access from CPU'''}}{{!!}}{{{skipcpuefbaccess|}}}{{!!}}{{{skipcpuefbaccessnotes|}}}}}
Line 340: Line 348:
 
{{{framelimitnotes|}}}
 
{{{framelimitnotes|}}}
 
{{#regex:{{{cpuengine}}}|/.*[iI][lL].*/}}
 
{{#regex:{{{cpuengine}}}|/.*[iI][lL].*/}}
{{#regex:{{{gfxbackend}}}|/.*(Direct3D12{{!}}D3D12{{!}}Direct3D 12).*/}}
+
{{{ubershaders|}}}
 +
{{{ubershadersnotes|}}}
 
<!-- Since 5.0-5874 -->
 
<!-- Since 5.0-5874 -->
 
{{{xfb|}}}
 
{{{xfb|}}}
 
{{{xfbnotes|}}}
 
{{{xfbnotes|}}}
 
|[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>{{documentation}}</noinclude>
 
|[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>{{documentation}}</noinclude>

Revision as of 06:11, 12 August 2019

[edit] [purge] Template documentation

This template outputs a standardized set of configuration information.

Example

{{Config
|dualcore               = Off
|dualcorenotes          = Show File Select menus properly
}}

Produces

Only configuration options for the best compatibility where they deviate from defaults are listed.

General

Config Setting Notes
Enable Dual Core Off Show File Select menus properly

Parameters

The following lists a complete set of current config template settings:

== Configuration ==
{{Config
<!-- General -->
|dualcore               = 
|dualcorenotes          = 
|speedlimit             = 
|speedlimitnotes        = 
|cpuengine              = 
|cpuenginenotes         = 
|ntscj                  = 
|ntscjnotes             = 
|panichandlers          = 
|panichandlersnotes     = 
|skipbios               = 
|skipbiosnotes          = 
|cpuclock               = 
|cpuclocknotes          = 

<!-- Graphics -->
|gfxbackend             = 
|gfxbackendnotes        = 
|fullres                = 
|fullresnotes           = 
|aspectratio            = 
|aspectrationotes       = 
|vsync                  = 
|vsyncnotes             = 
|startfull              = 
|startfullnotes         = 
|rendertomain           = 
|rendertomainnotes      = 
|shadercomp             = 
|shadercompnotes        = 
|compilefirst           = 
|compilefirstnotes      = 
|internalres            = 
|internalresnotes       = 
|antialiasing           = 
|antialiasingnotes      = 
|anisotropic            = 
|anisotropicnotes       = 
|efbscaledcopy          = 
|efbscaledcopynotes     = 
|pixellighting          = 
|pixellightingnotes     = 
|forcefilter            = 
|forcefilternotes       = 
|widescreenhack         = 
|widescreenhacknotes    = 
|disablefog             = 
|disablefognotes        = 
|arbmipmap              = 
|arbmipmapnotes         = 
|skipcpuefbaccess       = 
|skipcpuefbaccessnotes  = 
|formatchanges          = 
|formatchangesnotes     = 
|efb2texonly            = 
|efb2texonlynotes       = 
|deferefb               = 
|deferefbnotes          = 
|accuratetexturecache      = 
|accuratetexturecachenotes = 
|gputexdecode           = 
|gputexdecodenotes      = 
|xfb2texonly            = 
|xfb2texonlynotes       = 
|xfbimmediate           = 
|xfbimmediatenotes      = 
|fastdepth              = 
|fastdepthnotes         = 
|boundingbox            = 
|boundingboxnotes       = 
|vertexrounding         = 
|vertexroundingnotes    = 
|crop                   = 
|cropnotes              = 
|progressivescan        = 
|progressivescannotes   = 

<!-- Audio -->
|dspengine              = 
|dspenginenotes         = 
|audiobackend           = 
|audiobackendnotes      = 

<!-- Wii -->
|pal60                  = 
|pal60notes             = 
|screensaver            = 
|screensavernotes       = 
|sdcard                 = 
|sdcardnotes            = 
|usbkeyboard            = 
|usbkeyboardnotes       = 
|systemlang             = 
|systemlangnotes        = 

<!-- Wiimote -->
|enablespeakerdata      = 
|enablespeakerdatanotes = 
|wiimotemotor           = 
|wiimotemotornotes      = 

<!-- Game Properties -->
|mmu                    = 
|mmunotes               = 
|fprf                   = 
|fprfnotes              = 
|syncgputhread          = 
|syncgputhreadnotes     = 
|fastdisc               = 
|fastdiscnotes          = 
|patches                = 
|patchesnotes           = 
}}