README.iphoneos
author Holmes Futrell <hfutrell@umail.ucsb.edu>
Mon, 18 Aug 2008 19:39:08 +0000
branchgsoc2008_iphone
changeset 2467 058e1f140ff3
parent 2465 f429ccf8e35f
permissions -rw-r--r--
Fixed problem where creating the view passed NULL as the context for setting current context ... needed to actually pass the context.
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@2465
     7
Instructions:
hfutrell@2465
     8
1.  Open SDLiPhoneOS.xcodeproj (located in XCodeiPhoneOS/SDL) in XCode.
hfutrell@2465
     9
2.  Set Project->Set Active SDK to "Use Project Settings"
hfutrell@2465
    10
3.  Select your desired target, and hit build.
hfutrell@2441
    11
hfutrell@2441
    12
There are three build targets:
hfutrell@2441
    13
- StaticLibiPhoneOS:
hfutrell@2441
    14
	Build SDL as a statically linked (armv6) library for iPhone OS 2.0.
hfutrell@2441
    15
- StaticLibSimulator:
hfutrell@2441
    16
	Build SDL as a statically linked (x86) library for the iPhone Simulator
hfutrell@2441
    17
- Template:
hfutrell@2459
    18
	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 and headers, skeleton code for a basic SDL program, and placeholder graphics for the application icon and startup screen.
hfutrell@2441
    19
hfutrell@2441
    20
==============================================================================
hfutrell@2441
    21
Using the Simple DirectMedia Layer for iPhone OS 2.0
hfutrell@2441
    22
==============================================================================
hfutrell@2441
    23
hfutrell@2459
    24
Here is the easiest method:
hfutrell@2441
    25
1.  Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and the iPhone SDL Application template.
hfutrell@2459
    26
1.  Install the iPhone SDL Application template by copying it to one of XCode's template directories.  I recommend creating a directory called "SDL" in "/Developer/Platforms/iPhoneOS.platform/Developer/Library/XCode/Project Templates/" and placing it there.
hfutrell@2459
    27
2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
hfutrell@2441
    28
hfutrell@2459
    29
Here is a more manual method:
hfutrell@2459
    30
1.  Create a new iPhone view based application.
hfutrell@2459
    31
2.  Build the SDL static libraries (libSDLiPhoneOS.a and libSDLSimulator.a) for iPhone 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@2459
    32
3.  Include the SDL header files in your project.
hfutrell@2459
    33
4.  Remove the ApplicationDelegate.h and ApplicationDelegate.m files -- SDL for iPhone provides its own UIApplicationDelegate.  Remove MainWindow.xib -- SDL for iPhone produces its user interface programmatically.
hfutrell@2459
    34
5.  Delete the contents of main.m and program your app as a regular SDL program instead.  You may replace main.m with your own main.c, but you must tell XCode not to use the project prefix file, as it includes Objective-C code.
hfutrell@2441
    35
hfutrell@2441
    36
==============================================================================
hfutrell@2441
    37
Notes -- Touch Input
hfutrell@2441
    38
==============================================================================
hfutrell@2441
    39
hfutrell@2441
    40
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
    41
hfutrell@2459
    42
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, from 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
    43
hfutrell@2441
    44
==============================================================================
hfutrell@2441
    45
Notes -- Accelerometer as Joystick
hfutrell@2441
    46
==============================================================================
hfutrell@2441
    47
hfutrell@2441
    48
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
    49
hfutrell@2441
    50
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
    51
hfutrell@2441
    52
==============================================================================
hfutrell@2441
    53
Notes -- OpenGL ES
hfutrell@2441
    54
==============================================================================
hfutrell@2441
    55
hfutrell@2459
    56
Your SDL application for iPhone uses OpenGL ES for video by default.
hfutrell@2441
    57
hfutrell@2459
    58
OpenGL ES for iPhone supports two display pixel formats, RGBA8 and RGB565, which provide a 32 bit and 16 bit color buffer respectively.  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
    59
hfutrell@2459
    60
If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
hfutrell@2441
    61
hfutrell@2459
    62
Finally, if your application completely redraws the screen each frame, you may find significant performance improvement by setting the attribute SDL_GL_RETAINED_BACKING to 1.
hfutrell@2441
    63
hfutrell@2441
    64
==============================================================================
hfutrell@2441
    65
Notes -- Keyboard
hfutrell@2441
    66
==============================================================================
hfutrell@2441
    67
hfutrell@2459
    68
SDL for iPhone contains several additional functions related to keyboard visibility.  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 (located in src/video/uikit) in your project.
hfutrell@2441
    69
hfutrell@2441
    70
int SDL_iPhoneKeyboardShow(SDL_WindowID windowID) 
hfutrell@2441
    71
	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    72
int SDL_iPhoneKeyboardHide(SDL_WindowID windowID) 
hfutrell@2441
    73
	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    74
SDL_bool SDL_iPhoneKeyboardIsShown(SDL_WindowID windowID) 
hfutrell@2441
    75
	-- returns whether or not the onscreen keyboard is currently visible.
hfutrell@2441
    76
int SDL_iPhoneKeyboardToggle(SDL_WindowID windowID) 	
hfutrell@2441
    77
	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
hfutrell@2441
    78
hfutrell@2441
    79
==============================================================================
hfutrell@2441
    80
Notes -- Reading and Writing files
hfutrell@2441
    81
==============================================================================
hfutrell@2441
    82
hfutrell@2459
    83
Each application installed on iPhone resides in a sandbox which includes its own Application Home directory.  Your application may not access files outside this directory.
hfutrell@2441
    84
hfutrell@2459
    85
Once your application is installed its directory tree looks like:
hfutrell@2441
    86
hfutrell@2441
    87
MySDLApp Home/
hfutrell@2441
    88
	MySDLApp.app
hfutrell@2441
    89
	Documents/
hfutrell@2441
    90
	Library/
hfutrell@2441
    91
		Preferences/
hfutrell@2441
    92
	tmp/
hfutrell@2441
    93
hfutrell@2459
    94
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.  Instead, I advise you to write document files to "../Documents/" and preferences to "../Library/Preferences".  
hfutrell@2441
    95
hfutrell@2441
    96
More information on this subject is available here:
hfutrell@2441
    97
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
    98
hfutrell@2441
    99
==============================================================================
hfutrell@2441
   100
Notes -- iPhone SDL limitations
hfutrell@2441
   101
==============================================================================
hfutrell@2441
   102
hfutrell@2441
   103
Windows:
hfutrell@2441
   104
	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
   105
hfutrell@2441
   106
Video:
hfutrell@2441
   107
	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
   108
hfutrell@2441
   109
Textures:
hfutrell@2441
   110
	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
   111
hfutrell@2441
   112
Audio:
hfutrell@2441
   113
	SDL for iPhone does not yet support audio input.
hfutrell@2441
   114
hfutrell@2441
   115
Loading Shared Objects:
hfutrell@2441
   116
	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
   117
hfutrell@2441
   118
hfutrell@2441
   119