README.RISCOS
author Patrice Mandin <patmandin@gmail.com>
Mon, 06 Nov 2017 20:32:27 +0100
branchSDL-1.2
changeset 11692 bff3a6018318
parent 1332 de3d552b59b2
child 3244 7c73d5b5a0d6
child 13054 d07097a0e57e
permissions -rw-r--r--
atari:gem: NOVA does not provide screen format, hardcode it
slouken@955
     1
Readme for RISC OS port of SDL
slouken@955
     2
==============================
slouken@955
     3
slouken@1332
     4
This document last updated on 2nd Februrary 2006
slouken@955
     5
slouken@1035
     6
This is a RISC OS port of the Simple Direct Media Layer (SDL) by Alan Buckley with contributions from Peter Naulls.
slouken@955
     7
slouken@955
     8
Details of the SDL can be found at http://www.libsdl.org.
slouken@955
     9
slouken@1332
    10
The source code including the RISC OS version can be obtained from:
slouken@1332
    11
slouken@1035
    12
http://www.libsdl.org.
slouken@955
    13
slouken@1332
    14
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/.
slouken@955
    15
slouken@955
    16
This is released under the LGPL see the file COPYING for details.
slouken@955
    17
slouken@955
    18
slouken@1332
    19
Compiling applications under RISC OS
slouken@1332
    20
====================================
slouken@1332
    21
slouken@1332
    22
Add -ISDL: for the C compiler flags if you include the files in the SDL directory. e.g. #include "SDL/SDL.h"
slouken@1332
    23
Add -ISDL:SDL for the C compiler flags if you include the files directly. e.g. #include "SDL/SDL.h"
slouken@1332
    24
slouken@1332
    25
Add -LSDL: -lSDL to the link stage of compilation.
slouken@1332
    26
slouken@1332
    27
For example, to compile the testbitmap.c sample you could use:
slouken@1332
    28
slouken@1332
    29
gcc -ISDL:SDL -LSDL: -lSDL testbitmap.c -otestbitmap
slouken@1332
    30
slouken@1332
    31
slouken@1035
    32
RISC OS port of SDL runtime information
slouken@1332
    33
=======================================
slouken@955
    34
slouken@955
    35
Runtime requirements
slouken@955
    36
--------------------
slouken@955
    37
slouken@1035
    38
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.
slouken@955
    39
slouken@1035
    40
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
slouken@1035
    41
web site: http://home.t-online.de/~zarquon
slouken@1035
    42
This is loaded when needed by UnixLib.
slouken@955
    43
slouken@1035
    44
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.
slouken@955
    45
slouken@955
    46
slouken@1035
    47
RISC OS runtime parameters
slouken@1332
    48
--------------------------
slouken@955
    49
slouken@1035
    50
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).
slouken@955
    51
slouken@955
    52
They are all defined on an application basis.
slouken@955
    53
slouken@955
    54
The <appname> used below is found as follows:
slouken@955
    55
1. Use the name of the program unless it is !RunImage
slouken@955
    56
2. Check the folder specification for the folder !RunImage is run from. If it is a folder name use that name, otherwise if it is an environmental variable of the form <XXX$Dir> use the value of XXX.
slouken@955
    57
slouken@955
    58
The variables are:
slouken@955
    59
slouken@1332
    60
SDL$<appname>$TaskName
slouken@955
    61
slouken@1332
    62
The name of the task for RISC OS. If omitted then <appname> is used for the task name,
slouken@1332
    63
slouken@1332
    64
SDL$<appname>$BackBuffer
slouken@1332
    65
slouken@1332
    66
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.
slouken@1332
    67
slouken@1332
    68
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.
slouken@1332
    69
slouken@1332
    70
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.
slouken@955
    71
slouken@955
    72
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.
slouken@955
    73
slouken@955
    74
slouken@1035
    75
RISC OS SDL port API notes
slouken@1332
    76
==========================
slouken@955
    77
slouken@955
    78
Current level of implementation
slouken@955
    79
-------------------------------
slouken@955
    80
slouken@955
    81
The following list is an overview of how much of the SDL is implemented. The areas match the main areas of the SDL.
slouken@955
    82
slouken@1035
    83
video - Mostly done. Doesn't cover gamma, YUV-overlay or OpenGL.
slouken@955
    84
Window Manager - Mostly done. SetIcon/IconifyWindow not implemented.
slouken@955
    85
Events - Mostly done. Resize and some joystick events missing.
slouken@955
    86
Joystick - Currently assumes a single joystick with 4 buttons.
slouken@1035
    87
Audio - Done
slouken@955
    88
CDROM - Not implemented.
slouken@955
    89
Threads - Done
slouken@955
    90
Timers - Done
slouken@955
    91
slouken@955
    92
Thread support can be removed by defining DISABLE_THREADS and recompiling the library.
slouken@955
    93
slouken@955
    94
SDL API notes
slouken@955
    95
-------------
slouken@955
    96
slouken@955
    97
This section contains additional notes on some specific commands.
slouken@955
    98
slouken@955
    99
SDL_SetVideoMode
slouken@1035
   100
  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.
slouken@955
   101
  Open GL is not supported so SDL_OPENGL and SDL_OPENGLBLIT flags fail.
slouken@955
   102
  SDL_RESIZEABLE and SDL_NOFRAME flags are not supported.
slouken@955
   103
slouken@955
   104
SDL_SetColors
slouken@1035
   105
  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.
slouken@955
   106
slouken@955
   107
SDL_CreateCursor
slouken@955
   108
   Inverted colour is not supported.
slouken@955
   109
slouken@955
   110
SDL_WM_ToggleFullScreen
slouken@955
   111
   Currently this won't work if the application starts up in Fullscreen mode.
slouken@955
   112
   Toggling to fullscreen will only work if the monitor is set up to support the exact screen size requested.
slouken@955
   113
slouken@955
   114
SDL_EnableUNICODE
slouken@955
   115
   Unicode translation used here is only really accurate for 7 bit characters.
slouken@955
   116
slouken@955
   117
SDL_NumJoysticks/JoystickName etc.
slouken@955
   118
   Hardcoded to expect only 1 joystick with 4 buttons if the Joystick module is loaded.
slouken@955
   119
slouken@955
   120
SDL_GetTicks
slouken@955
   121
   Timer used has only a centisecond accuracy. This applies to other time related functions.
slouken@955
   122
   
slouken@955
   123
SDL_Delay
slouken@955
   124
   Modified to poll keyboard/mouse during the delay on the event thread.
slouken@955
   125
slouken@955
   126
slouken@955
   127
Notes on current implementation
slouken@955
   128
-------------------------------
slouken@955
   129
slouken@955
   130
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.