README.RISCOS
changeset 1035 974ba6ae0fa3
parent 955 d74fbf56f2f6
child 1332 de3d552b59b2
     1.1 --- a/README.RISCOS	Sat Jan 29 09:58:40 2005 +0000
     1.2 +++ b/README.RISCOS	Sat Feb 12 18:01:31 2005 +0000
     1.3 @@ -1,37 +1,39 @@
     1.4  Readme for RISC OS port of SDL
     1.5  ==============================
     1.6  
     1.7 -This document last updated on 25th June 2004
     1.8 +This document last updated on 26th January 2005
     1.9  
    1.10 -This is a RISC OS port of the Simple Direct Media Layer (SDL) by Alan Buckley.
    1.11 +This is a RISC OS port of the Simple Direct Media Layer (SDL) by Alan Buckley with contributions from Peter Naulls.
    1.12  
    1.13  Details of the SDL can be found at http://www.libsdl.org.
    1.14  
    1.15 -The source code including the RISC OS version can be obtained from http://www.libsdl.org.
    1.16 +The source code including the RISC OS version can be obtained from
    1.17 +http://www.libsdl.org.
    1.18  
    1.19  RISC OS makefiles, pre built libraries and many games and applications compiled for RISC OS using this library can be downloaded from The Unix Porting Project at http://www.chocky.org/unix/index.html.
    1.20  
    1.21  This is released under the LGPL see the file COPYING for details.
    1.22  
    1.23  
    1.24 -RISCOS port of SDL runtime information
    1.25 +RISC OS port of SDL runtime information
    1.26  ======================================
    1.27  
    1.28  Runtime requirements
    1.29  --------------------
    1.30  
    1.31 -This library currently needs a minimum of RISCOS 3.6. The source code for the library (and a lot of the programs built with it) also need long file names.
    1.32 +This library currently needs a minimum of RISC OS 3.6. The source code for the library (and a lot of the programs built with it) also need long file names.
    1.33  
    1.34 -To use the audio you also need 16 bit sound and to have installed the Digital Render module by Andreas Dehmel version 0.51 available from his web site:
    1.35 -  http://home.t-online.de/~zarquon
    1.36 +To use the audio you also need 16 bit sound and to have installed the DigitalRender module by Andreas Dehmel version 0.51 available from his
    1.37 +web site: http://home.t-online.de/~zarquon
    1.38 +This is loaded when needed by UnixLib.
    1.39  
    1.40 -Note: As most programs ported from other OS's use high resolution graphics and a memory back buffer a machine with a StrongARM processor and 1 or 2MB of VRAM (or a better machine) is recomended.
    1.41 +Note: As most programs ported from other OSes use high resolution graphics and a memory back buffer a machine with a StrongARM processor and 1 or 2MB of VRAM (or a better machine) is recomended.
    1.42  
    1.43  
    1.44 -RISCOS runtime parameters
    1.45 +RISC OS runtime parameters
    1.46  -------------------------
    1.47  
    1.48 -Several environmental variables have been defined to make porting programs easier (i.e. By setting these variable you do not need to have source code differences between OS's).
    1.49 +Several environmental variables have been defined to make porting programs easier (i.e. By setting these variable you do not need to have source code differences between OSes).
    1.50  
    1.51  They are all defined on an application basis.
    1.52  
    1.53 @@ -41,9 +43,9 @@
    1.54  
    1.55  The variables are:
    1.56  
    1.57 -SDL$<appname>$TaskName - The name of the task for RISCOS. If omitted then <appname> is used for the task name,
    1.58 +SDL$<appname>$TaskName - The name of the task for RISC OS. If omitted then <appname> is used for the task name,
    1.59  
    1.60 -SDL$<appname>$BackBuffer - set to 1 to use a system memory back buffer for the screen in full screen mode. Some programs on other systems assume their is always a back buffer even though the SDL specification specifies this is not the case. The current RISCOS implementation uses direct writes to the screen if a hardware fullscreen is requested.
    1.61 +SDL$<appname>$BackBuffer - set to 1 to use a system memory back buffer for the screen in full screen mode. Some programs on other systems assume their is always a back buffer even though the SDL specification specifies this is not the case. The current RISC OS implementation uses direct writes to the screen if a hardware fullscreen is requested.
    1.62  
    1.63  SDL$<appname>$CloseAction - set the action for the close icon. Again as programs don't match the specification you can set this to 0 to remove the close icon from the main window for applications where this does not affect the program.
    1.64  
    1.65 @@ -51,7 +53,7 @@
    1.66  
    1.67  
    1.68  
    1.69 -RISCOS SDL port API notes
    1.70 +RISC OS SDL port API notes
    1.71  =========================
    1.72  
    1.73  Current level of implementation
    1.74 @@ -59,11 +61,11 @@
    1.75  
    1.76  The following list is an overview of how much of the SDL is implemented. The areas match the main areas of the SDL.
    1.77  
    1.78 -video - Mostly done. Doesn't cover gamma, YUV-overlay or open gl.
    1.79 +video - Mostly done. Doesn't cover gamma, YUV-overlay or OpenGL.
    1.80  Window Manager - Mostly done. SetIcon/IconifyWindow not implemented.
    1.81  Events - Mostly done. Resize and some joystick events missing.
    1.82  Joystick - Currently assumes a single joystick with 4 buttons.
    1.83 -Audio - Requires Digital Renderer module.
    1.84 +Audio - Done
    1.85  CDROM - Not implemented.
    1.86  Threads - Done
    1.87  Timers - Done
    1.88 @@ -76,12 +78,12 @@
    1.89  This section contains additional notes on some specific commands.
    1.90  
    1.91  SDL_SetVideoMode
    1.92 -  On RISCOS a fullscreen mode directly accesses the screen. This can be modified by the environmental variable (SDL$<appname>$BackBuffer) or by using the SDL_SWSURFACE flag to write to an offscreen buffer that is updated using SDL_UpdateRects.
    1.93 +  On RISC OS a fullscreen mode directly accesses the screen. This can be modified by the environmental variable (SDL$<appname>$BackBuffer) or by using the SDL_SWSURFACE flag to write to an offscreen buffer that is updated using SDL_UpdateRects.
    1.94    Open GL is not supported so SDL_OPENGL and SDL_OPENGLBLIT flags fail.
    1.95    SDL_RESIZEABLE and SDL_NOFRAME flags are not supported.
    1.96  
    1.97  SDL_SetColors
    1.98 -  In a wimp mode the screen colours are not changed for a hardware palette instead the RISCOS sprite colour mapping is used to get the best matching colours.
    1.99 +  In a wimp mode the screen colours are not changed for a hardware palette instead the RISC OS sprite colour mapping is used to get the best matching colours.
   1.100  
   1.101  SDL_CreateCursor
   1.102     Inverted colour is not supported.
   1.103 @@ -107,6 +109,3 @@
   1.104  -------------------------------
   1.105  
   1.106  Keyboard and mouse are polled so if too long a time is spent between a call to SDL_PumpEvents, functions that use it, or SDL_Delay events can be missed.
   1.107 -
   1.108 -The sound is sent to the digital renderer player in a seperate thread. If there is too long a delay between this thread being processed (possibly if a lot else is running in the Wimp) the sound may sound incorrect or dissappear.
   1.109 -