more docs, spellcheck
All checks were successful
eden-license / license-header (pull_request) Successful in 20s
All checks were successful
eden-license / license-header (pull_request) Successful in 20s
Signed-off-by: lizzie <lizzie@eden-emu.dev>
This commit is contained in:
parent
cf9a72cb1a
commit
6c5234afc5
2 changed files with 21 additions and 24 deletions
|
@ -57,6 +57,13 @@ Some examples:
|
||||||
Before adding a new setting, consider:
|
Before adding a new setting, consider:
|
||||||
- Does the piece of code that the setting pertains to, make a significant difference if it's on/off?
|
- Does the piece of code that the setting pertains to, make a significant difference if it's on/off?
|
||||||
- Can it be auto-detected?
|
- Can it be auto-detected?
|
||||||
|
- Does the option behave differently on some platforms?
|
||||||
|
- Is it a feature specific to a given platform?"
|
||||||
|
|
||||||
|
While not a silver bullet, settings are mainly suitable for:
|
||||||
|
- Core: CPU, memory, input, scheduler, audio, or other base emulator logic.
|
||||||
|
- UI: Anything involving menus, dialogs shows/removal, bind settings.
|
||||||
|
- Graphics: Rendering backends (OpenGL, Vulkan) Visual fixes that only work on some games and may break others.
|
||||||
|
|
||||||
# IDE setup
|
# IDE setup
|
||||||
|
|
||||||
|
|
|
@ -113,40 +113,35 @@ std::unique_ptr<TranslationMap> InitializeTranslations(QObject* parent)
|
||||||
|
|
||||||
// Cpu Unsafe
|
// Cpu Unsafe
|
||||||
INSERT(Settings, cpuopt_unsafe_host_mmu, tr("Enable Host MMU Emulation (fastmem)"),
|
INSERT(Settings, cpuopt_unsafe_host_mmu, tr("Enable Host MMU Emulation (fastmem)"),
|
||||||
tr("This optimization speeds up memory accesses by the guest program.\nEnabling it causes guest memory reads/writes to be done directly into memory and make use of Host's MMU.\nDisabling this forces all memory accesses to use Software MMU Emulation."));
|
tr("Enabling causes guest memory operations to be done directly into host memory with an on-demand paging mechanism.\nDisabling this forces all memory accesses to use a slower translation dispatch."));
|
||||||
INSERT(
|
INSERT(
|
||||||
Settings,
|
Settings,
|
||||||
cpuopt_unsafe_unfuse_fma,
|
cpuopt_unsafe_unfuse_fma,
|
||||||
tr("Unfuse FMA (improve performance on CPUs without FMA)"),
|
tr("Unfuse FMA"),
|
||||||
tr("This option improves speed by reducing accuracy of fused-multiply-add instructions on "
|
tr("Prevents materialisation of precise fused-multiply-add instructions."));
|
||||||
"CPUs without native FMA support."));
|
|
||||||
INSERT(
|
INSERT(
|
||||||
Settings,
|
Settings,
|
||||||
cpuopt_unsafe_reduce_fp_error,
|
cpuopt_unsafe_reduce_fp_error,
|
||||||
tr("Faster FRSQRTE and FRECPE"),
|
tr("Faster FRSQRTE and FRECPE"),
|
||||||
tr("This option improves the speed of some approximate floating-point functions by using "
|
tr("Uses (innacurate but fast) native instructions as opposed to checked ones."));
|
||||||
"less accurate native approximations."));
|
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
cpuopt_unsafe_ignore_standard_fpcr,
|
cpuopt_unsafe_ignore_standard_fpcr,
|
||||||
tr("Faster ASIMD instructions (32 bits only)"),
|
tr("Faster ASIMD instructions (32 bits only)"),
|
||||||
tr("This option improves the speed of 32 bits ASIMD floating-point functions by running "
|
tr("Removes checks for FPCR rounding mode on floating-point instructions."));
|
||||||
"with incorrect rounding modes."));
|
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
cpuopt_unsafe_inaccurate_nan,
|
cpuopt_unsafe_inaccurate_nan,
|
||||||
tr("Inaccurate NaN handling"),
|
tr("Inaccurate NaN handling"),
|
||||||
tr("This option improves speed by removing NaN checking.\nPlease note this also reduces "
|
tr("Removes checks for NaNs on all floating-point instructions."));
|
||||||
"accuracy of certain floating-point instructions."));
|
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
cpuopt_unsafe_fastmem_check,
|
cpuopt_unsafe_fastmem_check,
|
||||||
tr("Disable address space checks"),
|
tr("Disable address space checks"),
|
||||||
tr("This option improves speed by eliminating a safety check before every memory "
|
tr("Removes the safety check before every memory operation in the guest.\n"
|
||||||
"read/write in guest.\nDisabling it may allow a game to read/write the emulator's "
|
"Disabling will allow the guest to read/write all memory."));
|
||||||
"memory."));
|
|
||||||
INSERT(
|
INSERT(
|
||||||
Settings,
|
Settings,
|
||||||
cpuopt_unsafe_ignore_global_monitor,
|
cpuopt_unsafe_ignore_global_monitor,
|
||||||
tr("Ignore global monitor"),
|
tr("Ignore global monitor"),
|
||||||
tr("This option improves speed by relying only on the semantics of cmpxchg to ensure "
|
tr("This option improves speed by relying on the semantics of CMPXCHG to ensure "
|
||||||
"safety of exclusive access instructions.\nPlease note this may result in deadlocks and "
|
"safety of exclusive access instructions.\nPlease note this may result in deadlocks and "
|
||||||
"other race conditions."));
|
"other race conditions."));
|
||||||
|
|
||||||
|
@ -168,7 +163,7 @@ std::unique_ptr<TranslationMap> InitializeTranslations(QObject* parent)
|
||||||
resolution_setup,
|
resolution_setup,
|
||||||
tr("Resolution:"),
|
tr("Resolution:"),
|
||||||
tr("Forces the guest to render at a different resolution.\n"
|
tr("Forces the guest to render at a different resolution.\n"
|
||||||
"Higher resolutions require more VRAM and bandwidth.\n"
|
"Higher resolutions require more VRAM.\n"
|
||||||
"Options lower than 1X can cause artifacts."));
|
"Options lower than 1X can cause artifacts."));
|
||||||
INSERT(Settings, scaling_filter, tr("Window Adapting Filter:"), QString());
|
INSERT(Settings, scaling_filter, tr("Window Adapting Filter:"), QString());
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
|
@ -183,10 +178,8 @@ std::unique_ptr<TranslationMap> InitializeTranslations(QObject* parent)
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
fullscreen_mode,
|
fullscreen_mode,
|
||||||
tr("Fullscreen Mode:"),
|
tr("Fullscreen Mode:"),
|
||||||
tr("The method used to render the window in fullscreen.\nBorderless offers the best "
|
tr("Borderless offers the best compatibility with the on-screen keyboard.\n"
|
||||||
"compatibility with the on-screen keyboard that some games request for "
|
"Exclusive fullscreen offers better Freesync/Gsync support."));
|
||||||
"input.\nExclusive "
|
|
||||||
"fullscreen may offer better performance and better Freesync/Gsync support."));
|
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
aspect_ratio,
|
aspect_ratio,
|
||||||
tr("Aspect Ratio:"),
|
tr("Aspect Ratio:"),
|
||||||
|
@ -196,14 +189,11 @@ std::unique_ptr<TranslationMap> InitializeTranslations(QObject* parent)
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
use_disk_shader_cache,
|
use_disk_shader_cache,
|
||||||
tr("Use persistent pipeline cache"),
|
tr("Use persistent pipeline cache"),
|
||||||
tr("Allows saving shaders to storage for faster loading on following game "
|
tr("Allows saving shaders for faster boot times - but will infinitely load if the cache is corrupt."));
|
||||||
"boots.\nDisabling it is only intended for debugging."));
|
|
||||||
INSERT(Settings,
|
INSERT(Settings,
|
||||||
optimize_spirv_output,
|
optimize_spirv_output,
|
||||||
tr("Optimize SPIRV shader"),
|
tr("Optimize SPIRV shader"),
|
||||||
tr("Runs an additional optimization pass over generated SPIRV shaders.\n"
|
tr("Runs an optimisation pass on all compiled SPIRV shaders.\n"));
|
||||||
"Will increase time required for shader compilation.\nMay slightly improve "
|
|
||||||
"performance.\nThis feature is experimental."));
|
|
||||||
INSERT(
|
INSERT(
|
||||||
Settings,
|
Settings,
|
||||||
use_asynchronous_gpu_emulation,
|
use_asynchronous_gpu_emulation,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue