Added documentation on loading assets on Android.
authorSam Lantinga <slouken@libsdl.org>
Sun, 04 Nov 2012 09:45:18 -0800
changeset 6646 dd32cce44d3c
parent 6645 3f83af6d119c
child 6650 d36232135316
Added documentation on loading assets on Android.
README.android
include/SDL_system.h
--- a/README.android	Sun Nov 04 08:51:43 2012 -0800
+++ b/README.android	Sun Nov 04 09:45:18 2012 -0800
@@ -124,6 +124,22 @@
 the filename used by Eclipse.
 
 ================================================================================
+ Loading assets
+================================================================================
+
+Any files you put in the "assets" directory of your android-project directory
+will get bundled into the application package and you can load them using the
+standard functions in SDL_rwops.h.
+
+There are also a few Android specific functions that allow you to get other
+useful paths for saving and loading data:
+SDL_AndroidGetInternalStoragePath()
+SDL_AndroidGetExternalStorageState()
+SDL_AndroidGetExternalStoragePath()
+
+See SDL_system.h for more details on these functions.
+
+================================================================================
  Pause / Resume behaviour
 ================================================================================
 
--- a/include/SDL_system.h	Sun Nov 04 08:51:43 2012 -0800
+++ b/include/SDL_system.h	Sun Nov 04 09:45:18 2012 -0800
@@ -76,7 +76,10 @@
 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
 
-/* Get the path used for internal storage for this application */
+/* Get the path used for internal storage for this application.
+   This path is unique to your application and cannot be written to
+   by other applications.
+ */
 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
 
 /* Get the current state of external storage, a bitmask of these values:
@@ -86,7 +89,10 @@
 */
 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
 
-/* Get the path used for external storage for this application */
+/* Get the path used for external storage for this application.
+   This path is unique to your application, but is public and can be
+   written to by other applications.
+ */
 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
 
 #endif /* __ANDROID__ */