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