README.RISCOS
changeset 1332 de3d552b59b2
parent 1035 974ba6ae0fa3
child 3244 7c73d5b5a0d6
child 13054 d07097a0e57e
     1.1 --- a/README.RISCOS	Mon Feb 06 08:46:14 2006 +0000
     1.2 +++ b/README.RISCOS	Mon Feb 06 08:47:44 2006 +0000
     1.3 @@ -1,22 +1,36 @@
     1.4  Readme for RISC OS port of SDL
     1.5  ==============================
     1.6  
     1.7 -This document last updated on 26th January 2005
     1.8 +This document last updated on 2nd Februrary 2006
     1.9  
    1.10  This is a RISC OS port of the Simple Direct Media Layer (SDL) by Alan Buckley with contributions from Peter Naulls.
    1.11  
    1.12  Details of the SDL can be found at http://www.libsdl.org.
    1.13  
    1.14 -The source code including the RISC OS version can be obtained from
    1.15 +The source code including the RISC OS version can be obtained from:
    1.16 +
    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 +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.riscos.info/unix/.
    1.21  
    1.22  This is released under the LGPL see the file COPYING for details.
    1.23  
    1.24  
    1.25 +Compiling applications under RISC OS
    1.26 +====================================
    1.27 +
    1.28 +Add -ISDL: for the C compiler flags if you include the files in the SDL directory. e.g. #include "SDL/SDL.h"
    1.29 +Add -ISDL:SDL for the C compiler flags if you include the files directly. e.g. #include "SDL/SDL.h"
    1.30 +
    1.31 +Add -LSDL: -lSDL to the link stage of compilation.
    1.32 +
    1.33 +For example, to compile the testbitmap.c sample you could use:
    1.34 +
    1.35 +gcc -ISDL:SDL -LSDL: -lSDL testbitmap.c -otestbitmap
    1.36 +
    1.37 +
    1.38  RISC OS port of SDL runtime information
    1.39 -======================================
    1.40 +=======================================
    1.41  
    1.42  Runtime requirements
    1.43  --------------------
    1.44 @@ -31,7 +45,7 @@
    1.45  
    1.46  
    1.47  RISC OS runtime parameters
    1.48 --------------------------
    1.49 +--------------------------
    1.50  
    1.51  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.52  
    1.53 @@ -43,18 +57,23 @@
    1.54  
    1.55  The variables are:
    1.56  
    1.57 -SDL$<appname>$TaskName - The name of the task for RISC OS. If omitted then <appname> is used for the task name,
    1.58 +SDL$<appname>$TaskName
    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 RISC OS implementation uses direct writes to the screen if a hardware fullscreen is requested.
    1.61 +The name of the task for RISC OS. If omitted then <appname> is used for the task name,
    1.62 +
    1.63 +SDL$<appname>$BackBuffer
    1.64 +
    1.65 +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.66 +
    1.67 +Set to 2 to use an ARM code full word copy. This is faster than the standard back buffer, but uses aligned words only so it is possible (but unlikely) for it to corrupt the screen for 8bpp and 16bpp modes.
    1.68 +
    1.69 +Set to 3 to use a RISC OS sprite as the back buffer. This is usually the slowest for most SDL applications, however it may be useful in the future as Sprite acceleration is added to various hardware that runs RISC OS.
    1.70  
    1.71  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.72  
    1.73 -SDL$<appname>$AudioBuffer - set the minimum size of the audio buffer in samples in steps of 512. If this is less than the minimum calculated from the parameters requested in the program by SDL_OpenAudio these will be used instead. If this parameter is not used or set to 0 the buffer size will be calculated to buffer 10 centisecond of sound. The time buffered can be calculated as specified size/frequency in seconds. The larger the buffer the more audio data that will be buffered, but this can lead to a lag between a sound being requested and it being heard, so the size should be kept to a minimum. You should only set this parameter if the sound is being missed out. 
    1.74 -
    1.75 -
    1.76  
    1.77  RISC OS SDL port API notes
    1.78 -=========================
    1.79 +==========================
    1.80  
    1.81  Current level of implementation
    1.82  -------------------------------