docs/README-ios.md
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Mon, 11 Aug 2014 23:13:20 +0200
changeset 9050 bc9616da37cd
parent 9025 d09d4b578e77
child 9064 428bff5bf38a
permissions -rw-r--r--
Fixed doxygen warning and markdown formatting.
gabomdq@9023
     1
iOS
gabomdq@9023
     2
======
gabomdq@9023
     3
gabomdq@9023
     4
==============================================================================
gabomdq@9023
     5
Building the Simple DirectMedia Layer for iPhone OS 5.1
gabomdq@9023
     6
==============================================================================
gabomdq@9023
     7
gabomdq@9023
     8
Requirements: Mac OS X v10.5 or later and the iPhone SDK.
gabomdq@9023
     9
gabomdq@9023
    10
Instructions:
gabomdq@9023
    11
1.  Open SDL.xcodeproj (located in Xcode-iOS/SDL) in XCode.
gabomdq@9023
    12
2.  Select your desired target, and hit build.
gabomdq@9023
    13
gabomdq@9023
    14
There are three build targets:
gabomdq@9023
    15
- libSDL.a:
gabomdq@9023
    16
	Build SDL as a statically linked library
gabomdq@9023
    17
- testsdl
gabomdq@9023
    18
	Build a test program (there are known test failures which are fine)
gabomdq@9023
    19
- Template:
gabomdq@9023
    20
	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.
gabomdq@9023
    21
gabomdq@9023
    22
==============================================================================
gabomdq@9023
    23
Build SDL for iOS from the command line
gabomdq@9023
    24
==============================================================================
gabomdq@9023
    25
gabomdq@9023
    26
1. cd (PATH WHERE THE SDL CODE IS)/build-scripts
gabomdq@9023
    27
2. ./iosbuild.sh
gabomdq@9023
    28
gabomdq@9023
    29
If everything goes fine, you should see a build/ios directory, inside there's
gabomdq@9023
    30
two directories "lib" and "include". 
gabomdq@9023
    31
"include" contains a copy of the SDL headers that you'll need for your project,
gabomdq@9023
    32
make sure to configure XCode to look for headers there.
gabomdq@9023
    33
"lib" contains find two files, libSDL2.a and libSDL2main.a, you have to add both 
gabomdq@9023
    34
to your XCode project. These libraries contain three architectures in them,
gabomdq@9023
    35
armv6 for legacy devices, armv7, and i386 (for the simulator).
gabomdq@9023
    36
By default, iosbuild.sh will autodetect the SDK version you have installed using 
gabomdq@9023
    37
xcodebuild -showsdks, and build for iOS >= 3.0, you can override this behaviour 
gabomdq@9023
    38
by setting the MIN_OS_VERSION variable, ie:
gabomdq@9023
    39
gabomdq@9023
    40
MIN_OS_VERSION=4.2 ./iosbuild.sh
gabomdq@9023
    41
gabomdq@9023
    42
==============================================================================
gabomdq@9023
    43
Using the Simple DirectMedia Layer for iOS
gabomdq@9023
    44
==============================================================================
gabomdq@9023
    45
gabomdq@9023
    46
FIXME: This needs to be updated for the latest methods
gabomdq@9023
    47
gabomdq@9023
    48
Here is the easiest method:
gabomdq@9023
    49
1.  Build the SDL libraries (libSDL.a and libSDLSimulator.a) and the iPhone SDL Application template.
gabomdq@9023
    50
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.
gabomdq@9023
    51
2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
gabomdq@9023
    52
gabomdq@9023
    53
Here is a more manual method:
gabomdq@9023
    54
1.  Create a new iPhone view based application.
gabomdq@9023
    55
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.
gabomdq@9023
    56
3.  Include the SDL header files in your project.
gabomdq@9023
    57
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.
gabomdq@9023
    58
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.
gabomdq@9023
    59
gabomdq@9023
    60
==============================================================================
gabomdq@9023
    61
Notes -- Application events
gabomdq@9023
    62
==============================================================================
gabomdq@9023
    63
gabomdq@9023
    64
On iOS the application goes through a fixed life cycle and you will get
gabomdq@9023
    65
notifications of state changes via application events. When these events
gabomdq@9023
    66
are delivered you must handle them in an event callback because the OS may
gabomdq@9023
    67
not give you any processing time after the events are delivered.
gabomdq@9023
    68
gabomdq@9023
    69
e.g.
gabomdq@9023
    70
philipp@9050
    71
    int HandleAppEvents(void *userdata, SDL_Event *event)
gabomdq@9023
    72
    {
philipp@9050
    73
        switch (event->type)
philipp@9050
    74
        {
philipp@9050
    75
        case SDL_APP_TERMINATING:
philipp@9050
    76
            /* Terminate the app.
philipp@9050
    77
               Shut everything down before returning from this function.
philipp@9050
    78
            */
philipp@9050
    79
            return 0;
philipp@9050
    80
        case SDL_APP_LOWMEMORY:
philipp@9050
    81
            /* You will get this when your app is paused and iOS wants more memory.
philipp@9050
    82
               Release as much memory as possible.
philipp@9050
    83
            */
philipp@9050
    84
            return 0;
philipp@9050
    85
        case SDL_APP_WILLENTERBACKGROUND:
philipp@9050
    86
            /* Prepare your app to go into the background.  Stop loops, etc.
philipp@9050
    87
               This gets called when the user hits the home button, or gets a call.
philipp@9050
    88
            */
philipp@9050
    89
            return 0;
philipp@9050
    90
        case SDL_APP_DIDENTERBACKGROUND:
philipp@9050
    91
            /* This will get called if the user accepted whatever sent your app to the background.
philipp@9050
    92
               If the user got a phone call and canceled it, you'll instead get an SDL_APP_DIDENTERFOREGROUND event and restart your loops.
philipp@9050
    93
               When you get this, you have 5 seconds to save all your state or the app will be terminated.
philipp@9050
    94
               Your app is NOT active at this point.
philipp@9050
    95
            */
philipp@9050
    96
            return 0;
philipp@9050
    97
        case SDL_APP_WILLENTERFOREGROUND:
philipp@9050
    98
            /* This call happens when your app is coming back to the foreground.
philipp@9050
    99
               Restore all your state here.
philipp@9050
   100
            */
philipp@9050
   101
            return 0;
philipp@9050
   102
        case SDL_APP_DIDENTERFOREGROUND:
philipp@9050
   103
            /* Restart your loops here.
philipp@9050
   104
               Your app is interactive and getting CPU again.
philipp@9050
   105
            */
philipp@9050
   106
            return 0;
philipp@9050
   107
        default:
philipp@9050
   108
            /* No special processing, add it to the event queue */
philipp@9050
   109
            return 1;
philipp@9050
   110
        }
philipp@9050
   111
    }
philipp@9050
   112
    
philipp@9050
   113
    int main(int argc, char *argv[])
philipp@9050
   114
    {
philipp@9050
   115
        SDL_SetEventFilter(HandleAppEvents, NULL);
philipp@9050
   116
    
philipp@9050
   117
        ... run your main loop
philipp@9050
   118
    
gabomdq@9023
   119
        return 0;
gabomdq@9023
   120
    }
gabomdq@9023
   121
gabomdq@9023
   122
    
gabomdq@9023
   123
==============================================================================
gabomdq@9023
   124
Notes -- Accelerometer as Joystick
gabomdq@9023
   125
==============================================================================
gabomdq@9023
   126
gabomdq@9023
   127
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.
gabomdq@9023
   128
gabomdq@9023
   129
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.
gabomdq@9023
   130
gabomdq@9023
   131
==============================================================================
gabomdq@9023
   132
Notes -- OpenGL ES
gabomdq@9023
   133
==============================================================================
gabomdq@9023
   134
gabomdq@9023
   135
Your SDL application for iPhone uses OpenGL ES for video by default.
gabomdq@9023
   136
gabomdq@9023
   137
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.
gabomdq@9023
   138
gabomdq@9023
   139
If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
gabomdq@9023
   140
gabomdq@9023
   141
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.
gabomdq@9023
   142
gabomdq@9023
   143
==============================================================================
gabomdq@9023
   144
Notes -- Keyboard
gabomdq@9023
   145
==============================================================================
gabomdq@9023
   146
gabomdq@9023
   147
The SDL keyboard API has been extended to support on-screen keyboards:
gabomdq@9023
   148
gabomdq@9023
   149
void SDL_StartTextInput()
gabomdq@9023
   150
	-- enables text events and reveals the onscreen keyboard.
gabomdq@9023
   151
void SDL_StopTextInput()
gabomdq@9023
   152
	-- disables text events and hides the onscreen keyboard.
gabomdq@9023
   153
SDL_bool SDL_IsTextInputActive()
gabomdq@9023
   154
	-- returns whether or not text events are enabled (and the onscreen keyboard is visible)
gabomdq@9023
   155
gabomdq@9023
   156
==============================================================================
gabomdq@9023
   157
Notes -- Reading and Writing files
gabomdq@9023
   158
==============================================================================
gabomdq@9023
   159
gabomdq@9023
   160
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.
gabomdq@9023
   161
gabomdq@9023
   162
Once your application is installed its directory tree looks like:
gabomdq@9023
   163
gabomdq@9023
   164
MySDLApp Home/
gabomdq@9023
   165
	MySDLApp.app
gabomdq@9023
   166
	Documents/
gabomdq@9023
   167
	Library/
gabomdq@9023
   168
		Preferences/
gabomdq@9023
   169
	tmp/
gabomdq@9023
   170
gabomdq@9023
   171
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".  
gabomdq@9023
   172
gabomdq@9023
   173
More information on this subject is available here:
gabomdq@9023
   174
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
gabomdq@9023
   175
gabomdq@9023
   176
==============================================================================
gabomdq@9023
   177
Notes -- iPhone SDL limitations
gabomdq@9023
   178
==============================================================================
gabomdq@9023
   179
gabomdq@9023
   180
Windows:
gabomdq@9023
   181
	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).
gabomdq@9023
   182
gabomdq@9023
   183
Textures:
gabomdq@9023
   184
	The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
gabomdq@9023
   185
gabomdq@9023
   186
Loading Shared Objects:
gabomdq@9023
   187
	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.
gabomdq@9023
   188
gabomdq@9023
   189
==============================================================================
gabomdq@9023
   190
Game Center 
gabomdq@9023
   191
==============================================================================
gabomdq@9023
   192
gabomdq@9023
   193
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@9023
   194
    
gabomdq@9023
   195
int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
gabomdq@9023
   196
gabomdq@9023
   197
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@9023
   198
gabomdq@9023
   199
e.g.
gabomdq@9023
   200
philipp@9050
   201
    extern "C"
philipp@9050
   202
    void ShowFrame(void*)
philipp@9050
   203
    {
philipp@9050
   204
        ... do event handling, frame logic and rendering
philipp@9050
   205
    }
philipp@9050
   206
    
philipp@9050
   207
    int main(int argc, char *argv[])
philipp@9050
   208
    {
philipp@9050
   209
        ... initialize game ...
philipp@9050
   210
    
philipp@9050
   211
    #if __IPHONEOS__
philipp@9050
   212
            // Initialize the Game Center for scoring and matchmaking
philipp@9050
   213
            InitGameCenter();
philipp@9050
   214
    
philipp@9050
   215
            // Set up the game to run in the window animation callback on iOS
philipp@9050
   216
            // so that Game Center and so forth works correctly.
philipp@9050
   217
            SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
philipp@9050
   218
    #else
philipp@9050
   219
            while ( running ) {
philipp@9050
   220
                    ShowFrame(0);
philipp@9050
   221
                    DelayFrame();
philipp@9050
   222
            }
philipp@9050
   223
    #endif
philipp@9050
   224
            return 0;
philipp@9050
   225
    }