sdl-ios-xcode: README.iphoneos annotate

annotate README.iphoneos @ 4803:a4c1df880690

Added code to make testshape switch shapes on keystrokes and exit on an ESC keystroke.

author	Eli Gottlieb <eligottlieb@gmail.com>
date	Sun, 18 Jul 2010 23:36:39 -0400
parents	64ce267332c6
children	52e871f486b8

rev	line source
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2 Building the Simple DirectMedia Layer for iPhone OS 2.0
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 Requirements: Mac OS X v10.5 or later and the iPhone SDK.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 Instructions:
3277 20326ba2bda2 This name inconsistency has been bugging me for a while... Sam Lantinga <slouken@libsdl.org> parents: 2765 diff changeset	8 1. Open SDLiPhoneOS.xcodeproj (located in Xcode-iPhoneOS/SDL) in XCode.
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9 2. Set Project->Set Active SDK to "Use Project Settings"
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 3. Select your desired target, and hit build.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12 There are three build targets:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 - StaticLibiPhoneOS:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14 Build SDL as a statically linked (armv6) library for iPhone OS 2.0.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 - StaticLibSimulator:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16 Build SDL as a statically linked (x86) library for the iPhone Simulator
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 - Template:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21 Using the Simple DirectMedia Layer for iPhone OS 2.0
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 Here is the easiest method:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25 1. Build the SDL libraries (libSDLiPhoneOS.a and libSDLSimulator.a) and the iPhone SDL Application template.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	27 2. Start a new project using the template. The project should be immediately ready for use with SDL.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	28
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	29 Here is a more manual method:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	30 1. Create a new iPhone view based application.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	32 3. Include the SDL header files in your project.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	35
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 Notes -- Touch Input
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	40 Touch input in SDL for iPhone OS is presently exposed through SDL's mouse input API. Multi-touch input is reported as multiple mice, with each touch associated with a specific mouse. This association stays coherent from the time the touch starts to the time a touch ends.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 By default, multi-touch is turned ON. This requires some care, because if you simply respond to mouse events without checking which mouse caused the event, you may end up fetching data from the wrong mouse, ie, from an incorrect or invalid touch. To turn multi-touch OFF, you can recompile SDL for iPhone with the macro SDL_IPHONE_MULTIPLE_MICE (found in SDL_config_iphoneos.h) set to 0.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 Notes -- Accelerometer as Joystick
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	48 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	49
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	50 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	51
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	52 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	53 Notes -- OpenGL ES
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	54 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	55
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	56 Your SDL application for iPhone uses OpenGL ES for video by default.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	57
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58 OpenGL ES for iPhone supports two display pixel formats, 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	59
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	60 If your application doesn't use OpenGL's depth buffer, you may find significant performance improvement by setting SDL_GL_DEPTH_SIZE to 0.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	61
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	64 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65 Notes -- Keyboard
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	67
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	69
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3277 diff changeset	70 int SDL_iPhoneKeyboardShow(SDL_Window * window)
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71 -- reveals the onscreen keyboard. Returns 0 on success and -1 on error.
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3277 diff changeset	72 int SDL_iPhoneKeyboardHide(SDL_Window * window)
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 -- hides the onscreen keyboard. Returns 0 on success and -1 on error.
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3277 diff changeset	74 SDL_bool SDL_iPhoneKeyboardIsShown(SDL_Window * window)
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	75 -- returns whether or not the onscreen keyboard is currently visible.
3685 64ce267332c6 Switched from SDL_WindowID and SDL_TextureID to SDL_Window* and SDL_Texture* for code simplicity and improved performance. Sam Lantinga <slouken@libsdl.org> parents: 3277 diff changeset	76 int SDL_iPhoneKeyboardToggle(SDL_Window * window)
2765 f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77 -- toggles the visibility of the onscreen keyboard. Returns 0 on success and -1 on error.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 Notes -- Reading and Writing files
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85 Once your application is installed its directory tree looks like:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87 MySDLApp Home/
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88 MySDLApp.app
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89 Documents/
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	90 Library/
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	91 Preferences/
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	92 tmp/
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	94 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".
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96 More information on this subject is available here:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97 http://developer.apple.com/iphone/library/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/ApplicationEnvironment/chapter_6_section_3.html#//apple_ref/doc/uid/TP40007072-CH7-SW21
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 Notes -- iPhone SDL limitations
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 ==============================================================================
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103 Windows:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 Video:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 Textures:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110 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).
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	112 Audio:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 SDL for iPhone does not yet support audio input.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115 Loading Shared Objects:
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116 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.
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	117
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	118
f55c87ae336b Final merge of Google Summer of Code 2008 work... Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119

Mercurial > sdl-ios-xcode

annotate README.iphoneos @ 4803:a4c1df880690