Add support for border removal

[sdl_omap.git] / README.OMAP

diff --git a/README.OMAP b/README.OMAP
index b39fb33..2da9e26 100644 (file)
--- a/README.OMAP
+++ b/README.OMAP
@@ -37,10 +37,20 @@ Other environment variables:
 
 SDL_OMAP_LAYER_SIZE:
   Output layer size. Regardless what you set with SDL_SetVideoMode(), output
-  will be scaled to this size using hardware. Valid values:
+  will be scaled to this size using hardware with zero processing cost.
+  Note: scaling amount range is limited to roughly 1/4x-8x. The exact range
+  depends on various factors like version of the driver or OMAP hardware itself.
+  Valid values:
     "WxH", for example "640x480"
     "fullscreen" to cover whole screen.
 
+SDL_OMAP_BORDER_CUT:
+  This can be used to move parts of SDL surface out of screen, in other
+  words cut borders and zoom in. Format: <left>,<right>,<top>,<bottom>
+  For example, "0,0,16,0" would hide top 16 lines offscreen, making 17th
+  (16th if you count from 0) line the first visible.
+  Note: like for layer size ranges are limited.
+
 SDL_OMAP_VSYNC:
   Enables waiting for vertical sync on SDL_Flip() calls.
   Set to "1" to enable, "0" to disable.
@@ -54,6 +64,10 @@ SDL_OMAP_FORCE_DOUBLEBUF:
   Note that if app isn't updating whole buffer each frame, it will glitch.
   This is the same as specifying SDL_DOUBLEBUF to SDL_SetVideoMode.
 
+SDL_OMAP_NO_TS_TRANSLATE:
+  Disable automatic touchscreen screen -> layer coordinate translation,
+  return real screen coordinates.
+
 
 Config file
 -----------
@@ -68,6 +82,9 @@ force_vsync = 1/0
 # same as SDL_OMAP_FORCE_DOUBLEBUF
 force_doublebuf = 1/0
 
+# same as SDL_OMAP_NO_TS_TRANSLATE
+no_ts_translate = 1/0
+
 # can be used to bind a key to SDL keysym, good for quick ports.
 # Example:
 # bind ev_home = sdlk_space