docs/README-ios.md
author Sam Lantinga <slouken@libsdl.org>
Fri, 22 Sep 2017 11:25:52 -0700
changeset 11525 8df7a59b5528
parent 11522 2b3a78025695
child 11548 973151a33ec5
permissions -rw-r--r--
Fixed Mac OS X build
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
slouken@11400
    10
Instructions:
slouken@11400
    11
slouken@11400
    12
2.  Open SDL.xcodeproj (located in Xcode-iOS/SDL) in Xcode.
icculus@11365
    13
4.  Select your desired target, and hit build.
gabomdq@9023
    14
gabomdq@9023
    15
There are three build targets:
gabomdq@9023
    16
- libSDL.a:
gabomdq@9023
    17
	Build SDL as a statically linked library
philipp@9066
    18
- testsdl:
gabomdq@9023
    19
	Build a test program (there are known test failures which are fine)
gabomdq@9023
    20
- Template:
gabomdq@9023
    21
	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
    22
philipp@9066
    23
gabomdq@9023
    24
==============================================================================
gabomdq@9023
    25
Build SDL for iOS from the command line
gabomdq@9023
    26
==============================================================================
gabomdq@9023
    27
slouken@11400
    28
1. Follow step 1 above.
slouken@11400
    29
2. cd (PATH WHERE THE SDL CODE IS)/build-scripts
slouken@11400
    30
3. ./iosbuild.sh
gabomdq@9023
    31
gabomdq@9023
    32
If everything goes fine, you should see a build/ios directory, inside there's
gabomdq@9023
    33
two directories "lib" and "include". 
gabomdq@9023
    34
"include" contains a copy of the SDL headers that you'll need for your project,
gabomdq@9023
    35
make sure to configure XCode to look for headers there.
gabomdq@9023
    36
"lib" contains find two files, libSDL2.a and libSDL2main.a, you have to add both 
gabomdq@9023
    37
to your XCode project. These libraries contain three architectures in them,
gabomdq@9023
    38
armv6 for legacy devices, armv7, and i386 (for the simulator).
gabomdq@9023
    39
By default, iosbuild.sh will autodetect the SDK version you have installed using 
gabomdq@9023
    40
xcodebuild -showsdks, and build for iOS >= 3.0, you can override this behaviour 
gabomdq@9023
    41
by setting the MIN_OS_VERSION variable, ie:
gabomdq@9023
    42
gabomdq@9023
    43
MIN_OS_VERSION=4.2 ./iosbuild.sh
gabomdq@9023
    44
gabomdq@9023
    45
==============================================================================
gabomdq@9023
    46
Using the Simple DirectMedia Layer for iOS
gabomdq@9023
    47
==============================================================================
gabomdq@9023
    48
gabomdq@9023
    49
FIXME: This needs to be updated for the latest methods
gabomdq@9023
    50
gabomdq@9023
    51
Here is the easiest method:
slime73@9995
    52
1.  Build the SDL library (libSDL2.a) and the iPhone SDL Application template.
slime73@9995
    53
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
    54
3.  Start a new project using the template.  The project should be immediately ready for use with SDL.
gabomdq@9023
    55
gabomdq@9023
    56
Here is a more manual method:
slime73@9995
    57
1.  Create a new iOS view based application.
slime73@9995
    58
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
    59
3.  Include the SDL header files in your project.
slime73@9995
    60
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
    61
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
    62
slime73@9995
    63
==============================================================================
slime73@9995
    64
Notes -- Retina / High-DPI and window sizes
slime73@9995
    65
==============================================================================
slime73@9995
    66
slime73@9995
    67
Window and display mode sizes in SDL are in "screen coordinates" (or "points",
slime73@9995
    68
in Apple's terminology) rather than in pixels. On iOS this means that a window
philipp@9997
    69
created on an iPhone 6 will have a size in screen coordinates of 375 x 667,
slime73@9995
    70
rather than a size in pixels of 750 x 1334. All iOS apps are expected to
slime73@9995
    71
size their content based on screen coordinates / points rather than pixels,
slime73@9995
    72
as this allows different iOS devices to have different pixel densities
slime73@9995
    73
(Retina versus non-Retina screens, etc.) without apps caring too much.
slime73@9995
    74
slime73@9995
    75
By default SDL will not use the full pixel density of the screen on
slime73@9995
    76
Retina/high-dpi capable devices. Use the SDL_WINDOW_ALLOW_HIGHDPI flag when
slime73@9995
    77
creating your window to enable high-dpi support.
slime73@9995
    78
philipp@10167
    79
When high-dpi support is enabled, SDL_GetWindowSize() and display mode sizes
slime73@9995
    80
will still be in "screen coordinates" rather than pixels, but the window will
slime73@9995
    81
have a much greater pixel density when the device supports it, and the
philipp@10167
    82
SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() functions (depending on
slime73@9995
    83
whether raw OpenGL or the SDL_Render API is used) can be queried to determine
slime73@9995
    84
the size in pixels of the drawable screen framebuffer.
slime73@9995
    85
slime73@9995
    86
Some OpenGL ES functions such as glViewport expect sizes in pixels rather than
slime73@9995
    87
sizes in screen coordinates. When doing 2D rendering with OpenGL ES, an
slime73@9995
    88
orthographic projection matrix using the size in screen coordinates
philipp@10167
    89
(SDL_GetWindowSize()) can be used in order to display content at the same scale
slime73@9995
    90
no matter whether a Retina device is used or not.
philipp@9066
    91
gabomdq@9023
    92
==============================================================================
gabomdq@9023
    93
Notes -- Application events
gabomdq@9023
    94
==============================================================================
gabomdq@9023
    95
gabomdq@9023
    96
On iOS the application goes through a fixed life cycle and you will get
gabomdq@9023
    97
notifications of state changes via application events. When these events
gabomdq@9023
    98
are delivered you must handle them in an event callback because the OS may
gabomdq@9023
    99
not give you any processing time after the events are delivered.
gabomdq@9023
   100
gabomdq@9023
   101
e.g.
gabomdq@9023
   102
philipp@9050
   103
    int HandleAppEvents(void *userdata, SDL_Event *event)
gabomdq@9023
   104
    {
philipp@9050
   105
        switch (event->type)
philipp@9050
   106
        {
philipp@9050
   107
        case SDL_APP_TERMINATING:
philipp@9050
   108
            /* Terminate the app.
philipp@9050
   109
               Shut everything down before returning from this function.
philipp@9050
   110
            */
philipp@9050
   111
            return 0;
philipp@9050
   112
        case SDL_APP_LOWMEMORY:
philipp@9050
   113
            /* You will get this when your app is paused and iOS wants more memory.
philipp@9050
   114
               Release as much memory as possible.
philipp@9050
   115
            */
philipp@9050
   116
            return 0;
philipp@9050
   117
        case SDL_APP_WILLENTERBACKGROUND:
philipp@9050
   118
            /* Prepare your app to go into the background.  Stop loops, etc.
philipp@9050
   119
               This gets called when the user hits the home button, or gets a call.
philipp@9050
   120
            */
philipp@9050
   121
            return 0;
philipp@9050
   122
        case SDL_APP_DIDENTERBACKGROUND:
philipp@9050
   123
            /* This will get called if the user accepted whatever sent your app to the background.
philipp@9050
   124
               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
   125
               When you get this, you have 5 seconds to save all your state or the app will be terminated.
philipp@9050
   126
               Your app is NOT active at this point.
philipp@9050
   127
            */
philipp@9050
   128
            return 0;
philipp@9050
   129
        case SDL_APP_WILLENTERFOREGROUND:
philipp@9050
   130
            /* This call happens when your app is coming back to the foreground.
philipp@9050
   131
               Restore all your state here.
philipp@9050
   132
            */
philipp@9050
   133
            return 0;
philipp@9050
   134
        case SDL_APP_DIDENTERFOREGROUND:
philipp@9050
   135
            /* Restart your loops here.
philipp@9050
   136
               Your app is interactive and getting CPU again.
philipp@9050
   137
            */
philipp@9050
   138
            return 0;
philipp@9050
   139
        default:
philipp@9050
   140
            /* No special processing, add it to the event queue */
philipp@9050
   141
            return 1;
philipp@9050
   142
        }
philipp@9050
   143
    }
philipp@9050
   144
    
philipp@9050
   145
    int main(int argc, char *argv[])
philipp@9050
   146
    {
philipp@9050
   147
        SDL_SetEventFilter(HandleAppEvents, NULL);
philipp@9050
   148
    
philipp@9050
   149
        ... run your main loop
philipp@9050
   150
    
gabomdq@9023
   151
        return 0;
gabomdq@9023
   152
    }
gabomdq@9023
   153
gabomdq@9023
   154
    
gabomdq@9023
   155
==============================================================================
gabomdq@9023
   156
Notes -- Accelerometer as Joystick
gabomdq@9023
   157
==============================================================================
gabomdq@9023
   158
gabomdq@9023
   159
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
   160
philipp@10167
   161
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
   162
gabomdq@9023
   163
==============================================================================
gabomdq@9023
   164
Notes -- OpenGL ES
gabomdq@9023
   165
==============================================================================
gabomdq@9023
   166
slime73@9810
   167
Your SDL application for iOS uses OpenGL ES for video by default.
gabomdq@9023
   168
philipp@10167
   169
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
   170
gabomdq@9023
   171
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
   172
slime73@9810
   173
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
   174
slime73@9810
   175
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
   176
philipp@10167
   177
- The drawable Renderbuffer must be bound to the GL_RENDERBUFFER binding point when SDL_GL_SwapWindow() is called.
philipp@10167
   178
- The drawable Framebuffer Object must be bound while rendering to the screen and when SDL_GL_SwapWindow() is called.
slime73@9810
   179
- 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
   180
philipp@10167
   181
The above objects can be obtained via SDL_GetWindowWMInfo() (in SDL_syswm.h).
gabomdq@9023
   182
gabomdq@9023
   183
==============================================================================
gabomdq@9023
   184
Notes -- Keyboard
gabomdq@9023
   185
==============================================================================
gabomdq@9023
   186
gabomdq@9023
   187
The SDL keyboard API has been extended to support on-screen keyboards:
gabomdq@9023
   188
gabomdq@9023
   189
void SDL_StartTextInput()
gabomdq@9023
   190
	-- enables text events and reveals the onscreen keyboard.
philipp@9066
   191
gabomdq@9023
   192
void SDL_StopTextInput()
gabomdq@9023
   193
	-- disables text events and hides the onscreen keyboard.
philipp@9066
   194
gabomdq@9023
   195
SDL_bool SDL_IsTextInputActive()
gabomdq@9023
   196
	-- returns whether or not text events are enabled (and the onscreen keyboard is visible)
gabomdq@9023
   197
philipp@9066
   198
gabomdq@9023
   199
==============================================================================
gabomdq@9023
   200
Notes -- Reading and Writing files
gabomdq@9023
   201
==============================================================================
gabomdq@9023
   202
gabomdq@9023
   203
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
   204
gabomdq@9023
   205
Once your application is installed its directory tree looks like:
gabomdq@9023
   206
philipp@9066
   207
    MySDLApp Home/
philipp@9066
   208
        MySDLApp.app
philipp@9066
   209
        Documents/
philipp@9066
   210
        Library/
philipp@9066
   211
            Preferences/
philipp@9066
   212
        tmp/
gabomdq@9023
   213
gabomdq@9023
   214
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
   215
gabomdq@9023
   216
More information on this subject is available here:
gabomdq@9023
   217
http://developer.apple.com/library/ios/#documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/Introduction/Introduction.html
gabomdq@9023
   218
gabomdq@9023
   219
==============================================================================
gabomdq@9023
   220
Notes -- iPhone SDL limitations
gabomdq@9023
   221
==============================================================================
gabomdq@9023
   222
gabomdq@9023
   223
Windows:
philipp@10167
   224
	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
   225
gabomdq@9023
   226
Textures:
gabomdq@9023
   227
	The optimal texture formats on iOS are SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_BGR888, and SDL_PIXELFORMAT_RGB24 pixel formats.
gabomdq@9023
   228
gabomdq@9023
   229
Loading Shared Objects:
slime73@9810
   230
	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
   231
gabomdq@9023
   232
==============================================================================
gabomdq@9023
   233
Game Center 
gabomdq@9023
   234
==============================================================================
gabomdq@9023
   235
slime73@9995
   236
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
   237
philipp@9066
   238
    int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
gabomdq@9023
   239
gabomdq@9023
   240
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
   241
gabomdq@9023
   242
e.g.
gabomdq@9023
   243
philipp@9050
   244
    extern "C"
philipp@9050
   245
    void ShowFrame(void*)
philipp@9050
   246
    {
philipp@9066
   247
        ... do event handling, frame logic and rendering ...
philipp@9050
   248
    }
philipp@9050
   249
    
philipp@9050
   250
    int main(int argc, char *argv[])
philipp@9050
   251
    {
philipp@9050
   252
        ... initialize game ...
philipp@9050
   253
    
philipp@9050
   254
    #if __IPHONEOS__
philipp@9066
   255
        // Initialize the Game Center for scoring and matchmaking
philipp@9066
   256
        InitGameCenter();
philipp@9050
   257
    
philipp@9066
   258
        // Set up the game to run in the window animation callback on iOS
philipp@9066
   259
        // so that Game Center and so forth works correctly.
philipp@9066
   260
        SDL_iPhoneSetAnimationCallback(window, 1, ShowFrame, NULL);
philipp@9050
   261
    #else
philipp@9066
   262
        while ( running ) {
philipp@9066
   263
            ShowFrame(0);
philipp@9066
   264
            DelayFrame();
philipp@9066
   265
        }
philipp@9050
   266
    #endif
philipp@9066
   267
        return 0;
philipp@9050
   268
    }
slouken@11522
   269
slouken@11522
   270
==============================================================================
slouken@11522
   271
Deploying to older versions of iOS
slouken@11522
   272
==============================================================================
slouken@11522
   273
slouken@11522
   274
SDL supports deploying to older versions of iOS than are supported by the latest version of Xcode, all the way back to iOS 6.1
slouken@11522
   275
slouken@11522
   276
In order to do that you need to download an older version of Xcode:
slouken@11522
   277
https://developer.apple.com/download/more/?name=Xcode
slouken@11522
   278
slouken@11522
   279
Open the package contents of the older Xcode and your newer version of Xcode and copy over the folders in Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport
slouken@11522
   280
slouken@11522
   281
Then open the file Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/SDKSettings.plist and add the versions of iOS you want to deploy to the key Root/DefaultProperties/DEPLOYMENT_TARGET_SUGGESTED_VALUES
slouken@11522
   282
slouken@11522
   283
Open your project and set your deployment target to the desired version of iOS
slouken@11522
   284
slouken@11522
   285
Finally, remove GameController from the list of frameworks linked by your application and edit the build settings for "Other Linker Flags" and add -weak_framework GameController