README.Watcom
author Sam Lantinga <slouken@libsdl.org>
Wed, 17 May 2006 08:18:28 +0000
branchSDL-1.3
changeset 1659 14717b52abc0
child 1710 db78e088b6ce
permissions -rw-r--r--
Merge trunk-1.3-3
slouken@1659
     1
slouken@1659
     2
Using SDL under Windows with the OpenWatcom compiler
slouken@1659
     3
====================================================
slouken@1659
     4
slouken@1659
     5
Prerequisites
slouken@1659
     6
-------------
slouken@1659
     7
slouken@1659
     8
I have done the port under Windows XP Home with SP2 installed. Windows
slouken@1659
     9
2000 should also be working. I'm not so sure about ancient Windows NT,
slouken@1659
    10
since only DirectX 3 is available there. Building should be possible,
slouken@1659
    11
but running the compiled applications will probalbly fail with
slouken@1659
    12
SDL_VIDEODRIVER=directx. The windib driver should work, though.
slouken@1659
    13
slouken@1659
    14
To compile and use the SDL with Open Watcom you will need the following:
slouken@1659
    15
- Open Watcom compiler. I used version 1.5. The environment variables
slouken@1659
    16
  PATH, WATCOM and INCLUDE need to be set appropriately - please consult
slouken@1659
    17
  the OpenWatcom documentation and instructions given during the
slouken@1659
    18
  installation of the compiler.
slouken@1659
    19
  My setup looks like this in owvars.bat:
slouken@1659
    20
    set WATCOM=C:\watcom
slouken@1659
    21
    set INCLUDE=%WATCOM%\h;%WATCOM%\h\nt
slouken@1659
    22
    set PATH=%PATH%;%WATCOM%\binnt;%WATCOM%\binw
slouken@1659
    23
- A fairly recent DirectX SDK. The original unmodified DX8 SDK works, as
slouken@1659
    24
  well as the minimal DirectX 7 SDK from the Allegro download site
slouken@1659
    25
  (<http://alleg.sourceforge.net/files/dx70_min.zip>).
slouken@1659
    26
- The SDL sources from Subversion
slouken@1659
    27
- The file Watcom-Win32.zip (now available in Subversion)
slouken@1659
    28
slouken@1659
    29
slouken@1659
    30
Building the Library
slouken@1659
    31
--------------------
slouken@1659
    32
slouken@1659
    33
1) In the SDL base directory extract the archive Watcom-Win32.zip. This
slouken@1659
    34
   creates a subdirectory named 'watcom'.
slouken@1659
    35
2) The makefile expects the environment variable DXDIR to be set to the
slouken@1659
    36
   base directory of a DirectX SDK. I have tried a stock DX8 SDK from
slouken@1659
    37
   Microsoft as well as the minimal DirectX 7 SDK from the Allegro
slouken@1659
    38
   download site.
slouken@1659
    39
   You can also edit the makefile directly and hard code your path to
slouken@1659
    40
   the SDK on your system.
slouken@1659
    41
   I have this in my setup:
slouken@1659
    42
     set DXDIR=D:\devel\DX8_SDK
slouken@1659
    43
3) Enter the watcom directory and run
slouken@1659
    44
     wmake sdl
slouken@1659
    45
4) All tests from the test directory are working and can be built by
slouken@1659
    46
   running
slouken@1659
    47
     wmake tests
slouken@1659
    48
slouken@1659
    49
Notes:
slouken@1659
    50
slouken@1659
    51
 The makefile offers some options to tweak the way the library is built.
slouken@1659
    52
 You have at your disposal the option to build a static (default)
slouken@1659
    53
 library, or a DLL (with tgt=dll). You can also choose whether to build
slouken@1659
    54
 a Release (default) or a Debug version (with build=debug) of the tests
slouken@1659
    55
 and library. Please consult the usage comment at the top of the
slouken@1659
    56
 makefile for usage instructions.
slouken@1659
    57
slouken@1659
    58
 If you specify a test target (i.e. 'wmake tests' for all tests, or
slouken@1659
    59
 selected targets like 'wmake testgl testvidinfo testoverlay2'), the
slouken@1659
    60
 tests are always freshly compiled and linked. This is done to
slouken@1659
    61
 minimise hassle when switching between library versions (static vs.
slouken@1659
    62
 DLL), because they require subtly different options.
slouken@1659
    63
 Also, the test executables are put directly into the test directory,
slouken@1659
    64
 so they can find their data files. The clean target of the makefile
slouken@1659
    65
 removes the test executables and the SDL.dll file from the test
slouken@1659
    66
 directory.
slouken@1659
    67
slouken@1659
    68
 To use the library in your own projects with Open Watcom, you can use
slouken@1659
    69
 the way the tests are built as base of your own build environment.
slouken@1659
    70
slouken@1659
    71
slouken@1659
    72
Test applications
slouken@1659
    73
-----------------
slouken@1659
    74
slouken@1659
    75
I've tried to make all tests work. The following table gives an overview
slouken@1659
    76
of the current status.
slouken@1659
    77
slouken@1659
    78
 Testname        Status
slouken@1659
    79
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
slouken@1659
    80
checkkeys       +
slouken@1659
    81
graywin         +
slouken@1659
    82
loopwave        +
slouken@1659
    83
testalpha       +
slouken@1659
    84
testbitmap      +
slouken@1659
    85
testdyngl       +
slouken@1659
    86
testerror       +
slouken@1659
    87
testfile        +
slouken@1659
    88
testgamma       +
slouken@1659
    89
testgl          +
slouken@1659
    90
testhread       +
slouken@1659
    91
testiconv       - (all failed)
slouken@1659
    92
testkeys        +
slouken@1659
    93
testlock        +
slouken@1659
    94
testoverlay     + (needs 'set SDL_VIDEODRIVER=directx')
slouken@1659
    95
testoverlay2    + (needs 'set SDL_VIDEODRIVER=directx')
slouken@1659
    96
testpalette     +
slouken@1659
    97
testplatform    +
slouken@1659
    98
testsem         +
slouken@1659
    99
testsprite      +
slouken@1659
   100
testtimer       +
slouken@1659
   101
testver         +
slouken@1659
   102
testvidinfo     +
slouken@1659
   103
testwin         - (fading doesn't seem right)
slouken@1659
   104
testwm          +
slouken@1659
   105
torturethread   +
slouken@1659
   106
testcdrom       +
slouken@1659
   107
testjoystick    not tested
slouken@1659
   108
threadwin       +
slouken@1659
   109
slouken@1659
   110
slouken@1659
   111
TODO
slouken@1659
   112
----
slouken@1659
   113
slouken@1659
   114
There is room for further improvement:
slouken@1659
   115
- Test joystick functionality.
slouken@1659
   116
- Investigate fading issue in 'testwin' test.
slouken@1659
   117
- Fix the UTF-8 support.
slouken@1659
   118
- Adapt the makefile/object file list to support more target systems
slouken@1659
   119
- Use "#pragma aux" syntax for the CPU info functions.
slouken@1659
   120
slouken@1659
   121
slouken@1659
   122
Questions and Comments
slouken@1659
   123
----------------------
slouken@1659
   124
slouken@1659
   125
Please direct any questions or comments to me:  <mailto:macpete@gmx.de>
slouken@1659
   126
slouken@1659
   127
   Happy Coding!
slouken@1659
   128
slouken@1659
   129
   Marc Peter