README.android
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Sat, 27 Apr 2013 14:26:15 +0200
changeset 7119 b0ad5dd4cabb
parent 7016 24edf0189bc5
child 7166 8d17ec58f019
permissions -rw-r--r--
Changed Java source file to use constant from API instead of just a String.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
     1
================================================================================
4726
9076cdb027af Cleanups.
Paul Hunkin <paul@bieh.net>
parents: 4725
diff changeset
     2
Simple DirectMedia Layer for Android
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
     3
================================================================================
4725
4eb9d3c7fdd2 Added initial README.android
Paul Hunkin <paul@bieh.net>
parents:
diff changeset
     4
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
     5
Requirements:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
     6
6962
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
     7
Android SDK (version 10 or later)
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
     8
http://developer.android.com/sdk/index.html
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
     9
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
    10
Android NDK r7 or later
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    11
http://developer.android.com/sdk/ndk/index.html
4725
4eb9d3c7fdd2 Added initial README.android
Paul Hunkin <paul@bieh.net>
parents:
diff changeset
    12
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
    13
Minimum API level supported by SDL: 10 (Android 2.3.3)
4967
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    14
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    15
================================================================================
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    16
 How the port works
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    17
================================================================================
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    18
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    19
- Android applications are Java-based, optionally with parts written in C
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    20
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to 
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    21
the SDL library
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
    22
- This means that your application C code must be placed inside an Android 
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    23
Java project, along with some C support code that communicates with Java
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    24
- This eventually produces a standard Android .apk package
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    25
4967
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    26
The Android Java code implements an "activity" and can be found in:
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    27
android-project/src/org/libsdl/app/SDLActivity.java
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    28
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    29
The Java code loads your game code, the SDL shared library, and
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    30
dispatches to native functions implemented in the SDL library:
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    31
src/SDL_android.cpp
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    32
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    33
Your project must include some glue code that starts your main() routine:
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    34
src/main/android/SDL_android_main.cpp
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    35
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    36
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    37
================================================================================
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    38
 Building an app
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    39
================================================================================
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
    40
4725
4eb9d3c7fdd2 Added initial README.android
Paul Hunkin <paul@bieh.net>
parents:
diff changeset
    41
Instructions:
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    42
1. Copy the android-project directory wherever you want to keep your projects
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    43
   and rename it to the name of your project.
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    44
2. Move or symlink this SDL directory into the <project>/jni directory
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    45
3. Edit <project>/jni/src/Android.mk to include your source files
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    46
4. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
    47
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
    48
If you want to use the Eclipse IDE, skip to the Eclipse section below.
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
    49
7016
24edf0189bc5 Fixed bug 1760 - Update README.android about local.properties
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    50
5. Create <project>/local.properties and use that to point to the Android SDK directory, by writing a line with the following form:
24edf0189bc5 Fixed bug 1760 - Update README.android about local.properties
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    51
sdk.dir=PATH_TO_ANDROID_SDK
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    52
6. Run 'ant debug' in android/project. This compiles the .java and eventually 
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    53
   creates a .apk with the native code embedded
6650
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
    54
7. 'ant debug install' will push the apk to the device or emulator (if connected)
4725
4eb9d3c7fdd2 Added initial README.android
Paul Hunkin <paul@bieh.net>
parents:
diff changeset
    55
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    56
Here's an explanation of the files in the Android project, so you can customize them:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    57
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    58
android-project/
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    59
	AndroidManifest.xml	- package manifest. Among others, it contains the class name
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    60
				  of the main activity.
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    61
	build.properties	- empty
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    62
	build.xml		- build description file, used by ant. The actual application name
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    63
				  is specified here.
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
    64
	default.properties	- holds the target ABI for the application, android-10 and up
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
    65
	project.properties	- holds the target ABI for the application, android-10 and up
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    66
	local.properties	- holds the SDK path, you should change this to the path to your SDK
4967
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    67
	jni/			- directory holding native code
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    68
	jni/Android.mk		- Android makefile that can call recursively the Android.mk files
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    69
				  in all subdirectories
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    70
	jni/SDL/		- (symlink to) directory holding the SDL library files
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    71
	jni/SDL/Android.mk	- Android makefile for creating the SDL shared library
4967
f74a3f94c408 Added some more information on how the port works
Sam Lantinga <slouken@libsdl.org>
parents: 4965
diff changeset
    72
	jni/src/		- directory holding your C/C++ source
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    73
	jni/src/Android.mk	- Android makefile that you should customize to include your 
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    74
                                  source code and any library references
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    75
	res/			- directory holding resources for your application
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    76
	res/drawable-*		- directories holding icons for different phone hardware. Could be
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    77
				  one dir called "drawable".
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    78
	res/layout/main.xml	- Usually contains a file main.xml, which declares the screen layout.
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    79
				  We don't need it because we use the SDL video output.
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    80
	res/values/strings.xml	- strings used in your application, including the application name
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    81
				  shown on the phone.
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    82
	src/org/libsdl/app/SDLActivity.java - the Java class handling the initialization and binding
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    83
				  to SDL.  Be very careful changing this, as the SDL library relies
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
    84
				  on this implementation.
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    85
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    86
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
    87
================================================================================
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    88
 Customizing your application name
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    89
================================================================================
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    90
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    91
To customize your application name, edit AndroidManifest.xml and replace
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    92
"org.libsdl.app" with an identifier for your product package.
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    93
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    94
Then create a Java class extending SDLActivity and place it in a directory
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    95
under src matching your package, e.g.
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    96
	src/com/gamemaker/game/MyGame.java
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    97
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    98
Here's an example of a minimal class file:
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
    99
--- MyGame.java --------------------------
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   100
package com.gamemaker.game;
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   101
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   102
import org.libsdl.app.SDLActivity; 
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   103
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   104
/* 
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   105
 * A sample wrapper class that just calls SDLActivity 
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   106
 */ 
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   107
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   108
public class MyGame extends SDLActivity { }
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   109
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   110
------------------------------------------
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   111
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   112
Then replace "SDLActivity" in AndroidManifest.xml with the name of your
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   113
class, .e.g. "MyGame"
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   114
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   115
================================================================================
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   116
 Customizing your application icon
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   117
================================================================================
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   118
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   119
Conceptually changing your icon is just replacing the icon.png files in the
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   120
drawable directories under the res directory. There are 3 directories for
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   121
different screen sizes. These can be replaced with 1 dir called 'drawable',
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   122
containing an icon file 'icon.png' with dimensions 48x48 or 72x72.
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   123
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   124
You may need to change the name of your icon in AndroidManifest.xml to match
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   125
this icon filename.
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   126
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   127
================================================================================
6646
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   128
 Loading assets
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   129
================================================================================
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   130
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   131
Any files you put in the "assets" directory of your android-project directory
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   132
will get bundled into the application package and you can load them using the
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   133
standard functions in SDL_rwops.h.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   134
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   135
There are also a few Android specific functions that allow you to get other
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   136
useful paths for saving and loading data:
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   137
SDL_AndroidGetInternalStoragePath()
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   138
SDL_AndroidGetExternalStorageState()
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   139
SDL_AndroidGetExternalStoragePath()
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   140
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   141
See SDL_system.h for more details on these functions.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   142
6816
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   143
The asset packaging system will, by default, compress certain file extensions.
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   144
SDL includes two asset file access mechanisms, the preferred one is the so
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   145
called "File Descriptor" method, which is faster and doesn't involve the Dalvik
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   146
GC, but given this method does not work on compressed assets, there is also the
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   147
"Input Stream" method, which is automatically used as a fall back by SDL. You
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   148
may want to keep this fact in mind when building your APK, specially when large
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   149
files are involved.
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   150
For more information on which extensions get compressed by default and how to
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   151
disable this behaviour, see for example:
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   152
    
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   153
http://ponystyle.com/blog/2010/03/26/dealing-with-asset-compression-in-android-apps/
b3d3ef1e15b5 Fixes bug 1696, thanks Paul Geerts!
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6678
diff changeset
   154
6646
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6631
diff changeset
   155
================================================================================
6330
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   156
 Pause / Resume behaviour
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   157
================================================================================
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   158
6664
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   159
If SDL is compiled with SDL_ANDROID_BLOCK_ON_PAUSE defined (the default),
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   160
the event loop will block itself when the app is paused (ie, when the user
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   161
returns to the main Android dashboard). Blocking is better in terms of battery
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   162
use, and it allows your app to spring back to life instantaneously after resume
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   163
(versus polling for a resume message).
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   164
6330
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   165
Upon resume, SDL will attempt to restore the GL context automatically.
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   166
In modern devices (Android 3.0 and up) this will most likely succeed and your
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   167
app can continue to operate as it was.
6664
2deb17aefbaf Improved default behavior for pause/resume on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6657
diff changeset
   168
6330
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   169
However, there's a chance (on older hardware, or on systems under heavy load),
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   170
where the GL context can not be restored. In that case you have to listen for
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   171
a specific message, (which is not yet implemented!) and restore your textures
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   172
manually or quit the app (which is actually the kind of behaviour you'll see
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   173
under iOS, if the OS can not restore your GL context it will just kill your app)
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   174
0fa55ca2efdd Fixes #1422, restores GL context automatically under Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6273
diff changeset
   175
================================================================================
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   176
 Threads and the Java VM
6354
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   177
================================================================================
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   178
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   179
For a quick tour on how Linux native threads interoperate with the Java VM, take
6354
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   180
a look here: http://developer.android.com/guide/practices/jni.html
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   181
If you want to use threads in your SDL app, it's strongly recommended that you
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   182
do so by creating them using SDL functions. This way, the required attach/detach
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   183
handling is managed by SDL automagically. If you have threads created by other
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   184
means and they make calls to SDL functions, make sure that you call
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   185
Android_JNI_SetupThread before doing anything else otherwise SDL will attach
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   186
your thread automatically anyway (when you make an SDL call), but it'll never
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   187
detach it.
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   188
17840f487124 Fixes #1422, removes global JNI Env, uses per thread copies, adds thread auto detaching.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6330
diff changeset
   189
================================================================================
6631
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   190
 Using STL
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   191
================================================================================
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   192
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   193
You can use STL in your project by creating an Application.mk file in the jni
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   194
folder and adding the following line:
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   195
APP_STL := stlport_static
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   196
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   197
For more information check out CPLUSPLUS-SUPPORT.html in the NDK documentation.
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   198
47ab7ba21530 Updated the Android project template and README.android
Sam Lantinga <slouken@libsdl.org>
parents: 6387
diff changeset
   199
================================================================================
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   200
 Additional documentation
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   201
================================================================================
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   202
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   203
The documentation in the NDK docs directory is very helpful in understanding the
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   204
build process and how to work with native code on the Android platform.
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   205
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   206
The best place to start is with docs/OVERVIEW.TXT
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   207
4725
4eb9d3c7fdd2 Added initial README.android
Paul Hunkin <paul@bieh.net>
parents:
diff changeset
   208
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   209
================================================================================
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   210
 Using Eclipse
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   211
================================================================================
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   212
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   213
First make sure that you've installed Eclipse and the Android extensions as described here:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   214
	http://developer.android.com/sdk/eclipse-adt.html
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   215
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   216
Once you've copied the SDL android project and customized it, you can create an Eclipse project from it:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   217
 * File -> New -> Other
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   218
 * Select the Android -> Android Project wizard and click Next
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   219
 * Enter the name you'd like your project to have
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   220
 * Select "Create project from existing source" and browse for your project directory
6387
58f0fb54bf88 Bumped up Android SDK version in README.android.
Ryan C. Gordon <icculus@icculus.org>
parents: 6354
diff changeset
   221
 * Make sure the Build Target is set to Android 2.0
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   222
 * Click Finish
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   223
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   224
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   225
================================================================================
6652
bb2a33ed8688 Added link to the emulator info, which is extremeley useful for testing OpenGL ES 2.0
Sam Lantinga <slouken@libsdl.org>
parents: 6650
diff changeset
   226
 Using the emulator
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   227
================================================================================
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   228
6652
bb2a33ed8688 Added link to the emulator info, which is extremeley useful for testing OpenGL ES 2.0
Sam Lantinga <slouken@libsdl.org>
parents: 6650
diff changeset
   229
There are some good tips and tricks for getting the most out of the
bb2a33ed8688 Added link to the emulator info, which is extremeley useful for testing OpenGL ES 2.0
Sam Lantinga <slouken@libsdl.org>
parents: 6650
diff changeset
   230
emulator here: http://developer.android.com/tools/devices/emulator.html
bb2a33ed8688 Added link to the emulator info, which is extremeley useful for testing OpenGL ES 2.0
Sam Lantinga <slouken@libsdl.org>
parents: 6650
diff changeset
   231
bb2a33ed8688 Added link to the emulator info, which is extremeley useful for testing OpenGL ES 2.0
Sam Lantinga <slouken@libsdl.org>
parents: 6650
diff changeset
   232
Especially useful is the info on setting up OpenGL ES 2.0 emulation.
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   233
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   234
Notice that this software emulator is incredibly slow and needs a lot of disk space.
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   235
Using a real device works better.
4964
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   236
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   237
================================================================================
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   238
 Troubleshooting
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   239
================================================================================
6c645018741e Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.
Sam Lantinga <slouken@libsdl.org>
parents: 4954
diff changeset
   240
4965
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   241
You can create and run an emulator from the Eclipse IDE:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   242
 * Window -> Android SDK and AVD Manager
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   243
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   244
You can see if adb can see any devices with the following command:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   245
	adb devices
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   246
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   247
You can see the output of log messages on the default device with:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   248
	adb logcat
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   249
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   250
You can push files to the device with:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   251
	adb push local_file remote_path_and_file
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   252
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   253
You can push files to the SD Card at /sdcard, for example:
91d0085b7560 Added the Android project and lots of info to README.android
Sam Lantinga <slouken@libsdl.org>
parents: 4964
diff changeset
   254
	adb push moose.dat /sdcard/moose.dat
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   255
4976
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   256
You can see the files on the SD card with a shell command:
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   257
	adb shell ls /sdcard/
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   258
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   259
You can start a command shell on the default device with:
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   260
	adb shell
3811132c584f Added information about starting a command shell on the device
Sam Lantinga <slouken@libsdl.org>
parents: 4975
diff changeset
   261
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   262
You can remove the library files of your project (and not the SDL lib files) with:
4975
6fbc7044f343 Added information about doing a clean build
Sam Lantinga <slouken@libsdl.org>
parents: 4974
diff changeset
   263
	ndk-build clean
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   264
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   265
You can do a build with the following command:
4975
6fbc7044f343 Added information about doing a clean build
Sam Lantinga <slouken@libsdl.org>
parents: 4974
diff changeset
   266
	ndk-build
6fbc7044f343 Added information about doing a clean build
Sam Lantinga <slouken@libsdl.org>
parents: 4974
diff changeset
   267
4973
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   268
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   269
	ndk-build V=1
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   270
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   271
If your application crashes in native code, you can use addr2line to convert the
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   272
addresses in the stack trace to lines in your code.
4973
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   273
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   274
For example, if your crash looks like this:
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   275
I/DEBUG   (   31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   276
I/DEBUG   (   31):  r0 00000000  r1 00001000  r2 00000003  r3 400085d4
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   277
I/DEBUG   (   31):  r4 400085d0  r5 40008000  r6 afd41504  r7 436c6a7c
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   278
I/DEBUG   (   31):  r8 436c6b30  r9 435c6fb0  10 435c6f9c  fp 4168d82c
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   279
I/DEBUG   (   31):  ip 8346aff0  sp 436c6a60  lr afd1c8ff  pc afd1c902  cpsr 60000030
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   280
I/DEBUG   (   31):          #00  pc 0001c902  /system/lib/libc.so
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   281
I/DEBUG   (   31):          #01  pc 0001ccf6  /system/lib/libc.so
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   282
I/DEBUG   (   31):          #02  pc 000014bc  /data/data/org.libsdl.app/lib/libmain.so
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   283
I/DEBUG   (   31):          #03  pc 00001506  /data/data/org.libsdl.app/lib/libmain.so
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   284
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   285
You can see that there's a crash in the C library being called from the main code.
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   286
I run addr2line with the debug version of my code:
4973
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   287
	arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   288
and then paste in the number after "pc" in the call stack, from the line that I care about:
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   289
000014bc
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   290
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   291
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   292
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   293
You can add logging to your code to help show what's happening:
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   294
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   295
#include <android/log.h>
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   296
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   297
	__android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
067b6ec8b751 Added information about decoding native stack traces
Sam Lantinga <slouken@libsdl.org>
parents: 4967
diff changeset
   298
6678
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   299
If you need to build without optimization turned on, you can create a file called
afb9be20f8d2 README.android improvements by W. Boeke, bug #1637
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6664
diff changeset
   300
"Application.mk" in the jni directory, with the following line in it:
4974
1cd0a891b69a Added info for building your code without optimizations on
Sam Lantinga <slouken@libsdl.org>
parents: 4973
diff changeset
   301
APP_OPTIM := debug
1cd0a891b69a Added info for building your code without optimizations on
Sam Lantinga <slouken@libsdl.org>
parents: 4973
diff changeset
   302
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   303
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   304
================================================================================
6650
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   305
 Memory debugging
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   306
================================================================================
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   307
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   308
The best (and slowest) way to debug memory issues on Android is valgrind.
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   309
Valgrind has support for Android out of the box, just grab code using:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   310
	svn co svn://svn.valgrind.org/valgrind/trunk valgrind
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   311
... and follow the instructions in the file README.android to build it.
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   312
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   313
One thing I needed to do on Mac OS X was change the path to the toolchain,
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   314
and add ranlib to the environment variables:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   315
export RANLIB=$NDKROOT/toolchains/arm-linux-androideabi-4.4.3/prebuilt/darwin-x86/bin/arm-linux-androideabi-ranlib
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   316
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   317
Once valgrind is built, you can create a wrapper script to launch your
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   318
application with it, changing org.libsdl.app to your package identifier:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   319
--- start_valgrind_app -------------------
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   320
#!/system/bin/sh
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   321
export TMPDIR=/data/data/org.libsdl.app
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   322
exec /data/local/Inst/bin/valgrind --log-file=/sdcard/valgrind.log --error-limit=no $*
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   323
------------------------------------------
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   324
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   325
Then push it to the device:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   326
	adb push start_valgrind_app /data/local
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   327
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   328
and make it executable:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   329
	adb shell chmod 755 /data/local/start_valgrind_app
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   330
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   331
and tell Android to use the script to launch your application:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   332
	adb shell setprop wrap.org.libsdl.app "logwrapper /data/local/start_valgrind_app"
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   333
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   334
If the setprop command says "could not set property", it's likely that
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   335
your package name is too long and you should make it shorter by changing
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   336
AndroidManifest.xml and the path to your class file in android-project/src
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   337
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   338
You can then launch your application normally and waaaaaaaiiittt for it.
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   339
You can monitor the startup process with the logcat command above, and
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   340
when it's done (or even while it's running) you can grab the valgrind
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   341
output file:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   342
	adb pull /sdcard/valgrind.log
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   343
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   344
When you're done instrumenting with valgrind, you can disable the wrapper:
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   345
	adb shell setprop wrap.org.libsdl.app ""
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   346
6962
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
   347
================================================================================
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
   348
 Why is API level 10 the minimum required?
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
   349
================================================================================
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
   350
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   351
API level 10 is required because SDL requires some functionality for running not
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   352
available on older devices and some for building which is not in older NDK/SDKs.
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   353
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   354
Support for native OpenGL ES and ES2 applications was introduced in the NDK for
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   355
API level 4 and 8. EGL was made a stable API in the NDK for API level 9, which
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   356
has since then been obsoleted, with the recommendation to developers to bump the
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   357
required API level to 10.
6962
6ce8edb5577b Updated the README.android file stating the required API level and reasons why.
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6816
diff changeset
   358
As of this writing, according to http://developer.android.com/about/dashboards/index.html
6987
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   359
about 90% of the Android devices accessing Google Play support API level 10 or
7084af936d82 Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.
Sam Lantinga <slouken@libsdl.org>
parents: 6979
diff changeset
   360
higher (March 2013).
6650
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   361
d36232135316 Added information on running valgrind on Android
Sam Lantinga <slouken@libsdl.org>
parents: 6646
diff changeset
   362
================================================================================
6979
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   363
 A note regarding the use of the "dirty rectangles" rendering technique
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   364
================================================================================
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   365
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   366
If your app uses a variation of the "dirty rectangles" rendering technique,
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   367
where you only update a portion of the screen on each frame, you may notice a
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   368
variety of visual glitches on Android, that are not present on other platforms.
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   369
This is caused by SDL's use of EGL as the support system to handle OpenGL ES/ES2
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   370
contexts, in particular the use of the eglSwapBuffers function. As stated in the
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   371
documentation for the function "The contents of ancillary buffers are always 
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   372
undefined after calling eglSwapBuffers".
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   373
Setting the EGL_SWAP_BEHAVIOR attribute of the surface to EGL_BUFFER_PRESERVED
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   374
is not possible for SDL as it requires EGL 1.4, available only on the API level
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   375
17+, so the only workaround available on this platform is to redraw the entire
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   376
screen each frame.
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   377
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   378
Reference: http://www.khronos.org/registry/egl/specs/EGLTechNote0001.html
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   379
8d6ab3bdc08b README.android updates regarding the use of dirty rectangles rendering technique
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6962
diff changeset
   380
================================================================================
4727
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   381
 Known issues
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   382
================================================================================
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   383
8087bb208acf Updated the readme
Paul Hunkin <paul@bieh.net>
parents: 4726
diff changeset
   384
- TODO. I'm sure there's a bunch more stuff I haven't thought of