annotate README.Watcom @ 1731:875c3cf1a12c SDL-1.3

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