docs/README-ios.md
author Ryan C. Gordon
Tue, 29 Dec 2015 01:09:58 -0500
changeset 9983 bbe9ef8c2ecb
parent 9810 1e079120100e
child 9995 d79480c1e151
permissions -rw-r--r--
Mac: don't ignore mouse clicks on the top pixel of a window (thanks, Joshua!).

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