README.iphoneos
author Holmes Futrell <hfutrell@umail.ucsb.edu>
Fri, 15 Aug 2008 23:48:49 +0000
branchgsoc2008_iphone
changeset 2441 ed6a41cc2bce
child 2459 c330dcd78e3a
permissions -rw-r--r--
Elaborated on features and limitations of SDL for iPhone. renamed and moved readme with all the other readmes.
hfutrell@2441
     1
==============================================================================
hfutrell@2441
     2
Building the Simple DirectMedia Layer for iPhone OS 2.0
hfutrell@2441
     3
==============================================================================
hfutrell@2441
     4
hfutrell@2441
     5
Requirements: Mac OS X v10.5 or later and the iPhone SDK.
hfutrell@2441
     6
hfutrell@2441
     7
To build SDL for iPhone, simply open the XCode Project (XCodeiPhoneOS/SDL/SDLiPhoneOS.xcodeproj), select the target you wish to build, and hit 'build'.  You can also build in a CLI environment using the xcodebuild command line tool, if you wish. 
hfutrell@2441
     8
hfutrell@2441
     9
There are three build targets:
hfutrell@2441
    10
- StaticLibiPhoneOS:
hfutrell@2441
    11
	Build SDL as a statically linked (armv6) library for iPhone OS 2.0.
hfutrell@2441
    12
- StaticLibSimulator:
hfutrell@2441
    13
	Build SDL as a statically linked (x86) library for the iPhone Simulator
hfutrell@2441
    14
- Template:
hfutrell@2441
    15
	Package a project template together with the SDL for iPhone static libraries and copies of the SDL headers.  The template includes proper references to the SDL library, skeleton code for a basic SDL program, and placeholder graphics for the application icon and startup screen.
hfutrell@2441
    16
hfutrell@2441
    17
Be advised that you'll most likely need to build both StaticLibiPhoneOS.a and StaticLibSimulator.a before you compile any projects that use SDL for iPhone.
hfutrell@2441
    18
hfutrell@2441
    19
==============================================================================
hfutrell@2441
    20
Using the Simple DirectMedia Layer for iPhone OS 2.0
hfutrell@2441
    21
==============================================================================
hfutrell@2441
    22
hfutrell@2441
    23
Here's probably the easiest method:
hfutrell@2441
    24
1.  Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and the iPhone SDL Application template.
hfutrell@2441
    25
1.  Install the iPhone SDL Application template (recommended directory is /Developer/Platforms/iPhoneOS.platform/Developer/Library/XCode/Project Templates/SDL Application/)
hfutrell@2441
    26
2.  Start a new project using the template (SDL will be automatically included in your project)
hfutrell@2441
    27
hfutrell@2441
    28
Here's a more manual method:
hfutrell@2441
    29
1.  Create a new iPhone project
hfutrell@2441
    30
2.  Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and include them in your project.  XCode will ignore the library that is not currently of the correct architecture, hence your app will work both on iPhone and in the iPhone Simulator.
hfutrell@2441
    31
3.  include the SDL header files in your project.
hfutrell@2441
    32
4.  Remove main.m and replace it with a new main.m (or main.c) which is coded like a normal SDL program.  To replace main.m with a main.c, you must tell XCode not to use the project prefix file, which includes references to Cocoa Touch.
hfutrell@2441
    33
hfutrell@2441
    34
==============================================================================
hfutrell@2441
    35
Notes -- Touch Input
hfutrell@2441
    36
==============================================================================
hfutrell@2441
    37
hfutrell@2441
    38
Touch input in SDL for iPhone OS is presently exposed through SDL's mouse input API.  Multi-touch input is reported as multiple mice, with each touch associated with a specific mouse.  This association stays coherent from the time the touch starts to the time a touch ends.
hfutrell@2441
    39
hfutrell@2441
    40
By default, multi-touch is turned ON.  This requires some care, because if you simply respond to mouse events without checking which mouse caused the event, you may end up fetching data from the wrong mouse, ie, an incorrect or invalid touch.  To turn multi-touch OFF, you can recompile SDL for iPhone with the macro SDL_IPHONE_MULTIPLE_MICE (found in SDL_config_iphoneos.h) set to 0.
hfutrell@2441
    41
hfutrell@2441
    42
==============================================================================
hfutrell@2441
    43
Notes -- Accelerometer as Joystick
hfutrell@2441
    44
==============================================================================
hfutrell@2441
    45
hfutrell@2441
    46
SDL for iPhone supports polling the built in accelerometer as a joystick device.  For an example on how to do this, see the accelerometer.c in the demos directory.
hfutrell@2441
    47
hfutrell@2441
    48
The main thing to note when using the accelerometer with SDL is that while the iPhone natively reports accelerometer as floating point values in units of g-force, SDL_JoystickGetAxis reports joystick values as signed integers.  Hence, in order to convert between the two, some clamping and scaling is necessary on the part of the iPhone SDL joystick driver.  To convert SDL_JoystickGetAxis reported values BACK to units of g-force, simply multiply the values by SDL_IPHONE_MAX_GFORCE / 0x7FFF.
hfutrell@2441
    49
hfutrell@2441
    50
==============================================================================
hfutrell@2441
    51
Notes -- OpenGL ES
hfutrell@2441
    52
==============================================================================
hfutrell@2441
    53
hfutrell@2441
    54
Your SDL application for iPhone uses OpenGL ES by default.
hfutrell@2441
    55
hfutrell@2441
    56
OpenGL ES for iPhone supports two display pixel formats, RGBA8 and RGB565.  By default, the implementation uses RGB565, but you may use RGBA8 by setting each color component to 8 bits in SDL_GL_SetAttribute.
hfutrell@2441
    57
hfutrell@2441
    58
If your application doesn't use the depth buffer, you may also find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
hfutrell@2441
    59
hfutrell@2441
    60
Finally, if your application completely redraws the screen each from, you may find significant performance improvement by setting the attribute SDL_GL_RETAINED_BACKING to 1.
hfutrell@2441
    61
hfutrell@2441
    62
==============================================================================
hfutrell@2441
    63
Notes -- Keyboard
hfutrell@2441
    64
==============================================================================
hfutrell@2441
    65
hfutrell@2441
    66
SDL for iPhone contains several additional functions related to keyboard functionality.  These functions are not part of the SDL standard API, but are necessary for revealing and hiding the iPhone's virtual onscreen keyboard.  You can use them in your own applications by including a copy of the SDL_uikitkeyboard.h header in your project.
hfutrell@2441
    67
hfutrell@2441
    68
int SDL_iPhoneKeyboardShow(SDL_WindowID windowID) 
hfutrell@2441
    69
	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    70
int SDL_iPhoneKeyboardHide(SDL_WindowID windowID) 
hfutrell@2441
    71
	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    72
SDL_bool SDL_iPhoneKeyboardIsShown(SDL_WindowID windowID) 
hfutrell@2441
    73
	-- returns whether or not the onscreen keyboard is currently visible.
hfutrell@2441
    74
int SDL_iPhoneKeyboardToggle(SDL_WindowID windowID) 	
hfutrell@2441
    75
	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    76
hfutrell@2441
    77
==============================================================================
hfutrell@2441
    78
Notes -- Reading and Writing files
hfutrell@2441
    79
==============================================================================
hfutrell@2441
    80
hfutrell@2441
    81
Each application installed on iPhone resides in a sandbox which includes its own Application Home directory.  For each installed application, the system generates a unique name for the application home director, which appears as a long, incomprehensible string of numbers.
hfutrell@2441
    82
hfutrell@2441
    83
Once your application is installed, the directory tree looks like:
hfutrell@2441
    84
hfutrell@2441
    85
MySDLApp Home/
hfutrell@2441
    86
	MySDLApp.app
hfutrell@2441
    87
	Documents/
hfutrell@2441
    88
	Library/
hfutrell@2441
    89
		Preferences/
hfutrell@2441
    90
	tmp/
hfutrell@2441
    91
hfutrell@2441
    92
When your SDL based iPhone application starts up, it sets the working directory to the main bundle (MySDLApp Home/MySDLApp.app), where your application resources are stored.  You cannot write to this directory, however -- instead, I advise you to write document files to "../Documents/" and preferences to "../Library/Preferences".  
hfutrell@2441
    93
hfutrell@2441
    94
More information on this subject is available here:
hfutrell@2441
    95
http://developer.apple.com/iphone/library/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/ApplicationEnvironment/chapter_6_section_3.html#//apple_ref/doc/uid/TP40007072-CH7-SW21
hfutrell@2441
    96
hfutrell@2441
    97
==============================================================================
hfutrell@2441
    98
Notes -- iPhone SDL limitations
hfutrell@2441
    99
==============================================================================
hfutrell@2441
   100
hfutrell@2441
   101
Windows:
hfutrell@2441
   102
	Full-size, single window applications only.  You cannot create multi-window SDL applications for iPhone OS.  The application window will fill the display, though you have the option of turning on or off the menu-bar (pass SDL_CreateWindow the flag SDL_WINDOW_BORDERLESS).  Presently, landscape mode is not supported.
hfutrell@2441
   103
hfutrell@2441
   104
Video:
hfutrell@2441
   105
	For real time frame-rates, you are advised to use strictly SDL 1.3 video calls.  Using compatibility video calls uploads an OpenGL texture for each frame drawn, and this operation is excruciatingly slow.
hfutrell@2441
   106
hfutrell@2441
   107
Textures:
hfutrell@2441
   108
	SDL for iPhone Textures supports only SDL_PIXELFORMAT_ABGR8888 and SDL_PIXELFORMAT_RGB24 pixel formats.  This is because texture support in SDL for iPhone is done through OpenGL ES, which supports fewer pixel formats than OpenGL, will not re-order pixel data for you, and has no support for color-paletted formats (without extensions).
hfutrell@2441
   109
hfutrell@2441
   110
Audio:
hfutrell@2441
   111
	SDL for iPhone does not yet support audio input.
hfutrell@2441
   112
hfutrell@2441
   113
Loading Shared Objects:
hfutrell@2441
   114
	This is disabled by default since it seems to break the terms of the iPhone SDK agreement.  It can be re-enabled in SDL_config_iphoneos.h.
hfutrell@2441
   115
hfutrell@2441
   116
hfutrell@2441
   117