docs/README-ios.md
author bschaefer
Sun, 21 Feb 2016 15:19:35 -0800
changeset 10089 25fda20d0173
parent 9997 e330f785a5e7
child 10167 d3db276c1fa6
permissions -rw-r--r--
Fix API/ABI breakage in Mir 0.13/0.14.
slime73@9810
     1
iOS
slime73@9810
     2
======
slime73@9810
     3
gabomdq@9023
     4
==============================================================================
slime73@9810
     5
Building the Simple DirectMedia Layer for iOS 5.1+
gabomdq@9023
     6
==============================================================================
gabomdq@9023
     7
slime73@9810
     8
Requirements: Mac OS X 10.8 or later and the iOS 7+ SDK.
gabomdq@9023
     9
gabomdq@9023
    10
Instructions:
slime73@9810
    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
philipp@9066
    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
philipp@9066
    22
gabomdq@9023
    23
==============================================================================
gabomdq@9023
    24
Build SDL for iOS from the command line
gabomdq@9023
    25
==============================================================================
gabomdq@9023
    26
gabomdq@9023
    27
1. cd (PATH WHERE THE SDL CODE IS)/build-scripts
gabomdq@9023
    28
2. ./iosbuild.sh
gabomdq@9023
    29
gabomdq@9023
    30
If everything goes fine, you should see a build/ios directory, inside there's
gabomdq@9023
    31
two directories "lib" and "include". 
gabomdq@9023
    32
"include" contains a copy of the SDL headers that you'll need for your project,
gabomdq@9023
    33
make sure to configure XCode to look for headers there.
gabomdq@9023
    34
"lib" contains find two files, libSDL2.a and libSDL2main.a, you have to add both 
gabomdq@9023
    35
to your XCode project. These libraries contain three architectures in them,
gabomdq@9023
    36
armv6 for legacy devices, armv7, and i386 (for the simulator).
gabomdq@9023
    37
By default, iosbuild.sh will autodetect the SDK version you have installed using 
gabomdq@9023
    38
xcodebuild -showsdks, and build for iOS >= 3.0, you can override this behaviour 
gabomdq@9023
    39
by setting the MIN_OS_VERSION variable, ie:
gabomdq@9023
    40
gabomdq@9023
    41
MIN_OS_VERSION=4.2 ./iosbuild.sh
gabomdq@9023
    42
gabomdq@9023
    43
==============================================================================
gabomdq@9023
    44
Using the Simple DirectMedia Layer for iOS
gabomdq@9023
    45
==============================================================================
gabomdq@9023
    46
gabomdq@9023
    47
FIXME: This needs to be updated for the latest methods
gabomdq@9023
    48
gabomdq@9023
    49
Here is the easiest method:
slime73@9995
    50
1.  Build the SDL library (libSDL2.a) and the iPhone SDL Application template.
slime73@9995
    51
2.  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.
philipp@9064
    52
3.  Start a new project using the template.  The project should be immediately ready for use with SDL.
gabomdq@9023
    53
gabomdq@9023
    54
Here is a more manual method:
slime73@9995
    55
1.  Create a new iOS view based application.
slime73@9995
    56
2.  Build the SDL static library (libSDL2.a) for iOS 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 iOS and in the iOS Simulator.
gabomdq@9023
    57
3.  Include the SDL header files in your project.
slime73@9995
    58
4.  Remove the ApplicationDelegate.h and ApplicationDelegate.m files -- SDL for iOS provides its own UIApplicationDelegate.  Remove MainWindow.xib -- SDL for iOS produces its user interface programmatically.
slime73@9995
    59
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
    60
slime73@9995
    61
==============================================================================
slime73@9995
    62
Notes -- Retina / High-DPI and window sizes
slime73@9995
    63
==============================================================================
slime73@9995
    64
slime73@9995
    65
Window and display mode sizes in SDL are in "screen coordinates" (or "points",
slime73@9995
    66
in Apple's terminology) rather than in pixels. On iOS this means that a window
philipp@9997
    67
created on an iPhone 6 will have a size in screen coordinates of 375 x 667,
slime73@9995
    68
rather than a size in pixels of 750 x 1334. All iOS apps are expected to
slime73@9995
    69
size their content based on screen coordinates / points rather than pixels,
slime73@9995
    70
as this allows different iOS devices to have different pixel densities
slime73@9995
    71
(Retina versus non-Retina screens, etc.) without apps caring too much.
slime73@9995
    72
slime73@9995
    73
By default SDL will not use the full pixel density of the screen on
slime73@9995
    74
Retina/high-dpi capable devices. Use the SDL_WINDOW_ALLOW_HIGHDPI flag when
slime73@9995
    75
creating your window to enable high-dpi support.
slime73@9995
    76
slime73@9995
    77
When high-dpi support is enabled, SDL_GetWindowSize and display mode sizes
slime73@9995
    78
will still be in "screen coordinates" rather than pixels, but the window will
slime73@9995
    79
have a much greater pixel density when the device supports it, and the
slime73@9995
    80
SDL_GL_GetDrawableSize or SDL_GetRendererOutputSize functions (depending on
slime73@9995
    81
whether raw OpenGL or the SDL_Render API is used) can be queried to determine
slime73@9995
    82
the size in pixels of the drawable screen framebuffer.
slime73@9995
    83
slime73@9995
    84
Some OpenGL ES functions such as glViewport expect sizes in pixels rather than
slime73@9995
    85
sizes in screen coordinates. When doing 2D rendering with OpenGL ES, an
slime73@9995
    86
orthographic projection matrix using the size in screen coordinates
slime73@9995
    87
(SDL_GetWindowSize) can be used in order to display content at the same scale
slime73@9995
    88
no matter whether a Retina device is used or not.
philipp@9066
    89
gabomdq@9023
    90
==============================================================================
gabomdq@9023
    91
Notes -- Application events
gabomdq@9023
    92
==============================================================================
gabomdq@9023
    93
gabomdq@9023
    94
On iOS the application goes through a fixed life cycle and you will get
gabomdq@9023
    95
notifications of state changes via application events. When these events
gabomdq@9023
    96
are delivered you must handle them in an event callback because the OS may
gabomdq@9023
    97
not give you any processing time after the events are delivered.
gabomdq@9023
    98
gabomdq@9023
    99
e.g.
gabomdq@9023
   100
philipp@9050
   101
    int HandleAppEvents(void *userdata, SDL_Event *event)
gabomdq@9023
   102
    {
philipp@9050
   103
        switch (event->type)
philipp@9050
   104
        {
philipp@9050
   105
        case SDL_APP_TERMINATING:
philipp@9050
   106
            /* Terminate the app.
philipp@9050
   107
               Shut everything down before returning from this function.
philipp@9050
   108
            */
philipp@9050
   109
            return 0;
philipp@9050
   110
        case SDL_APP_LOWMEMORY:
philipp@9050
   111
            /* You will get this when your app is paused and iOS wants more memory.
philipp@9050
   112
               Release as much memory as possible.
philipp@9050
   113
            */
philipp@9050
   114
            return 0;
philipp@9050
   115
        case SDL_APP_WILLENTERBACKGROUND:
philipp@9050
   116
            /* Prepare your app to go into the background.  Stop loops, etc.
philipp@9050
   117
               This gets called when the user hits the home button, or gets a call.
philipp@9050
   118
            */
philipp@9050
   119
            return 0;
philipp@9050
   120
        case SDL_APP_DIDENTERBACKGROUND:
philipp@9050
   121
            /* This will get called if the user accepted whatever sent your app to the background.
philipp@9050
   122
               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
   123
               When you get this, you have 5 seconds to save all your state or the app will be terminated.
philipp@9050
   124
               Your app is NOT active at this point.
philipp@9050
   125
            */
philipp@9050
   126
            return 0;
philipp@9050
   127
        case SDL_APP_WILLENTERFOREGROUND:
philipp@9050
   128
            /* This call happens when your app is coming back to the foreground.
philipp@9050
   129
               Restore all your state here.
philipp@9050
   130
            */
philipp@9050
   131
            return 0;
philipp@9050
   132
        case SDL_APP_DIDENTERFOREGROUND:
philipp@9050
   133
            /* Restart your loops here.
philipp@9050
   134
               Your app is interactive and getting CPU again.
philipp@9050
   135
            */
philipp@9050
   136
            return 0;
philipp@9050
   137
        default:
philipp@9050
   138
            /* No special processing, add it to the event queue */
philipp@9050
   139
            return 1;
philipp@9050
   140
        }
philipp@9050
   141
    }
philipp@9050
   142
    
philipp@9050
   143
    int main(int argc, char *argv[])
philipp@9050
   144
    {
philipp@9050
   145
        SDL_SetEventFilter(HandleAppEvents, NULL);
philipp@9050
   146
    
philipp@9050
   147
        ... run your main loop
philipp@9050
   148
    
gabomdq@9023
   149
        return 0;
gabomdq@9023
   150
    }
gabomdq@9023
   151
gabomdq@9023
   152
    
gabomdq@9023
   153
==============================================================================
gabomdq@9023
   154
Notes -- Accelerometer as Joystick
gabomdq@9023
   155
==============================================================================
gabomdq@9023
   156
gabomdq@9023
   157
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
   158
gabomdq@9023
   159
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
   160
gabomdq@9023
   161
==============================================================================
gabomdq@9023
   162
Notes -- OpenGL ES
gabomdq@9023
   163
==============================================================================
gabomdq@9023
   164
slime73@9810
   165
Your SDL application for iOS uses OpenGL ES for video by default.
gabomdq@9023
   166
slime73@9810
   167
OpenGL ES for iOS 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
   168
gabomdq@9023
   169
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
   170
slime73@9810
   171
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 0.
slime73@9810
   172
slime73@9810
   173
OpenGL ES on iOS doesn't use the traditional system-framebuffer setup provided in other operating systems. Special care must be taken because of this:
slime73@9810
   174
slime73@9810
   175
- The drawable Renderbuffer must be bound to the GL_RENDERBUFFER binding point when SDL_GL_SwapWindow is called.
slime73@9810
   176
- The drawable Framebuffer Object must be bound while rendering to the screen and when SDL_GL_SwapWindow is called.
slime73@9810
   177
- If multisample antialiasing (MSAA) is used and glReadPixels is used on the screen, the drawable framebuffer must be resolved to the MSAA resolve framebuffer (via glBlitFramebuffer or glResolveMultisampleFramebufferAPPLE), and the MSAA resolve framebuffer must be bound to the GL_READ_FRAMEBUFFER binding point, before glReadPixels is called.
slime73@9810
   178
slime73@9810
   179
The above objects can be obtained via SDL_GetWindowWMInfo (in SDL_syswm.h).
gabomdq@9023
   180
gabomdq@9023
   181
==============================================================================
gabomdq@9023
   182
Notes -- Keyboard
gabomdq@9023
   183
==============================================================================
gabomdq@9023
   184
gabomdq@9023
   185
The SDL keyboard API has been extended to support on-screen keyboards:
gabomdq@9023
   186
gabomdq@9023
   187
void SDL_StartTextInput()
gabomdq@9023
   188
	-- enables text events and reveals the onscreen keyboard.
philipp@9066
   189
gabomdq@9023
   190
void SDL_StopTextInput()
gabomdq@9023
   191
	-- disables text events and hides the onscreen keyboard.
philipp@9066
   192
gabomdq@9023
   193
SDL_bool SDL_IsTextInputActive()
gabomdq@9023
   194
	-- returns whether or not text events are enabled (and the onscreen keyboard is visible)
gabomdq@9023
   195
philipp@9066
   196
gabomdq@9023
   197
==============================================================================
gabomdq@9023
   198
Notes -- Reading and Writing files
gabomdq@9023
   199
==============================================================================
gabomdq@9023
   200
gabomdq@9023
   201
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
   202
gabomdq@9023
   203
Once your application is installed its directory tree looks like:
gabomdq@9023
   204
philipp@9066
   205
    MySDLApp Home/
philipp@9066
   206
        MySDLApp.app
philipp@9066
   207
        Documents/
philipp@9066
   208
        Library/
philipp@9066
   209
            Preferences/
philipp@9066
   210
        tmp/
gabomdq@9023
   211
gabomdq@9023
   212
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
   213
gabomdq@9023
   214
More information on this subject is available here:
gabomdq@9023
   215
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
gabomdq@9023
   216
gabomdq@9023
   217
==============================================================================
gabomdq@9023
   218
Notes -- iPhone SDL limitations
gabomdq@9023
   219
==============================================================================
gabomdq@9023
   220
gabomdq@9023
   221
Windows:
gabomdq@9023
   222
	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
   223
gabomdq@9023
   224
Textures:
gabomdq@9023
   225
	The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
gabomdq@9023
   226
gabomdq@9023
   227
Loading Shared Objects:
slime73@9810
   228
	This is disabled by default since it seems to break the terms of the iOS SDK agreement for iOS versions prior to iOS 8. It can be re-enabled in SDL_config_iphoneos.h.
gabomdq@9023
   229
gabomdq@9023
   230
==============================================================================
gabomdq@9023
   231
Game Center 
gabomdq@9023
   232
==============================================================================
gabomdq@9023
   233
slime73@9995
   234
Game Center integration might require 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:
philipp@9066
   235
philipp@9066
   236
    int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
gabomdq@9023
   237
gabomdq@9023
   238
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
   239
gabomdq@9023
   240
e.g.
gabomdq@9023
   241
philipp@9050
   242
    extern "C"
philipp@9050
   243
    void ShowFrame(void*)
philipp@9050
   244
    {
philipp@9066
   245
        ... do event handling, frame logic and rendering ...
philipp@9050
   246
    }
philipp@9050
   247
    
philipp@9050
   248
    int main(int argc, char *argv[])
philipp@9050
   249
    {
philipp@9050
   250
        ... initialize game ...
philipp@9050
   251
    
philipp@9050
   252
    #if __IPHONEOS__
philipp@9066
   253
        // Initialize the Game Center for scoring and matchmaking
philipp@9066
   254
        InitGameCenter();
philipp@9050
   255
    
philipp@9066
   256
        // Set up the game to run in the window animation callback on iOS
philipp@9066
   257
        // so that Game Center and so forth works correctly.
philipp@9066
   258
        SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
philipp@9050
   259
    #else
philipp@9066
   260
        while ( running ) {
philipp@9066
   261
            ShowFrame(0);
philipp@9066
   262
            DelayFrame();
philipp@9066
   263
        }
philipp@9050
   264
    #endif
philipp@9066
   265
        return 0;
philipp@9050
   266
    }