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