docs/README-android.md
author Ryan C. Gordon <icculus@icculus.org>
Fri, 12 Aug 2016 19:59:00 -0400
changeset 10266 c09f06c4e8c8
parent 10092 f1949a74dce5
permissions -rw-r--r--
emscripten: send fake mouse events for touches, like other targets do. (This really should be handled at the higher level and not in the individual targets, but this fixes the immediate bug.)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     1
Android
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     2
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     3
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     4
Requirements:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     5
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     6
Android SDK (version 12 or later)
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     7
http://developer.android.com/sdk/index.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     8
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
     9
Android NDK r7 or later
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    10
http://developer.android.com/tools/sdk/ndk/index.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    11
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    12
Minimum API level supported by SDL: 10 (Android 2.3.3)
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    13
Joystick support is available for API level >=12 devices.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    14
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    15
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    16
 How the port works
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    17
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    18
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    19
- Android applications are Java-based, optionally with parts written in C
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    20
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to 
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    21
  the SDL library
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    22
- This means that your application C code must be placed inside an Android 
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    23
  Java project, along with some C support code that communicates with Java
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    24
- This eventually produces a standard Android .apk package
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    25
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    26
The Android Java code implements an "Activity" and can be found in:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    27
android-project/src/org/libsdl/app/SDLActivity.java
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    28
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    29
The Java code loads your game code, the SDL shared library, and
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    30
dispatches to native functions implemented in the SDL library:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    31
src/core/android/SDL_android.c
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    32
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    33
Your project must include some glue code that starts your main() routine:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    34
src/main/android/SDL_android_main.c
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    35
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    36
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    37
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    38
 Building an app
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    39
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    40
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    41
For simple projects you can use the script located at build-scripts/androidbuild.sh
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    42
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    43
There's two ways of using it:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    44
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    45
    androidbuild.sh com.yourcompany.yourapp < sources.list
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    46
    androidbuild.sh com.yourcompany.yourapp source1.c source2.c ...sourceN.c
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    47
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    48
sources.list should be a text file with a source file name in each line
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    49
Filenames should be specified relative to the current directory, for example if
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    50
you are in the build-scripts directory and want to create the testgles.c test, you'll
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    51
run:
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    52
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    53
    ./androidbuild.sh org.libsdl.testgles ../test/testgles.c
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    54
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    55
One limitation of this script is that all sources provided will be aggregated into
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    56
a single directory, thus all your source files should have a unique name.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    57
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    58
Once the project is complete the script will tell you where the debug APK is located.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    59
If you want to create a signed release APK, you can use the project created by this
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    60
utility to generate it.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    61
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    62
Finally, a word of caution: re running androidbuild.sh wipes any changes you may have
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    63
done in the build directory for the app!
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    64
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    65
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    66
For more complex projects, follow these instructions:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    67
    
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    68
1. Copy the android-project directory wherever you want to keep your projects
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    69
   and rename it to the name of your project.
10092
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
    70
2. Move or symlink this SDL directory into the "<project>/jni" directory
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
    71
3. Edit "<project>/jni/src/Android.mk" to include your source files
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    72
4. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    73
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    74
If you want to use the Eclipse IDE, skip to the Eclipse section below.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    75
10092
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
    76
5. Create "<project>/local.properties" and use that to point to the Android SDK directory, by writing a line with the following form:
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    77
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    78
       sdk.dir=PATH_TO_ANDROID_SDK
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
    79
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    80
6. Run 'ant debug' in android/project. This compiles the .java and eventually 
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    81
   creates a .apk with the native code embedded
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    82
7. 'ant debug install' will push the apk to the device or emulator (if connected)
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    83
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    84
Here's an explanation of the files in the Android project, so you can customize them:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
    85
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    86
    android-project/
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    87
        AndroidManifest.xml	- package manifest. Among others, it contains the class name
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    88
        			  of the main Activity and the package name of the application.
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    89
        build.properties	- empty
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    90
        build.xml		- build description file, used by ant. The actual application name
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    91
        			  is specified here.
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    92
        default.properties	- holds the target ABI for the application, android-10 and up
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    93
        project.properties	- holds the target ABI for the application, android-10 and up
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    94
        local.properties	- holds the SDK path, you should change this to the path to your SDK
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    95
        jni/			- directory holding native code
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    96
        jni/Android.mk		- Android makefile that can call recursively the Android.mk files
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    97
        			  in all subdirectories
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    98
        jni/SDL/		- (symlink to) directory holding the SDL library files
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
    99
        jni/SDL/Android.mk	- Android makefile for creating the SDL shared library
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   100
        jni/src/		- directory holding your C/C++ source
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   101
        jni/src/Android.mk	- Android makefile that you should customize to include your 
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   102
                                  source code and any library references
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   103
        res/			- directory holding resources for your application
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   104
        res/drawable-*		- directories holding icons for different phone hardware. Could be
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   105
        			  one dir called "drawable".
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   106
        res/layout/main.xml	- Usually contains a file main.xml, which declares the screen layout.
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   107
        			  We don't need it because we use the SDL video output.
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   108
        res/values/strings.xml	- strings used in your application, including the application name
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   109
        			  shown on the phone.
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   110
        src/org/libsdl/app/SDLActivity.java - the Java class handling the initialization and binding
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   111
        			  to SDL.  Be very careful changing this, as the SDL library relies
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   112
        			  on this implementation.
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   113
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   114
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   115
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   116
 Build an app with static linking of libSDL
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   117
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   118
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   119
This build uses the Android NDK module system.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   120
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   121
Instructions:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   122
1. Copy the android-project directory wherever you want to keep your projects
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   123
   and rename it to the name of your project.
10092
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
   124
2. Rename "<project>/jni/src/Android_static.mk" to "<project>/jni/src/Android.mk"
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   125
   (overwrite the existing one)
10092
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
   126
3. Edit "<project>/jni/src/Android.mk" to include your source files
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   127
4. create and export an environment variable named NDK_MODULE_PATH that points
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   128
   to the parent directory of this SDL directory. e.g.:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   129
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   130
       export NDK_MODULE_PATH="$PWD"/..
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   131
10092
f1949a74dce5 Fixed doxygen warnings about markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9066
diff changeset
   132
5. Edit "<project>/src/org/libsdl/app/SDLActivity.java" and remove the call to
9065
c8a8b11fd0ad Updated README.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9055
diff changeset
   133
   System.loadLibrary("SDL2").
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   134
6. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   135
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   136
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   137
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   138
 Customizing your application name
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   139
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   140
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   141
To customize your application name, edit AndroidManifest.xml and replace
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   142
"org.libsdl.app" with an identifier for your product package.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   143
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   144
Then create a Java class extending SDLActivity and place it in a directory
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   145
under src matching your package, e.g.
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   146
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   147
    src/com/gamemaker/game/MyGame.java
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   148
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   149
Here's an example of a minimal class file:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   150
9050
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   151
    --- MyGame.java --------------------------
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   152
    package com.gamemaker.game;
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   153
    
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   154
    import org.libsdl.app.SDLActivity; 
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   155
    
9065
c8a8b11fd0ad Updated README.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9055
diff changeset
   156
    /**
9050
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   157
     * A sample wrapper class that just calls SDLActivity 
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   158
     */ 
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   159
    
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   160
    public class MyGame extends SDLActivity { }
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   161
    
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   162
    ------------------------------------------
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   163
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   164
Then replace "SDLActivity" in AndroidManifest.xml with the name of your
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   165
class, .e.g. "MyGame"
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   166
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   167
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   168
 Customizing your application icon
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   169
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   170
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   171
Conceptually changing your icon is just replacing the "ic_launcher.png" files in
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   172
the drawable directories under the res directory. There are four directories for
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   173
different screen sizes. These can be replaced with one dir called "drawable",
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   174
containing an icon file "ic_launcher.png" with dimensions 48x48 or 72x72.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   175
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   176
You may need to change the name of your icon in AndroidManifest.xml to match
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   177
this icon filename.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   178
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   179
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   180
 Loading assets
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   181
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   182
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   183
Any files you put in the "assets" directory of your android-project directory
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   184
will get bundled into the application package and you can load them using the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   185
standard functions in SDL_rwops.h.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   186
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   187
There are also a few Android specific functions that allow you to get other
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   188
useful paths for saving and loading data:
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   189
* SDL_AndroidGetInternalStoragePath()
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   190
* SDL_AndroidGetExternalStorageState()
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   191
* SDL_AndroidGetExternalStoragePath()
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   192
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   193
See SDL_system.h for more details on these functions.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   194
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   195
The asset packaging system will, by default, compress certain file extensions.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   196
SDL includes two asset file access mechanisms, the preferred one is the so
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   197
called "File Descriptor" method, which is faster and doesn't involve the Dalvik
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   198
GC, but given this method does not work on compressed assets, there is also the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   199
"Input Stream" method, which is automatically used as a fall back by SDL. You
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   200
may want to keep this fact in mind when building your APK, specially when large
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   201
files are involved.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   202
For more information on which extensions get compressed by default and how to
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   203
disable this behaviour, see for example:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   204
    
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   205
http://ponystyle.com/blog/2010/03/26/dealing-with-asset-compression-in-android-apps/
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   206
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   207
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   208
 Pause / Resume behaviour
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   209
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   210
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   211
If SDL is compiled with SDL_ANDROID_BLOCK_ON_PAUSE defined (the default),
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   212
the event loop will block itself when the app is paused (ie, when the user
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   213
returns to the main Android dashboard). Blocking is better in terms of battery
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   214
use, and it allows your app to spring back to life instantaneously after resume
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   215
(versus polling for a resume message).
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   216
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   217
Upon resume, SDL will attempt to restore the GL context automatically.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   218
In modern devices (Android 3.0 and up) this will most likely succeed and your
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   219
app can continue to operate as it was.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   220
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   221
However, there's a chance (on older hardware, or on systems under heavy load),
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   222
where the GL context can not be restored. In that case you have to listen for
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   223
a specific message, (which is not yet implemented!) and restore your textures
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   224
manually or quit the app (which is actually the kind of behaviour you'll see
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   225
under iOS, if the OS can not restore your GL context it will just kill your app)
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   226
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   227
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   228
 Threads and the Java VM
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   229
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   230
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   231
For a quick tour on how Linux native threads interoperate with the Java VM, take
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   232
a look here: http://developer.android.com/guide/practices/jni.html
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   233
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   234
If you want to use threads in your SDL app, it's strongly recommended that you
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   235
do so by creating them using SDL functions. This way, the required attach/detach
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   236
handling is managed by SDL automagically. If you have threads created by other
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   237
means and they make calls to SDL functions, make sure that you call
9065
c8a8b11fd0ad Updated README.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9055
diff changeset
   238
Android_JNI_SetupThread() before doing anything else otherwise SDL will attach
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   239
your thread automatically anyway (when you make an SDL call), but it'll never
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   240
detach it.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   241
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   242
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   243
 Using STL
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   244
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   245
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   246
You can use STL in your project by creating an Application.mk file in the jni
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   247
folder and adding the following line:
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   248
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   249
    APP_STL := stlport_static
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   250
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   251
For more information check out CPLUSPLUS-SUPPORT.html in the NDK documentation.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   252
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   253
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   254
 Additional documentation
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   255
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   256
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   257
The documentation in the NDK docs directory is very helpful in understanding the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   258
build process and how to work with native code on the Android platform.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   259
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   260
The best place to start is with docs/OVERVIEW.TXT
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   261
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   262
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   263
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   264
 Using Eclipse
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   265
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   266
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   267
First make sure that you've installed Eclipse and the Android extensions as described here:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   268
	http://developer.android.com/tools/sdk/eclipse-adt.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   269
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   270
Once you've copied the SDL android project and customized it, you can create an Eclipse project from it:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   271
 * File -> New -> Other
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   272
 * Select the Android -> Android Project wizard and click Next
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   273
 * Enter the name you'd like your project to have
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   274
 * Select "Create project from existing source" and browse for your project directory
9065
c8a8b11fd0ad Updated README.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9055
diff changeset
   275
 * Make sure the Build Target is set to Android 3.1 (API 12)
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   276
 * Click Finish
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   277
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   278
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   279
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   280
 Using the emulator
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   281
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   282
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   283
There are some good tips and tricks for getting the most out of the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   284
emulator here: http://developer.android.com/tools/devices/emulator.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   285
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   286
Especially useful is the info on setting up OpenGL ES 2.0 emulation.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   287
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   288
Notice that this software emulator is incredibly slow and needs a lot of disk space.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   289
Using a real device works better.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   290
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   291
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   292
 Troubleshooting
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   293
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   294
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   295
You can create and run an emulator from the Eclipse IDE:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   296
 * Window -> Android SDK and AVD Manager
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   297
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   298
You can see if adb can see any devices with the following command:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   299
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   300
    adb devices
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   301
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   302
You can see the output of log messages on the default device with:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   303
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   304
    adb logcat
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   305
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   306
You can push files to the device with:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   307
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   308
    adb push local_file remote_path_and_file
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   309
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   310
You can push files to the SD Card at /sdcard, for example:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   311
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   312
    adb push moose.dat /sdcard/moose.dat
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   313
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   314
You can see the files on the SD card with a shell command:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   315
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   316
    adb shell ls /sdcard/
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   317
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   318
You can start a command shell on the default device with:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   319
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   320
    adb shell
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   321
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   322
You can remove the library files of your project (and not the SDL lib files) with:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   323
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   324
    ndk-build clean
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   325
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   326
You can do a build with the following command:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   327
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   328
    ndk-build
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   329
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   330
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   331
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   332
    ndk-build V=1
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   333
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   334
If your application crashes in native code, you can use addr2line to convert the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   335
addresses in the stack trace to lines in your code.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   336
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   337
For example, if your crash looks like this:
9050
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   338
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   339
    I/DEBUG   (   31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   340
    I/DEBUG   (   31):  r0 00000000  r1 00001000  r2 00000003  r3 400085d4
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   341
    I/DEBUG   (   31):  r4 400085d0  r5 40008000  r6 afd41504  r7 436c6a7c
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   342
    I/DEBUG   (   31):  r8 436c6b30  r9 435c6fb0  10 435c6f9c  fp 4168d82c
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   343
    I/DEBUG   (   31):  ip 8346aff0  sp 436c6a60  lr afd1c8ff  pc afd1c902  cpsr 60000030
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   344
    I/DEBUG   (   31):          #00  pc 0001c902  /system/lib/libc.so
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   345
    I/DEBUG   (   31):          #01  pc 0001ccf6  /system/lib/libc.so
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   346
    I/DEBUG   (   31):          #02  pc 000014bc  /data/data/org.libsdl.app/lib/libmain.so
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   347
    I/DEBUG   (   31):          #03  pc 00001506  /data/data/org.libsdl.app/lib/libmain.so
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   348
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   349
You can see that there's a crash in the C library being called from the main code.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   350
I run addr2line with the debug version of my code:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   351
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   352
    arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   353
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   354
and then paste in the number after "pc" in the call stack, from the line that I care about:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   355
000014bc
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   356
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   357
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   358
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   359
You can add logging to your code to help show what's happening:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   360
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   361
    #include <android/log.h>
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   362
    
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   363
    __android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   364
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   365
If you need to build without optimization turned on, you can create a file called
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   366
"Application.mk" in the jni directory, with the following line in it:
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   367
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   368
    APP_OPTIM := debug
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   369
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   370
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   371
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   372
 Memory debugging
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   373
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   374
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   375
The best (and slowest) way to debug memory issues on Android is valgrind.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   376
Valgrind has support for Android out of the box, just grab code using:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   377
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   378
    svn co svn://svn.valgrind.org/valgrind/trunk valgrind
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   379
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   380
... and follow the instructions in the file README.android to build it.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   381
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   382
One thing I needed to do on Mac OS X was change the path to the toolchain,
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   383
and add ranlib to the environment variables:
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   384
export RANLIB=$NDKROOT/toolchains/arm-linux-androideabi-4.4.3/prebuilt/darwin-x86/bin/arm-linux-androideabi-ranlib
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   385
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   386
Once valgrind is built, you can create a wrapper script to launch your
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   387
application with it, changing org.libsdl.app to your package identifier:
9050
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   388
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   389
    --- start_valgrind_app -------------------
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   390
    #!/system/bin/sh
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   391
    export TMPDIR=/data/data/org.libsdl.app
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   392
    exec /data/local/Inst/bin/valgrind --log-file=/sdcard/valgrind.log --error-limit=no $*
bc9616da37cd Fixed doxygen warning and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9025
diff changeset
   393
    ------------------------------------------
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   394
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   395
Then push it to the device:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   396
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   397
    adb push start_valgrind_app /data/local
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   398
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   399
and make it executable:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   400
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   401
    adb shell chmod 755 /data/local/start_valgrind_app
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   402
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   403
and tell Android to use the script to launch your application:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   404
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   405
    adb shell setprop wrap.org.libsdl.app "logwrapper /data/local/start_valgrind_app"
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   406
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   407
If the setprop command says "could not set property", it's likely that
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   408
your package name is too long and you should make it shorter by changing
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   409
AndroidManifest.xml and the path to your class file in android-project/src
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   410
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   411
You can then launch your application normally and waaaaaaaiiittt for it.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   412
You can monitor the startup process with the logcat command above, and
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   413
when it's done (or even while it's running) you can grab the valgrind
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   414
output file:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   415
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   416
    adb pull /sdcard/valgrind.log
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   417
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   418
When you're done instrumenting with valgrind, you can disable the wrapper:
9055
868b523403e0 Fixed doxygen warnings and markdown formatting.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9050
diff changeset
   419
9066
c2af3ff967cc Fixed markdown formatting in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9065
diff changeset
   420
    adb shell setprop wrap.org.libsdl.app ""
9023
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   421
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   422
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   423
 Why is API level 10 the minimum required?
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   424
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   425
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   426
API level 10 is the minimum required level at runtime (that is, on the device) 
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   427
because SDL requires some functionality for running not
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   428
available on older devices. Since the incorporation of joystick support into SDL,
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   429
the minimum SDK required to *build* SDL is version 12. Devices running API levels
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   430
10-11 are still supported, only with the joystick functionality disabled.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   431
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   432
Support for native OpenGL ES and ES2 applications was introduced in the NDK for
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   433
API level 4 and 8. EGL was made a stable API in the NDK for API level 9, which
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   434
has since then been obsoleted, with the recommendation to developers to bump the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   435
required API level to 10.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   436
As of this writing, according to http://developer.android.com/about/dashboards/index.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   437
about 90% of the Android devices accessing Google Play support API level 10 or
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   438
higher (March 2013).
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   439
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   440
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   441
 A note regarding the use of the "dirty rectangles" rendering technique
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   442
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   443
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   444
If your app uses a variation of the "dirty rectangles" rendering technique,
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   445
where you only update a portion of the screen on each frame, you may notice a
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   446
variety of visual glitches on Android, that are not present on other platforms.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   447
This is caused by SDL's use of EGL as the support system to handle OpenGL ES/ES2
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   448
contexts, in particular the use of the eglSwapBuffers function. As stated in the
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   449
documentation for the function "The contents of ancillary buffers are always 
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   450
undefined after calling eglSwapBuffers".
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   451
Setting the EGL_SWAP_BEHAVIOR attribute of the surface to EGL_BUFFER_PRESERVED
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   452
is not possible for SDL as it requires EGL 1.4, available only on the API level
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   453
17+, so the only workaround available on this platform is to redraw the entire
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   454
screen each frame.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   455
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   456
Reference: http://www.khronos.org/registry/egl/specs/EGLTechNote0001.html
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   457
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   458
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   459
 Known issues
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   460
================================================================================
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   461
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   462
- The number of buttons reported for each joystick is hardcoded to be 36, which
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   463
is the current maximum number of buttons Android can report.
276802355854 Rearrange documentation
Gabriel Jacobo <gabomdq@gmail.com>
parents:
diff changeset
   464