README.iOS
author Sam Lantinga <slouken@libsdl.org>
Sun, 14 Oct 2012 01:49:13 -0700
changeset 6589 46d985073364
parent 6534 8faa51147576
child 6654 2ecfb25be1e2
child 8314 24f2de48557b
permissions -rw-r--r--
Updated the limitations and Game Center sections
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
==============================================================================
gabomdq@6333
    20
Build SDL for iOS from the command line
gabomdq@6333
    21
==============================================================================
gabomdq@6333
    22
gabomdq@6333
    23
1. cd (PATH WHERE THE SDL CODE IS)/build-scripts
gabomdq@6333
    24
2. ./iosbuild.sh
gabomdq@6333
    25
gabomdq@6333
    26
If everything goes fine, you should see a build/ios directory, inside there's
gabomdq@6333
    27
two directories "lib" and "include". 
gabomdq@6333
    28
"include" contains a copy of the SDL headers that you'll need for your project,
gabomdq@6333
    29
make sure to configure XCode to look for headers there.
gabomdq@6333
    30
"lib" contains find two files, libSDL2.a and libSDL2main.a, you have to add both 
gabomdq@6333
    31
to your XCode project. These libraries contain three architectures in them,
gabomdq@6333
    32
armv6 for legacy devices, armv7, and i386 (for the simulator).
gabomdq@6333
    33
By default, iosbuild.sh will autodetect the SDK version you have installed using 
gabomdq@6333
    34
xcodebuild -showsdks, and build for iOS >= 3.0, you can override this behaviour 
gabomdq@6333
    35
by setting the MIN_OS_VERSION variable, ie:
gabomdq@6333
    36
gabomdq@6333
    37
MIN_OS_VERSION=4.2 ./iosbuild.sh
gabomdq@6333
    38
gabomdq@6333
    39
==============================================================================
slouken@6159
    40
Using the Simple DirectMedia Layer for iOS
slouken@2765
    41
==============================================================================
slouken@2765
    42
slouken@6159
    43
FIXME: This needs to be updated for the latest methods
slouken@6159
    44
slouken@2765
    45
Here is the easiest method:
slouken@6159
    46
1.  Build the SDL libraries (libSDL.a and libSDLSimulator.a) and the iPhone SDL Application template.
slouken@6159
    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.
slouken@2765
    48
2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
slouken@2765
    49
slouken@2765
    50
Here is a more manual method:
slouken@2765
    51
1.  Create a new iPhone view based application.
slouken@6159
    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.
slouken@2765
    53
3.  Include the SDL header files in your project.
slouken@2765
    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.
slouken@2765
    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.
slouken@2765
    56
slouken@2765
    57
==============================================================================
slouken@2765
    58
Notes -- Accelerometer as Joystick
slouken@2765
    59
==============================================================================
slouken@2765
    60
slouken@2765
    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.
slouken@2765
    62
slouken@2765
    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.
slouken@2765
    64
slouken@2765
    65
==============================================================================
slouken@2765
    66
Notes -- OpenGL ES
slouken@2765
    67
==============================================================================
slouken@2765
    68
slouken@2765
    69
Your SDL application for iPhone uses OpenGL ES for video by default.
slouken@2765
    70
slouken@4666
    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.
slouken@2765
    72
slouken@2765
    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.
slouken@2765
    74
slouken@2765
    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.
slouken@2765
    76
slouken@2765
    77
==============================================================================
slouken@2765
    78
Notes -- Keyboard
slouken@2765
    79
==============================================================================
slouken@2765
    80
slouken@6392
    81
The SDL keyboard API has been extended to support on-screen keyboards:
slouken@2765
    82
slouken@6392
    83
int SDL_ShowScreenKeyboard(SDL_Window * window) 
slouken@2765
    84
	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@6392
    85
int SDL_HideScreenKeyboard(SDL_Window * window) 
slouken@2765
    86
	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@6392
    87
SDL_bool SDL_IsScreenKeyboardShown(SDL_Window * window) 
slouken@2765
    88
	-- returns whether or not the onscreen keyboard is currently visible.
slouken@6392
    89
int SDL_ToggleScreenKeyboard(SDL_Window * window) 	
slouken@2765
    90
	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@2765
    91
slouken@2765
    92
==============================================================================
slouken@2765
    93
Notes -- Reading and Writing files
slouken@2765
    94
==============================================================================
slouken@2765
    95
slouken@2765
    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.
slouken@2765
    97
slouken@2765
    98
Once your application is installed its directory tree looks like:
slouken@2765
    99
slouken@2765
   100
MySDLApp Home/
slouken@2765
   101
	MySDLApp.app
slouken@2765
   102
	Documents/
slouken@2765
   103
	Library/
slouken@2765
   104
		Preferences/
slouken@2765
   105
	tmp/
slouken@2765
   106
slouken@2765
   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".  
slouken@2765
   108
slouken@2765
   109
More information on this subject is available here:
slouken@6159
   110
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
slouken@2765
   111
slouken@2765
   112
==============================================================================
slouken@2765
   113
Notes -- iPhone SDL limitations
slouken@2765
   114
==============================================================================
slouken@2765
   115
slouken@2765
   116
Windows:
slouken@6589
   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).
slouken@2765
   118
slouken@2765
   119
Textures:
slouken@6589
   120
	The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
slouken@2765
   121
slouken@2765
   122
Loading Shared Objects:
slouken@2765
   123
	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
   124
gabomdq@6534
   125
==============================================================================
gabomdq@6534
   126
Game Center 
gabomdq@6534
   127
==============================================================================
gabomdq@6534
   128
gabomdq@6534
   129
Game Center integration requires that you break up your main loop in order to yield control back to the system. In other words, instead of running an endless main loop, you run each frame in a callback function, using:
gabomdq@6534
   130
    
gabomdq@6534
   131
int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
gabomdq@6534
   132
gabomdq@6534
   133
This will set up the given function to be called back on the animation callback, and then you have to return from main() to let the Cocoa event loop run.
gabomdq@6534
   134
gabomdq@6534
   135
e.g.
gabomdq@6534
   136
gabomdq@6534
   137
extern "C"
gabomdq@6534
   138
void ShowFrame(void*)
gabomdq@6534
   139
{
slouken@6589
   140
    ... do event handling, frame logic and rendering
gabomdq@6534
   141
}
gabomdq@6534
   142
gabomdq@6534
   143
int main(int argc, char *argv[])
gabomdq@6534
   144
{
gabomdq@6534
   145
   ... initialize game ...
gabomdq@6534
   146
gabomdq@6534
   147
#if __IPHONEOS__
gabomdq@6534
   148
        // Initialize the Game Center for scoring and matchmaking
gabomdq@6534
   149
        InitGameCenter();
gabomdq@6534
   150
gabomdq@6534
   151
        // Set up the game to run in the window animation callback on iOS
gabomdq@6534
   152
        // so that Game Center and so forth works correctly.
slouken@6589
   153
        SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
gabomdq@6534
   154
#else
slouken@6589
   155
        while ( running ) {
gabomdq@6534
   156
                ShowFrame(0);
gabomdq@6534
   157
                DelayFrame();
gabomdq@6534
   158
        }
gabomdq@6534
   159
#endif
gabomdq@6534
   160
        return 0;
slouken@6589
   161
}