README.OS2
changeset 1442 e3242177fe4a
parent 1190 173c063d4f55
child 1659 14717b52abc0
     1.1 --- a/README.OS2	Sun Feb 26 13:42:00 2006 +0000
     1.2 +++ b/README.OS2	Sun Feb 26 19:30:21 2006 +0000
     1.3 @@ -3,7 +3,7 @@
     1.4  SDL on OS/2
     1.5  ===========
     1.6  
     1.7 -Last updated on Oct 02, 2005.
     1.8 +Last updated on Feb. 26, 2006.
     1.9  
    1.10  
    1.11  1. How to compile?
    1.12 @@ -16,6 +16,11 @@
    1.13  - The FSLib library
    1.14    (ftp://ftp.netlabs.org/pub/SDL)
    1.15  
    1.16 +First of all, you have to put the OS/2-specific Watcom makefiles into the
    1.17 +source code tree by unzipping the file Watcom-OS2.zip here.  This will
    1.18 +result in a Watcom.mif and a setvars.cmd file in this folder, and several
    1.19 +Makefile.wat files in the src\ folder and in some of its subfolders.
    1.20 +
    1.21  Please edit the second, fourth and fifth lines of setvars.cmd file
    1.22  to set the folders where the toolkit, the OW compiler and the FSLib are. 
    1.23  You won't need NASM yet (The Netwide Assembler), you can leave that line.
    1.24 @@ -107,7 +112,59 @@
    1.25  
    1.26  
    1.27  
    1.28 -6. Next steps...
    1.29 +6. Proportional windows
    1.30 +-----------------------
    1.31 +
    1.32 +For some SDL applications it can be handy to have proportional windows, so
    1.33 +the windows will keep their aspect ratio when resized.
    1.34 +This can be achieved in two ways:
    1.35 +
    1.36 +- Before starting the given SDL application, set the
    1.37 +  SDL_USE_PROPORTIONAL_WINDOW environment variable to something, e.g.:
    1.38 +
    1.39 +  SET SDL_USE_PROPORTIONAL_WINDOW=1
    1.40 +  dosbox.exe
    1.41 +
    1.42 +- If you have a HOME environment variable set, then SDL will look for a file
    1.43 +  in there called ".sdl.proportionals". If that file contains the name of the
    1.44 +  currently running SDL executable, then that process will have proportional
    1.45 +  windows automatically.
    1.46 +
    1.47 +  Please note that this file is created automatically with default values
    1.48 +  at the first run.
    1.49 +
    1.50 +
    1.51 +
    1.52 +7. Audio in SDL applications
    1.53 +----------------------------
    1.54 +
    1.55 +Audio effects are one of the most important features in games. Creating audio
    1.56 +effects in sync with the game and without hickups and pauses in the audio are
    1.57 +very important things.
    1.58 +
    1.59 +However there are multithreaded SDL applications that have tight loops as their
    1.60 +main logic loop. This kills performance in OS/2, and takes too much CPU from
    1.61 +other threads in the same process, for example from the thread to create the 
    1.62 +sound effects.
    1.63 +
    1.64 +For this reason, the OS/2 port of SDL can be instructed to run the audio thread
    1.65 +in high priority, which makes sure that there will be enough time for the 
    1.66 +processing of the audio data.
    1.67 +
    1.68 +At default, SDL/2 runs the audio thread at ForegroundServer+0 priority. Well 
    1.69 +written and well behaving SDL applications should work well in this mode.
    1.70 +For other applications, you can tell SDL/2 to run the audio thread at 
    1.71 +TimeCritical priority by setting an env.variable before starting the SDL app:
    1.72 +
    1.73 +    SET SDL_USE_TIMECRITICAL_AUDIO=1
    1.74 +
    1.75 +Please note that this is a bit risky, because if the SDL application runs a
    1.76 +tight infinite loop in this thread, this will make the whole system 
    1.77 +unresponsive, so use it with care, and only for applications that need it!
    1.78 +
    1.79 +
    1.80 +
    1.81 +8. Next steps...
    1.82  ----------------
    1.83  
    1.84  Things to do:
    1.85 @@ -119,7 +176,7 @@
    1.86  
    1.87  
    1.88  
    1.89 -7. Contacts
    1.90 +9. Contacts
    1.91  -----------
    1.92  
    1.93     You can contact the developers for bugs:
    1.94 @@ -131,3 +188,90 @@
    1.95     Notice however that SDL/2 is 'in development' stage so ... if you want to help,
    1.96  please, be our guest and contact us!
    1.97  
    1.98 +
    1.99 +
   1.100 +10. Changelog of the OS/2 port
   1.101 +------------------------------
   1.102 +
   1.103 +Version 1.2 - 2006-02-26  - Doodle
   1.104 + - Updated the official SDL version with the OS/2 specific changes.
   1.105 + - Added support for real unicode keycode conversion.
   1.106 +
   1.107 +Version 1.2.7 - 2006-01-20  - Doodle
   1.108 + - Added support for selectively using timecritical priority for
   1.109 +   audio threads by SDL_USE_TIMECRITICAL_AUDIO environment variable.
   1.110 +   (e.g.: 
   1.111 +    SET SDL_USE_TIMECRITICAL_AUDIO=1
   1.112 +    dosbox.exe
   1.113 +   )
   1.114 +
   1.115 +Version 1.2.7 - 2005-12-22  - Doodle
   1.116 + - Added support for proportional SDL windows.
   1.117 +   There are two ways to have proportional (aspect-keeping) windows for
   1.118 +   a given SDL application: Either set the SDL_USE_PROPORTIONAL_WINDOW
   1.119 +   environment variable to something before starting the application
   1.120 +   (e.g.: 
   1.121 +    SET SDL_USE_PROPORTIONAL_WINDOW=1
   1.122 +    dosbox.exe
   1.123 +   )
   1.124 +   or, if you have the HOME environment variable set, then SDL.DLL will
   1.125 +   create a file in that directory called .sdl.proportionals, and you can
   1.126 +   put there the name of executable files that will be automatically made
   1.127 +   proportional.
   1.128 +
   1.129 +Version 1.2.7 - 2005-10-14  - Doodle
   1.130 + - Enabled Exception handler code in FSLib to be able to restore original
   1.131 +   desktop video mode in case the application crashes.
   1.132 + - Added the missing FSLib_Uninitialize() call into SDL.
   1.133 +   (The lack of it did not cause problems, but it's cleaner this way.)
   1.134 + - Fixed a mouse problem in Fullscreen mode where any mouse click
   1.135 +   re-centered the mouse.
   1.136 +
   1.137 +Version 1.2.7 - 2005-10-09  - Doodle
   1.138 + - Implemented window icon support
   1.139 +
   1.140 +Version 1.2.7 - 2005-10-03  - Doodle
   1.141 + - Reworked semaphore support again
   1.142 + - Tuned thread priorities
   1.143 +
   1.144 +Version 1.2.7 - 2005-10-02  - Doodle
   1.145 + - Added support for custom mouse pointers
   1.146 + - Fixed WM_CLOSE processing: give a chance to SDL app to ask user...
   1.147 + - Added support for MMX-accelerated audio mixers
   1.148 + - Other small fixes
   1.149 +
   1.150 +Version 1.2.7 - 2005-09-12  - Doodle
   1.151 + - Small fixes for DosBox incorporated into public release
   1.152 + - Fixed semaphore support (SDL_syssem.c)
   1.153 + - Fixed FSLib to have good clipping in scaled window mode,
   1.154 +   and to prevent occasional desktop freezes.
   1.155 +
   1.156 +Version 1.2.7 - 2004-09-08a - Caetano
   1.157 +	- Improved joystick support (general verifications about hardware).
   1.158 +	- Added support up to 8 buttons in 2 axes joysticks and 6 buttons in 3 axes joysticks.
   1.159 +	- Added support to environment variable SDL_OS2_JOYSTICK to specify a joystick.
   1.160 +	- Improved Joystick test to handle every type of joystick and display only relevant information.
   1.161 +	- Merged with Doodle 2004-09-08
   1.162 +	- Little tid up in README.OS2
   1.163 +	- Added explanation about SDL_OS2_JOYSTICK environment variable on README.OS2
   1.164 +
   1.165 +Version 1.2.7 - 2004-09-07 - Caetano
   1.166 +	- Merged with changes in headers for GCC compiling.
   1.167 +	- Added Joystick support using basic IBM GAME$ support, allowing it to work with all joystick drivers since OS/2 2.1.
   1.168 +	- Improved joystick detection (hacked!). OS/2 do not allow real joystick detection, so... 
   1.169 +	- Modified makefile in test to compile "testjoystick". Anyway, it's useless, since it seems to cause a lot of trouble in OS/2 (because os video routines, not Joystick support).
   1.170 +	- Created separated Joystick test program to test only joystick functions.
   1.171 +	- Improved joystick auto-centering.
   1.172 +	- Improved the coordinate correction routine to use two scale factors for each axis.
   1.173 +
   1.174 +Version 1.2.7 - 2004-07-05 - Caetano
   1.175 +	- Corrected the time returned by status in CDROM support (it was incorrect)
   1.176 +	- Added the testcdrom.c and corrected the linking directive (it was causing an error)
   1.177 +
   1.178 +Version 1.2.7 - 2004-07-02a - Caetano
   1.179 +	- Corrected a little problem in a comment at SDL-1.2.7\test\torturethread.c, line 18 (missing */, nested comment)
   1.180 +	- Added CDROM support to tree (SDL-1.2.7\src\cdrom\os2\SDL_syscdrom.c)
   1.181 +	- Modified makefile (SDL-1.2.7\src\makefiles.wat and SDL-1.2.7\watcom.mif) to build with CDROM support
   1.182 +	- Added the "extra" SDL_types.h forgotten in 2004-07-02 version.
   1.183 +
   1.184 +<End-Of-File>