changeset 1352:90c9922b5430

Add description of overscan settings to README
author Michael Pavone <pavone@retrodev.com>
date Tue, 09 May 2017 22:57:12 -0700
parents bb0318a73b54
children 52d9e3c36b4f
files README
diffstat 1 files changed, 27 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README	Tue May 09 00:02:59 2017 -0700
+++ b/README	Tue May 09 22:57:12 2017 -0700
@@ -186,6 +186,32 @@
 is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
 in the config, -f will turn it off.
 
+The "ntsc" and "pal" sub-sections control overscan settings for the emulated
+video output for NTSC and PAL consoles respectively. More details are available
+in the Overscan section.
+
+Overscan
+--------
+
+Analog televisions generally don't display the entirety of a video frame. Some
+portion is cropped at the edges of the display. This is called overscan.
+Unfortunately, the amount of cropping performed varies considerably and is even
+adjustable on many TV sets. To deal with this, BlastEm allows overscan to be
+customized.
+
+Overscan values are specified in the "ntsc" and "pal" sub-sections of the
+"video" section of the config file. The "overscan" sub-section contains four
+settings for specifying the number of pixels cropped on each side of the
+display: "top", "bottom", "left" and "right".
+
+The default settings hide the horizontal border completely for both NTSC and
+PAL consoles. For the vertical borders, the NTSC overscan settings are chosen
+to give square pixels with the default aspect ratio of 4:3. For PAL, the
+default settings are set so that the PAL-exclusive V30 mode will produce a
+visible border that is the same size as what is shown in V28 mode in NTSC. This
+results in a slightly squished picture compared to NTSC which is probably
+appropriate given that a PAL display has more lines than an NTSC one.
+
 Audio
 -----
 
@@ -335,7 +361,7 @@
 generally work as long as your computer is fast enough to cope with the time
 lost waiting for VSync and the audio buffer is large enough to not run out of
 samples during that delay. Latency will suffer a bit and you'll get a doubled
-frame, but things will be fine.
+frame every once and a while, but generally things will be fine.
 
 If you enable VSync and you're getting audio dropouts, first try doubling the
 audio buffer setting. If you still experience dropouts, it's possible your