include/SDL_system.h
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Sun, 02 Jun 2013 14:27:54 +0200
changeset 7264 23a5c8f4b312
parent 7191 75360622e65f
child 7742 84e32c3d415c
child 8477 ad08f0d710f3
permissions -rw-r--r--
Changed documentation in header because LocalReferenceHolder not public API.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     1
/*
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     2
  Simple DirectMedia Layer
6885
700f1b25f77f Happy New Year!
Sam Lantinga <slouken@libsdl.org>
parents: 6683
diff changeset
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     4
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     5
  This software is provided 'as-is', without any express or implied
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     6
  warranty.  In no event will the authors be held liable for any damages
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     7
  arising from the use of this software.
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     8
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     9
  Permission is granted to anyone to use this software for any purpose,
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    10
  including commercial applications, and to alter it and redistribute it
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    11
  freely, subject to the following restrictions:
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    12
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    13
  1. The origin of this software must not be misrepresented; you must not
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    14
     claim that you wrote the original software. If you use this software
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    15
     in a product, an acknowledgment in the product documentation would be
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    16
     appreciated but is not required.
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    17
  2. Altered source versions must be plainly marked as such, and must not be
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    18
     misrepresented as being the original software.
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    19
  3. This notice may not be removed or altered from any source distribution.
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    20
*/
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    21
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    22
/**
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    23
 *  \file SDL_system.h
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 7095
diff changeset
    24
 *
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    25
 *  Include file for platform specific SDL API functions
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    26
 */
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    27
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    28
#ifndef _SDL_system_h
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    29
#define _SDL_system_h
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    30
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    31
#include "SDL_stdinc.h"
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    32
6683
b1124b32b07d Fixed clang -Weverything warnings
Sam Lantinga <slouken@libsdl.org>
parents: 6654
diff changeset
    33
#if defined(__IPHONEOS__) && __IPHONEOS__
6392
fa7eb111f994 Fixed bug 1564 - SDL has no function to open a screen keyboard on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6346
diff changeset
    34
#include "SDL_video.h"
fa7eb111f994 Fixed bug 1564 - SDL has no function to open a screen keyboard on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6346
diff changeset
    35
#include "SDL_keyboard.h"
fa7eb111f994 Fixed bug 1564 - SDL has no function to open a screen keyboard on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6346
diff changeset
    36
#endif
fa7eb111f994 Fixed bug 1564 - SDL has no function to open a screen keyboard on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6346
diff changeset
    37
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    38
#include "begin_code.h"
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    39
/* Set up for C function definitions, even when using C++ */
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    40
#ifdef __cplusplus
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    41
extern "C" {
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    42
#endif
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    43
6635
e0c1f77597e3 Fixed compiler warnings about "/*" inside a multi-line comment.
Ryan C. Gordon <icculus@icculus.org>
parents: 6630
diff changeset
    44
/* Platform specific functions for iOS */
6683
b1124b32b07d Fixed clang -Weverything warnings
Sam Lantinga <slouken@libsdl.org>
parents: 6654
diff changeset
    45
#if defined(__IPHONEOS__) && __IPHONEOS__
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    46
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    47
extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
6346
56871d364efc Disable the SDL event pump after the SDL main routine returns, since events will be dispatched by the Cocoa event loop.
Sam Lantinga <slouken@libsdl.org>
parents: 6342
diff changeset
    48
extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    49
6630
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    50
#endif /* __IPHONEOS__ */
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    51
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    52
6636
e76e208521c3 More compiler warning fixes.
Ryan C. Gordon <icculus@icculus.org>
parents: 6635
diff changeset
    53
/* Platform specific functions for Android */
6683
b1124b32b07d Fixed clang -Weverything warnings
Sam Lantinga <slouken@libsdl.org>
parents: 6654
diff changeset
    54
#if defined(__ANDROID__) && __ANDROID__
6630
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    55
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    56
/* Get the JNI environment for the current thread
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    57
   This returns JNIEnv*, but the prototype is void* so we don't need jni.h
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    58
 */
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    59
extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    60
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    61
/* Get the SDL Activity object for the application
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    62
   This returns jobject, but the prototype is void* so we don't need jni.h
7095
79ca4d26d4b3 Moved warning about SDL_AndroidGetActivity to SDL_system.h
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6885
diff changeset
    63
   The jobject returned by SDL_AndroidGetActivity is a local reference.
79ca4d26d4b3 Moved warning about SDL_AndroidGetActivity to SDL_system.h
Gabriel Jacobo <gabomdq@gmail.com>
parents: 6885
diff changeset
    64
   It is the caller's responsibility to properly release it
7264
23a5c8f4b312 Changed documentation in header because LocalReferenceHolder not public API.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 7191
diff changeset
    65
   (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
6630
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    66
 */
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    67
extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    68
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    69
/* See the official Android developer guide for more information:
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    70
   http://developer.android.com/guide/topics/data/data-storage.html
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    71
*/
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    72
#define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    73
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    74
6646
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    75
/* Get the path used for internal storage for this application.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    76
   This path is unique to your application and cannot be written to
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    77
   by other applications.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    78
 */
6630
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    79
extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    80
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    81
/* Get the current state of external storage, a bitmask of these values:
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    82
    SDL_ANDROID_EXTERNAL_STORAGE_READ
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    83
    SDL_ANDROID_EXTERNAL_STORAGE_WRITE
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    84
   If external storage is currently unavailable, this will return 0.
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    85
*/
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    86
extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    87
6646
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    88
/* Get the path used for external storage for this application.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    89
   This path is unique to your application, but is public and can be
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    90
   written to by other applications.
dd32cce44d3c Added documentation on loading assets on Android.
Sam Lantinga <slouken@libsdl.org>
parents: 6636
diff changeset
    91
 */
6630
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    92
extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    93
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    94
#endif /* __ANDROID__ */
55910871076b Added some platform specific API functions for Android:
Sam Lantinga <slouken@libsdl.org>
parents: 6392
diff changeset
    95
6342
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    96
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    97
/* Ends C function definitions when using C++ */
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    98
#ifdef __cplusplus
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    99
}
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   100
#endif
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   101
#include "close_code.h"
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   102
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   103
#endif /* _SDL_system_h */
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   104
ac83b73f0edd Created a header file for system dependent API functions, and added SDL_iPhoneSetAnimationCallback()
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   105
/* vi: set ts=4 sw=4 expandtab: */