[freesci-develop] r1563 - in freesci/trunk: . src/gfx/drivers

[freesci]

Author: arangas
Date: 2006-02-21 22:20:19 +0100 (Tue, 21 Feb 2006)
New Revision: 1563

Modified:
   freesci/trunk/ChangeLog
   freesci/trunk/README
   freesci/trunk/README.Win32
   freesci/trunk/src/gfx/drivers/dx_driver.cpp
Log:
This is primarily a Win32 documentation update.

-- Alex


Modified: freesci/trunk/ChangeLog
===================================================================
--- freesci/trunk/ChangeLog     2006-02-20 21:42:56 UTC (rev 1562)
+++ freesci/trunk/ChangeLog     2006-02-21 21:20:19 UTC (rev 1563)
@@ -1,3 +1,10 @@
+2006-02-22  Alex Angas <address@hidden>
+
+       * src/README.Win32: Documentation update.
+       * src/README: Moved high graphics config example from Win32 here.
+
+       * src/gfx/drivers/dx_driver.cpp: Updated compiler checks for DX version.
+
 2006-02-17  Christoph Reichenbach <address@hidden>
 
        * Added Makefile generation for 'custom' subdirectory

Modified: freesci/trunk/README
===================================================================
--- freesci/trunk/README        2006-02-20 21:42:56 UTC (rev 1562)
+++ freesci/trunk/README        2006-02-21 21:20:19 UTC (rev 1563)
@@ -553,6 +553,20 @@
 version = 0.000.453
 # This SQ3 version is ancient
 resource_dir = /home/bob/stuff/misc/other/games/more/sierra/old/sq/3
+
+[LSL3]
+
+# Max the graphics!
+pic0_dither_mode = dither256
+pic0_dither_pattern = unscaled
+pic_buffer_size = 2
+view_filter = trilinear
+pic_filter = trilinear
+cursor_filter = trilinear
+text_filter = trilinear
+animation_delay = 5
+
+resource_dir = /home/fred/lsl3
 -----------------------
 
 

Modified: freesci/trunk/README.Win32
===================================================================
--- freesci/trunk/README.Win32  2006-02-20 21:42:56 UTC (rev 1562)
+++ freesci/trunk/README.Win32  2006-02-21 21:20:19 UTC (rev 1563)
@@ -1,23 +1,41 @@
-ABOUT
------
+1 About the Win32 build of FreeSCI
+==================================
 
 The Win32 version of FreeSCI is virtually at the same level of
-functionality as the UNIX version. The major bugs are currently:
- * sound timing problems (see below)
- * SDL fullscreen support causes gfx corruption
- * SDL scaling > 3 causes gfx corruption
+functionality as the UNIX version. See '4 Known Problems' for the major bugs
+affecting this platform.
 
 
-BUILDING
---------
 
-You will need the following libraries and tools to build FreeSCI for Win32:
- * Visual C++ or Studio 6.0 with Service Pack 6 or Visual C++ or Studio 2003.
- * The latest Win32 Platform SDK, both Core 32-bit and DirectX components from:
-   http://msdn.microsoft.com/platformsdk
- * The SDL library from http://www.libsdl.org/ . You need to download the
-   development library for Win32 (e.g. SDL-devel-x.y.z-VC6.zip).
+2 Building FreeSCI for Win32
+============================
 
+2.1 Requirements
+----------------
+
+To start with, you need a copy of Visual Studio. Depending on the version you
+own, there are different requirements.
+
+ * Visual C++ or Studio 6.0 with Service Pack 6:
+   - Latest Win32 Platform SDK, both Core 32-bit and DirectX components from:
+     http://msdn.microsoft.com/platformsdk
+
+ * Visual C++ or Studio 7.0 (2002):
+   - Not supported
+
+ * Visual C++ or Studio 7.1 (2003):
+   - No additional requirements
+
+ * Visual C++ or Studio 8.0 (2005) and their Express Editions:
+   - Not currently supported (very soon)
+
+You will also need the SDL library from http://www.libsdl.org/. You need to
+download the development library for Win32 (e.g. SDL-devel-x.y.z-VC6.zip).
+
+
+2.2 Directory structure
+-----------------------
+
 The project files assume the following directory structure:
 
   \src
@@ -30,6 +48,9 @@
       \lib
 
 
+2.3 How to build
+----------------
+
 1. Go to the src\win32 directory. For Visual C++ or Studio 6, load freesci.dsw.
    For Visual C++ or Studio 2003, load freesci.sln.
 
@@ -49,49 +70,38 @@
 first) and it should link OK.
 
 
-CONFIG
-------
 
+3 Config
+========
+
 The configuration options described below should be put into your config file,
 located at %USERPROFILE%\.freesci\config .
 
 
-GRAPHICS:
+3.1 Graphics
+------------
 
-You'll probably be thinking that it doesn't look much prettier than the 
-original SCI. Try putting these options into your config file:
+This section only describes Win32 specific graphics settings. You can improve
+the display of your game by using the settings that apply to all platforms
+described in README. In particular, see the config example for LSL3 there.
 
-pic0_dither_mode = dither256
-pic0_dither_pattern = unscaled
-pic_buffer_size = 2
-view_filter = trilinear
-pic_filter = trilinear
-cursor_filter = trilinear
-text_filter = trilinear
-animation_delay = 5
 
-NOTE: When scaling beyond 3 times (-x3 or -y3), cursor redraws no longer 
-work properly. Also, fullscreen mode in SDL is currently not supported/working 
-on Win32. Hopefully, both of these bugs will be fixed in an upcoming release.
+3.1.1 SDL
+---------
 
+This is the default driver used when running FreeSCI. It can be explicitly
+specified with the -gSDL command line switch. As this is a cross-platform
+driver, its options are described in README.
 
-SOUND:
 
-To change the MIDI out device, add this line to your FreeSCI config file:
+3.1.2 DirectX
+-------------
 
-midiout.win32mci.device = x
-
-where x is the number of the device you wish to use.
-
-
-GRAPHICS:
-
 The DirectX driver will run with the -gdirectx command line switch on versions
 of DirectX 8.0a (for Win95) and higher. While the driver is only rendering 2D
 images, significant performance gains may be achieved by using a 3D graphics
 card with the driver.
 
-
 To change the adapter, add this line to your FreeSCI config file:
 
 gfx.directx.adapterid = x
@@ -100,11 +110,46 @@
 on the console screen when you first start FreeSCI).
 
 
-KNOWN PROBLEMS
---------------
+3.2 Sound
+---------
 
-SOUND:
+To change the MIDI out device, add this line to your FreeSCI config file:
 
+midiout.win32mci.device = x
+
+where x is the number of the device you wish to use.
+
+
+
+4 Known Problems
+================
+
+4.1 Graphics
+------------
+
+4.1.1 SDL
+---------
+
+ * When scaling beyond 3 times (-x3 or -y3), cursor redraws no longer work
+   properly.
+
+ * Fullscreen mode does not work.
+
+
+4.1.2 DirectX
+-------------
+
+ * Fullscreen mode does not work.
+
+ * You are unable to move the FreeSCI window.
+
+ * The FreeSCI window does not size or position itself correctly on some
+   resolutions.
+
+
+4.2 Sound
+---------
+
 There are currently timing problems when playing sound in games. While FreeSCI
 (Glutton) will solve these, at the moment we are stuck with it.
 
@@ -112,11 +157,12 @@
 To use the threaded SDL sound server, use the -Ssdl command line switch.
 
 
-SUBVERSION
-----------
 
+5 Source control (Subversion)
+=============================
+
 This is the best way to make sure you have the latest snapshot of FreeSCI. Info
-on Subversion can be obtained from http://www.subversion.org .
+on Subversion can be obtained from http://www.subversion.org/.
 
 Once you have a copy, we suggest copying it somewhere else to play with and
 work on, and then use a diff command to submit diffs. :-)
@@ -125,13 +171,13 @@
 the Web site.
 
 
-DEBUGGING
----------
 
+6 Debugging
+===========
+
 Have a read of 'How Do I... Topics: Debugging' in the MSDN docs. Don't have
-the MSDN library? Either use http://msdn.microsoft.com/ , or subscribe to the
-MSDN Library (see the MS Web site), or buy a cheap copy of Visual Basic
-Learning Edition which comes with the MSDN CDs. :-)
+the MSDN library? Either use http://msdn.microsoft.com/, or subscribe to the
+MSDN Library (see the MS Web site).
 
 There are two configurations set up for FreeSCI debugging - 'Win32 - Debug'
 and 'Win32 - Purify'. The former is to allow you to use the VC++ debugger with
@@ -140,9 +186,10 @@
 run checks on FreeSCI.
 
 
-GET INVOLVED
-------------
 
+7 Get involved
+==============
+
 We'd love people to help out. You don't have to have much (or any) experience
 with C. Check out the Development page at the FreeSCI Web site for more
 details.

Modified: freesci/trunk/src/gfx/drivers/dx_driver.cpp
===================================================================
--- freesci/trunk/src/gfx/drivers/dx_driver.cpp 2006-02-20 21:42:56 UTC (rev 
1562)
+++ freesci/trunk/src/gfx/drivers/dx_driver.cpp 2006-02-21 21:20:19 UTC (rev 
1563)
@@ -47,10 +47,14 @@
 
 #include <graphics_directx.h>
 
+#define TO_STRING2(x) #x
+#define TO_STRING(x) TO_STRING2(x)
 #if (DIRECT3D_VERSION < 0x0800)
-#      error ERROR: DirectX 8 or higher is required for this driver.
-#elseif (DIRECT3D_VERSION > 0x0800)
-#      warning This driver has been developed against the DirectX 8 SDK and 
may not work against this version DIRECT3D_VERSION
+#      error The DirectX 8 SDK (or higher) is required for this driver.
+#elif (DIRECT3D_VERSION > 0x0800)
+#      pragma message (" ")
+#      pragma message ("*** This driver has been developed against version 8 
of the DirectX SDK and may not work against your version " 
TO_STRING(DIRECT3D_VERSION))
+#      pragma message (" ")
 #endif