README.iphoneos
author Holmes Futrell <hfutrell@umail.ucsb.edu>
Mon, 18 Aug 2008 18:01:24 +0000
branchgsoc2008_iphone
changeset 2459 c330dcd78e3a
parent 2441 ed6a41cc2bce
child 2465 f429ccf8e35f
permissions -rw-r--r--
Grammar, spelling, clarity.
     1 ==============================================================================
     2 Building the Simple DirectMedia Layer for iPhone OS 2.0
     3 ==============================================================================
     4 
     5 Requirements: Mac OS X v10.5 or later and the iPhone SDK.
     6 
     7 To build SDL for iPhone, just 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. 
     8 
     9 There are three build targets:
    10 - StaticLibiPhoneOS:
    11 	Build SDL as a statically linked (armv6) library for iPhone OS 2.0.
    12 - StaticLibSimulator:
    13 	Build SDL as a statically linked (x86) library for the iPhone Simulator
    14 - Template:
    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 and headers, skeleton code for a basic SDL program, and placeholder graphics for the application icon and startup screen.
    16 
    17 ==============================================================================
    18 Using the Simple DirectMedia Layer for iPhone OS 2.0
    19 ==============================================================================
    20 
    21 Here is the easiest method:
    22 1.  Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and the iPhone SDL Application template.
    23 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.
    24 2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
    25 
    26 Here is a more manual method:
    27 1.  Create a new iPhone view based application.
    28 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.
    29 3.  Include the SDL header files in your project.
    30 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.
    31 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.
    32 
    33 ==============================================================================
    34 Notes -- Touch Input
    35 ==============================================================================
    36 
    37 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.
    38 
    39 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.
    40 
    41 ==============================================================================
    42 Notes -- Accelerometer as Joystick
    43 ==============================================================================
    44 
    45 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.
    46 
    47 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.
    48 
    49 ==============================================================================
    50 Notes -- OpenGL ES
    51 ==============================================================================
    52 
    53 Your SDL application for iPhone uses OpenGL ES for video by default.
    54 
    55 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.
    56 
    57 If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
    58 
    59 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.
    60 
    61 ==============================================================================
    62 Notes -- Keyboard
    63 ==============================================================================
    64 
    65 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.
    66 
    67 int SDL_iPhoneKeyboardShow(SDL_WindowID windowID) 
    68 	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
    69 int SDL_iPhoneKeyboardHide(SDL_WindowID windowID) 
    70 	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
    71 SDL_bool SDL_iPhoneKeyboardIsShown(SDL_WindowID windowID) 
    72 	-- returns whether or not the onscreen keyboard is currently visible.
    73 int SDL_iPhoneKeyboardToggle(SDL_WindowID windowID) 	
    74 	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
    75 
    76 ==============================================================================
    77 Notes -- Reading and Writing files
    78 ==============================================================================
    79 
    80 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.
    81 
    82 Once your application is installed its directory tree looks like:
    83 
    84 MySDLApp Home/
    85 	MySDLApp.app
    86 	Documents/
    87 	Library/
    88 		Preferences/
    89 	tmp/
    90 
    91 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".  
    92 
    93 More information on this subject is available here:
    94 http://developer.apple.com/iphone/library/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/ApplicationEnvironment/chapter_6_section_3.html#//apple_ref/doc/uid/TP40007072-CH7-SW21
    95 
    96 ==============================================================================
    97 Notes -- iPhone SDL limitations
    98 ==============================================================================
    99 
   100 Windows:
   101 	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.
   102 
   103 Video:
   104 	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.
   105 
   106 Textures:
   107 	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).
   108 
   109 Audio:
   110 	SDL for iPhone does not yet support audio input.
   111 
   112 Loading Shared Objects:
   113 	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.
   114 
   115 
   116