README.iOS
author Sam Lantinga <slouken@libsdl.org>
Thu, 05 Jan 2012 21:41:55 -0500
changeset 6159 fb6f363032fd
parent 4689 README.iphoneos@f9ab8df6d45a
child 6251 3e8c673cad58
permissions -rw-r--r--
Updated iOS projects and renamed iPhoneOS to iOS
slouken@2765
     1
==============================================================================
slouken@2765
     2
Building the Simple DirectMedia Layer for iPhone OS 2.0
slouken@2765
     3
==============================================================================
slouken@2765
     4
slouken@2765
     5
Requirements: Mac OS X v10.5 or later and the iPhone SDK.
slouken@2765
     6
slouken@2765
     7
Instructions:
slouken@6159
     8
1.  Open SDL.xcodeproj (located in Xcode-iOS/SDL) in XCode.
slouken@6159
     9
2.  Select your desired target, and hit build.
slouken@2765
    10
slouken@2765
    11
There are three build targets:
slouken@6159
    12
- libSDL.a:
slouken@6159
    13
	Build SDL as a statically linked library
slouken@6159
    14
- testsdl
slouken@6159
    15
	Build a test program (there are known test failures which are fine)
slouken@2765
    16
- Template:
slouken@2765
    17
	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.
slouken@2765
    18
slouken@2765
    19
==============================================================================
slouken@6159
    20
Using the Simple DirectMedia Layer for iOS
slouken@2765
    21
==============================================================================
slouken@2765
    22
slouken@6159
    23
FIXME: This needs to be updated for the latest methods
slouken@6159
    24
slouken@2765
    25
Here is the easiest method:
slouken@6159
    26
1.  Build the SDL libraries (libSDL.a and libSDLSimulator.a) and the iPhone SDL Application template.
slouken@6159
    27
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/iOS.platform/Developer/Library/XCode/Project Templates/" and placing it there.
slouken@2765
    28
2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
slouken@2765
    29
slouken@2765
    30
Here is a more manual method:
slouken@2765
    31
1.  Create a new iPhone view based application.
slouken@6159
    32
2.  Build the SDL static libraries (libSDL.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.
slouken@2765
    33
3.  Include the SDL header files in your project.
slouken@2765
    34
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.
slouken@2765
    35
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.
slouken@2765
    36
slouken@2765
    37
==============================================================================
slouken@2765
    38
Notes -- Accelerometer as Joystick
slouken@2765
    39
==============================================================================
slouken@2765
    40
slouken@2765
    41
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.
slouken@2765
    42
slouken@2765
    43
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.
slouken@2765
    44
slouken@2765
    45
==============================================================================
slouken@2765
    46
Notes -- OpenGL ES
slouken@2765
    47
==============================================================================
slouken@2765
    48
slouken@2765
    49
Your SDL application for iPhone uses OpenGL ES for video by default.
slouken@2765
    50
slouken@4666
    51
OpenGL ES for iPhone supports several display pixel formats, such as 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.
slouken@2765
    52
slouken@2765
    53
If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
slouken@2765
    54
slouken@2765
    55
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.
slouken@2765
    56
slouken@2765
    57
==============================================================================
slouken@2765
    58
Notes -- Keyboard
slouken@2765
    59
==============================================================================
slouken@2765
    60
slouken@2765
    61
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.
slouken@2765
    62
slouken@3685
    63
int SDL_iPhoneKeyboardShow(SDL_Window * window) 
slouken@2765
    64
	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@3685
    65
int SDL_iPhoneKeyboardHide(SDL_Window * window) 
slouken@2765
    66
	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@3685
    67
SDL_bool SDL_iPhoneKeyboardIsShown(SDL_Window * window) 
slouken@2765
    68
	-- returns whether or not the onscreen keyboard is currently visible.
slouken@3685
    69
int SDL_iPhoneKeyboardToggle(SDL_Window * window) 	
slouken@2765
    70
	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@2765
    71
slouken@2765
    72
==============================================================================
slouken@2765
    73
Notes -- Reading and Writing files
slouken@2765
    74
==============================================================================
slouken@2765
    75
slouken@2765
    76
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.
slouken@2765
    77
slouken@2765
    78
Once your application is installed its directory tree looks like:
slouken@2765
    79
slouken@2765
    80
MySDLApp Home/
slouken@2765
    81
	MySDLApp.app
slouken@2765
    82
	Documents/
slouken@2765
    83
	Library/
slouken@2765
    84
		Preferences/
slouken@2765
    85
	tmp/
slouken@2765
    86
slouken@2765
    87
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".  
slouken@2765
    88
slouken@2765
    89
More information on this subject is available here:
slouken@6159
    90
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
slouken@2765
    91
slouken@2765
    92
==============================================================================
slouken@2765
    93
Notes -- iPhone SDL limitations
slouken@2765
    94
==============================================================================
slouken@2765
    95
slouken@2765
    96
Windows:
slouken@2765
    97
	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.
slouken@2765
    98
slouken@2765
    99
Video:
slouken@2765
   100
	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.
slouken@2765
   101
slouken@2765
   102
Textures:
slouken@2765
   103
	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).
slouken@2765
   104
slouken@2765
   105
Audio:
slouken@2765
   106
	SDL for iPhone does not yet support audio input.
slouken@2765
   107
slouken@2765
   108
Loading Shared Objects:
slouken@2765
   109
	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.
slouken@2765
   110