src/SDL2/SDL_system.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
   4
   5   This software is provided 'as-is', without any express or implied
   6   warranty.  In no event will the authors be held liable for any damages
   7   arising from the use of this software.
   8
   9   Permission is granted to anyone to use this software for any purpose,
  10   including commercial applications, and to alter it and redistribute it
  11   freely, subject to the following restrictions:
  12
  13   1. The origin of this software must not be misrepresented; you must not
  14      claim that you wrote the original software. If you use this software
  15      in a product, an acknowledgment in the product documentation would be
  16      appreciated but is not required.
  17   2. Altered source versions must be plainly marked as such, and must not be
  18      misrepresented as being the original software.
  19   3. This notice may not be removed or altered from any source distribution.
  20 */
  21
  22 /**
  23  *  \file SDL_system.h
  24  *
  25  *  Include file for platform specific SDL API functions
  26  */
  27
  28 #ifndef _SDL_system_h
  29 #define _SDL_system_h
  30
  31 #include "SDL_stdinc.h"
  32
  33 #if defined(__IPHONEOS__) && __IPHONEOS__
  34 #include "SDL_video.h"
  35 #include "SDL_keyboard.h"
  36 #endif
  37
  38 #include "begin_code.h"
  39 /* Set up for C function definitions, even when using C++ */
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /* Platform specific functions for iOS */
  45 #if defined(__IPHONEOS__) && __IPHONEOS__
  46
  47 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
  48 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
  49
  50 #endif /* __IPHONEOS__ */
  51
  52
  53 /* Platform specific functions for Android */
  54 #if defined(__ANDROID__) && __ANDROID__
  55
  56 /* Get the JNI environment for the current thread
  57    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
  58  */
  59 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
  60
  61 /* Get the SDL Activity object for the application
  62    This returns jobject, but the prototype is void* so we don't need jni.h
  63    The jobject returned by SDL_AndroidGetActivity is a local reference.
  64    It is the caller's responsibility to properly release it
  65    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
  66  */
  67 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
  68
  69 /* See the official Android developer guide for more information:
  70    http://developer.android.com/guide/topics/data/data-storage.html
  71 */
  72 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
  73 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
  74
  75 /* Get the path used for internal storage for this application.
  76    This path is unique to your application and cannot be written to
  77    by other applications.
  78  */
  79 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
  80
  81 /* Get the current state of external storage, a bitmask of these values:
  82     SDL_ANDROID_EXTERNAL_STORAGE_READ
  83     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
  84    If external storage is currently unavailable, this will return 0.
  85 */
  86 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
  87
  88 /* Get the path used for external storage for this application.
  89    This path is unique to your application, but is public and can be
  90    written to by other applications.
  91  */
  92 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
  93
  94 #endif /* __ANDROID__ */
  95
  96
  97 /* Ends C function definitions when using C++ */
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101 #include "close_code.h"
 102
 103 #endif /* _SDL_system_h */
 104
 105 /* vi: set ts=4 sw=4 expandtab: */