libretro/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-11-30 12:10:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #630 from FroyoXSG/patch-2

Browse Source 
Proofread pass on crtswitchres.md
This commit is contained in:
Ömercan Kömür 2021-07-06 16:33:44 +03:00 committed by GitHub
commit e524dd98a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/guides/crtswitchres.md
View File

@ -4,15 +4,15 @@
### Windows
Windows works best CRTEmuDriver available [here](https://geedorah.com/eiusdemmodi/forum/viewtopic.php?id=295). Once you have this setup and running, it is a simple case of turning CRTSwitchRes on and choosing your settings.
Windows works the best with CRT Emudriver, available [here](https://geedorah.com/eiusdemmodi/forum/viewtopic.php?id=295). Once you have this setup and running, it is a simple case of turning CRTSwitchRes on and choosing your settings.
Other options are available. Its a simple case of getting the rersoluitons installed on you Windows PC.
Other options are available. It's a simple case of getting the resolutions installed on you Windows PC.
### Linux
No pre setup required here. Although X11 is a requirment at the momnet. Simply install/compile RetroArch choose you CRTSwitchRes setting and your off.
No pre setup required here, although X11 is a requirement at the moment. Simply install/compile RetroArch choose you CRTSwitchRes setting, and you're off.
This is also compatibale with Raspberry Pi, X11 is not a requirement here.
This is also compatible with Raspberry Pi, X11 is not a requirement here.
## Enabling and Changing Settings
@ -21,16 +21,16 @@ CRTSwitchRes now using Switchres by Calamity. This is available on both Windows
To enable CRTSwitchRes or change settings
- Navigate to **Settings**
- Navigate to **Video**
- Navigate to **CRT Swicthres**
- Navigate to **CRT SwitchRes**
!!! tip
CRTSwitchRes is hidden behind advanced settings. Please enable advenced settings in User Interface first.
CRTSwitchRes is hidden behind advanced settings. Please enable advanced settings in User Interface first.
## CRTSwitchRes Options
| Option | Available Values |
| ----------------------- |:-----------------------------------------------:|
| CRT Swicthres | off, 15KHz, 31KHZ Standard, 31KHZ- 120Hz, INI |
| CRT SwitchRes | off, 15KHz, 31KHZ Standard, 31KHZ- 120Hz, INI |
| CRT Super resolution | Native, Dynamic, 1920, 2560, 3840 |
| X Centering | Currently not in use |
| Porch Adjust | Currently not in use |
@ -38,18 +38,18 @@ To enable CRTSwitchRes or change settings
## Option 1. CRT SwitchRes
This option is where you will turn on SwitchRes and choose your main ouput hardware.
This option is where you will turn on SwitchRes and choose your main output hardware.
| CRT SwitchRes Value | Description |
| ----------------------- |:----------------------------------------------------------------------------------------:|
| off | This setting turns SwicthRes off |
| off | This setting turns SwitchRes off |
| 15KHz | This will request SR to be setup for 15KHz monitors/TVs output |
| 31KHz | This will request SR to be setup to output for 31KHz monitors/TVs output |
| 31KHz, 120z | This will request SR to be setup to output for 31KHz @120HZ monitors/TVs output for 240p |
| INI | Thsi will request SR to look at the switchres.ini for the monitors/TVs output |
| INI | This will request SR to look at the switchres.ini for the monitors/TVs output |
!!! tip
This can not be changed on-the-fly once SwitchRes is active. A restart is required for this setting to take effect.
This can not be changed on-the-fly once SwitchRes is active. This setting will take effect after a restart.
## Option 2. CRT Super Resolution
@ -62,36 +62,38 @@ This option is where you will turn on SwitchRes and choose your main ouput hardw
| 3840 | This will pass a hard set super width of 3840 to SR |
!!! note
All resolution are integer scaled and aspect ratio corrected to match the original resolution. Unless you realy need a locked super width only choose native and let SR do all the work. Even if you monitor does not support native resolutions the best optopn to choose will be Native. For windows SwicthRes will look for compatibale modes with an dwithout super widths. Fo Linux you can add the switchres.ini **(see Advanced Settings below)** into you retroarch folder. Edit this file and change the dotclock_min form 0 to 25.0. This will then calculate dynamic super widths for cards that do not support low dotclocks (native width produce low dotclocks).
All resolution are integer scaled and aspect ratio corrected to match the original resolution. Unless you really need a locked super width only choose native and let SR do all the work. Even if your monitor does not support native resolutions, the best option to choose will be Native. For Windows, SwitchRes will look for compatible modes with and without super widths. For Linux, you can add the switchres.ini **(see Advanced Settings below)** into you RetroArch folder. Edit this file and change the dotclock_min form 0 to 25.0. This will then calculate dynamic super widths for cards that do not support low dotclocks (native widths produce low dotclocks).
## Advanced Settings
As CRTSwitchRes is now using Switchres by Calamity, there are many options to customise you enviroment within the switchres.ini. However, some options are available with the CRTSwicthres settings menu in RetroArch. Although more setting can been set in the switchres.ini it is not a required. It does however allow for more customisation. For more details on how to configure and use the swicthres.ini, [go here](https://gitlab.com/groovyarcade/support/-/wikis/3-Post-Installation-and-Maintenance/3.9-Configure-System-Wide-Switchres).
As CRTSwitchRes is now using Switchres by Calamity, there are many options to customise you environment within the switchres.ini. However, some options are available with the CRTSwitchRes settings menu in RetroArch. Although more settings can be set in the switchres.ini, it is not a required step. It does however allow for more customisation. For more details on how to configure and use the switchres.ini, [go here](https://gitlab.com/groovyarcade/support/-/wikis/3-Post-Installation-and-Maintenance/3.9-Configure-System-Wide-Switchres).
Currently, the switchres.ini is not supplied with RetoArch. This will change in the near future. In the meantime you can downlaod this file from [here](https://raw.githubusercontent.com/antonioginer/switchres/master/switchres.ini).
Currently, the switchres.ini is not supplied with RetoArch. This will change in the near future. In the meantime you can download this file from [here](https://raw.githubusercontent.com/antonioginer/switchres/master/switchres.ini).
!!! Note
A default switchres.ini file will be searched in the current working directory, then in .\ini on Windows, ./ini then /etc on Linux. The repo has a switchres.ini example.
## CRTSwitchRes Options Via retroarch.cfg
| Config Option Name | Desctriotion | Values |
| Config Option Name | Description | Values |
| ----------------------------------------------- |:------------------------------------------------------:|:--------------------------------:|
| crt_switch_center_adjust | Currently not in use | |
| crt_switch_porch_adjust | Currently not in use | |
| crt_switch_resolution | Same as above **CRT SwithRes** | 0,1,2,3,4 - off, 15KHz, 31KHZ Standard, 31KHZ- 120Hz, INI respectivly |
| crt_switch_resolution_super | Same as above **CRT Super Resolution** | Native, Dynamic, 1920, 2560,3840 |
| crt_switch_resolution | Same as above **CRT SwitchRes** | 0,1,2,3,4 - off, 15kHz, 31kHz Standard, 31kHz- 120Hz, INI respectively |
| crt_switch_resolution_super | Same as above **CRT Super Resolution** | Native, Dynamic, 1920, 2560, 3840|
| crt_switch_resolution_use_custom_refresh_rate | Not currently in use | false |
| crt_switch_timings | Do not Chnage | |
| crt_video_refresh_rate | Do not change | Set by Switchres |
| crt_switch_timings | Do not change | |
| crt_video_refresh_rate | Do not change | Set by SwitchRes |
## Core and directory overrides
If you are using a `switchres.ini` configuration file and wish to fine-tune specific setting for certain cores or directories, it is possible to use core and directory overrides for this. These files can be placed at the same locations as the usual `.cfg` files for RetroArch's core and directory overrides, only replacing the `.cfg` with `.switchres.ini`.
For example, if you are using native resolution on your configuration but want to user a 2560 super resolution on the Gambatte core, you can create the file `CONFIG_DIR/config/Gambatte/Gambatte.switchres.ini` with the content `user_mode 2560x0` in it. This setting will override the one on the original switchres.ini file when running this specific core, and when closing it, or switching to a different core, the default `switchres.ini` file will be re-loaded to undo the change.
For example, if you are using native resolution on your configuration but want to user a 2560 super resolution on the Gambatte core, you can create the file `CONFIG_DIR/config/Gambatte/Gambatte.switchres.ini` with the content `user_mode 2560x0` in it. This setting will override the one on the original switchres.ini file when running this specific core. When closing this core, or switching to a different core, the default `switchres.ini` file will be re-loaded to undo the change.
The same works for directory overrides; for example, if you want to use a super resolution of 2560 for roms in the "Sega - Game Gear" directory while using the Genesis Plus GX core, you can create the file `CONFIG_DIR/config/Genesis Plus GX/Sega - Game Gear.switchres.ini` and add the user mode to that file.
The same works for directory overrides.
Example: If you want to use a super resolution of 2560 for roms in the "Sega - Game Gear" directory, while using the Genesis Plus GX core, you can create an override.
Create the file `CONFIG_DIR/config/Genesis Plus GX/Sega - Game Gear.switchres.ini` and add the user mode to that file.
!!! note
You have to be using a full, complete `switchres.ini` base file for the overriding files to work properly, otherwise overriding settings will persist until you restart RetroArch.