README.iphoneos
author Sam Lantinga <slouken@libsdl.org>
Tue, 19 Apr 2011 08:08:50 -0700
changeset 5539 b305e3c2d2e7
parent 4689 f9ab8df6d45a
permissions -rw-r--r--
Fixed: Windows always fails with SDL_HapticOpenFromJoystick

The windows function SDL_SYS_HapticOpenFromJoystick fails because DIDEVICEINSTANCE joy_instance does not have its dwSize field initialized. The attached patch includes the fix along with a fix for two similar problems.

Daniel Heath
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@3277
     8
1.  Open SDLiPhoneOS.xcodeproj (located in Xcode-iPhoneOS/SDL) in XCode.
slouken@2765
     9
2.  Set Project->Set Active SDK to "Use Project Settings"
slouken@2765
    10
3.  Select your desired target, and hit build.
slouken@2765
    11
slouken@2765
    12
There are three build targets:
slouken@2765
    13
- StaticLibiPhoneOS:
slouken@2765
    14
	Build SDL as a statically linked (armv6) library for iPhone OS 2.0.
slouken@2765
    15
- StaticLibSimulator:
slouken@2765
    16
	Build SDL as a statically linked (x86) library for the iPhone Simulator
slouken@2765
    17
- Template:
slouken@2765
    18
	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
    19
slouken@2765
    20
==============================================================================
slouken@2765
    21
Using the Simple DirectMedia Layer for iPhone OS 2.0
slouken@2765
    22
==============================================================================
slouken@2765
    23
slouken@2765
    24
Here is the easiest method:
slouken@2765
    25
1.  Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and the iPhone SDL Application template.
slouken@2765
    26
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/iPhoneOS.platform/Developer/Library/XCode/Project Templates/" and placing it there.
slouken@2765
    27
2.  Start a new project using the template.  The project should be immediately ready for use with SDL.
slouken@2765
    28
slouken@2765
    29
Here is a more manual method:
slouken@2765
    30
1.  Create a new iPhone view based application.
slouken@2765
    31
2.  Build the SDL static libraries (libSDLiPhoneOS.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
    32
3.  Include the SDL header files in your project.
slouken@2765
    33
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
    34
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
    35
slouken@2765
    36
==============================================================================
slouken@2765
    37
Notes -- Accelerometer as Joystick
slouken@2765
    38
==============================================================================
slouken@2765
    39
slouken@2765
    40
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
    41
slouken@2765
    42
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
    43
slouken@2765
    44
==============================================================================
slouken@2765
    45
Notes -- OpenGL ES
slouken@2765
    46
==============================================================================
slouken@2765
    47
slouken@2765
    48
Your SDL application for iPhone uses OpenGL ES for video by default.
slouken@2765
    49
slouken@4666
    50
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
    51
slouken@2765
    52
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
    53
slouken@2765
    54
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
    55
slouken@2765
    56
==============================================================================
slouken@2765
    57
Notes -- Keyboard
slouken@2765
    58
==============================================================================
slouken@2765
    59
slouken@2765
    60
SDL for iPhone contains several additional functions related to keyboard visibility.  These functions are not part of the SDL standard API, but are necessary for revealing and hiding the iPhone's virtual onscreen keyboard.  You can use them in your own applications by including a copy of the SDL_uikitkeyboard.h header (located in src/video/uikit) in your project.
slouken@2765
    61
slouken@3685
    62
int SDL_iPhoneKeyboardShow(SDL_Window * window) 
slouken@2765
    63
	-- reveals the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@3685
    64
int SDL_iPhoneKeyboardHide(SDL_Window * window) 
slouken@2765
    65
	-- hides the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@3685
    66
SDL_bool SDL_iPhoneKeyboardIsShown(SDL_Window * window) 
slouken@2765
    67
	-- returns whether or not the onscreen keyboard is currently visible.
slouken@3685
    68
int SDL_iPhoneKeyboardToggle(SDL_Window * window) 	
slouken@2765
    69
	-- toggles the visibility of the onscreen keyboard.  Returns 0 on success and -1 on error.
slouken@2765
    70
slouken@2765
    71
==============================================================================
slouken@2765
    72
Notes -- Reading and Writing files
slouken@2765
    73
==============================================================================
slouken@2765
    74
slouken@2765
    75
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
    76
slouken@2765
    77
Once your application is installed its directory tree looks like:
slouken@2765
    78
slouken@2765
    79
MySDLApp Home/
slouken@2765
    80
	MySDLApp.app
slouken@2765
    81
	Documents/
slouken@2765
    82
	Library/
slouken@2765
    83
		Preferences/
slouken@2765
    84
	tmp/
slouken@2765
    85
slouken@2765
    86
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
    87
slouken@2765
    88
More information on this subject is available here:
slouken@2765
    89
http://developer.apple.com/iphone/library/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/ApplicationEnvironment/chapter_6_section_3.html#//apple_ref/doc/uid/TP40007072-CH7-SW21
slouken@2765
    90
slouken@2765
    91
==============================================================================
slouken@2765
    92
Notes -- iPhone SDL limitations
slouken@2765
    93
==============================================================================
slouken@2765
    94
slouken@2765
    95
Windows:
slouken@2765
    96
	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).  Presently, landscape mode is not supported.
slouken@2765
    97
slouken@2765
    98
Video:
slouken@2765
    99
	For real time frame-rates, you are advised to use strictly SDL 1.3 video calls.  Using compatibility video calls uploads an OpenGL texture for each frame drawn, and this operation is excruciatingly slow.
slouken@2765
   100
slouken@2765
   101
Textures:
slouken@2765
   102
	SDL for iPhone Textures supports only SDL_PIXELFORMAT_ABGR8888 and SDL_PIXELFORMAT_RGB24 pixel formats.  This is because texture support in SDL for iPhone is done through OpenGL ES, which supports fewer pixel formats than OpenGL, will not re-order pixel data for you, and has no support for color-paletted formats (without extensions).
slouken@2765
   103
slouken@2765
   104
Audio:
slouken@2765
   105
	SDL for iPhone does not yet support audio input.
slouken@2765
   106
slouken@2765
   107
Loading Shared Objects:
slouken@2765
   108
	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
   109
slouken@2765
   110
slouken@2765
   111