README.iOS
author Sam Lantinga <slouken@libsdl.org>
Fri, 22 Jun 2012 19:19:18 -0400
changeset 6342 ac83b73f0edd
parent 6333 8d541aa4e1da
child 6392 fa7eb111f994
child 8304 a4bf0413d7c0
permissions -rw-r--r--
Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
     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 Instructions:
     8 1.  Open SDL.xcodeproj (located in Xcode-iOS/SDL) in XCode.
     9 2.  Select your desired target, and hit build.
    10 
    11 There are three build targets:
    12 - libSDL.a:
    13 	Build SDL as a statically linked library
    14 - testsdl
    15 	Build a test program (there are known test failures which are fine)
    16 - Template:
    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.
    18 
    19 ==============================================================================
    20 Build SDL for iOS from the command line
    21 ==============================================================================
    22 
    23 1. cd (PATH WHERE THE SDL CODE IS)/build-scripts
    24 2. ./iosbuild.sh
    25 
    26 If everything goes fine, you should see a build/ios directory, inside there's
    27 two directories "lib" and "include". 
    28 "include" contains a copy of the SDL headers that you'll need for your project,
    29 make sure to configure XCode to look for headers there.
    30 "lib" contains find two files, libSDL2.a and libSDL2main.a, you have to add both 
    31 to your XCode project. These libraries contain three architectures in them,
    32 armv6 for legacy devices, armv7, and i386 (for the simulator).
    33 By default, iosbuild.sh will autodetect the SDK version you have installed using 
    34 xcodebuild -showsdks, and build for iOS >= 3.0, you can override this behaviour 
    35 by setting the MIN_OS_VERSION variable, ie:
    36 
    37 MIN_OS_VERSION=4.2 ./iosbuild.sh
    38 
    39 ==============================================================================
    40 Using the Simple DirectMedia Layer for iOS
    41 ==============================================================================
    42 
    43 FIXME: This needs to be updated for the latest methods
    44 
    45 Here is the easiest method:
    46 1.  Build the SDL libraries (libSDL.a and libSDLSimulator.a) and the iPhone SDL Application template.
    47 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.
    48 2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
    49 
    50 Here is a more manual method:
    51 1.  Create a new iPhone view based application.
    52 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.
    53 3.  Include the SDL header files in your project.
    54 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.
    55 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.
    56 
    57 ==============================================================================
    58 Notes -- Accelerometer as Joystick
    59 ==============================================================================
    60 
    61 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.
    62 
    63 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.
    64 
    65 ==============================================================================
    66 Notes -- OpenGL ES
    67 ==============================================================================
    68 
    69 Your SDL application for iPhone uses OpenGL ES for video by default.
    70 
    71 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.
    72 
    73 If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
    74 
    75 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.
    76 
    77 ==============================================================================
    78 Notes -- Keyboard
    79 ==============================================================================
    80 
    81 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.
    82 
    83 int SDL_iPhoneKeyboardShow(SDL_Window * window) 
    84 	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
    85 int SDL_iPhoneKeyboardHide(SDL_Window * window) 
    86 	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
    87 SDL_bool SDL_iPhoneKeyboardIsShown(SDL_Window * window) 
    88 	-- returns whether or not the onscreen keyboard is currently visible.
    89 int SDL_iPhoneKeyboardToggle(SDL_Window * window) 	
    90 	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
    91 
    92 ==============================================================================
    93 Notes -- Reading and Writing files
    94 ==============================================================================
    95 
    96 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.
    97 
    98 Once your application is installed its directory tree looks like:
    99 
   100 MySDLApp Home/
   101 	MySDLApp.app
   102 	Documents/
   103 	Library/
   104 		Preferences/
   105 	tmp/
   106 
   107 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".  
   108 
   109 More information on this subject is available here:
   110 http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
   111 
   112 ==============================================================================
   113 Notes -- iPhone SDL limitations
   114 ==============================================================================
   115 
   116 Windows:
   117 	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.
   118 
   119 Video:
   120 	For real time frame-rates, you are advised to use strictly SDL 2.0 video calls.  Using compatibility video calls uploads an OpenGL texture for each frame drawn, and this operation is excruciatingly slow.
   121 
   122 Textures:
   123 	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).
   124 
   125 Audio:
   126 	SDL for iPhone does not yet support audio input.
   127 
   128 Loading Shared Objects:
   129 	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.
   130