include/SDL_system.h
author David Ludwig <dludwig@pobox.com>
Mon, 01 Apr 2013 21:33:06 -0400
changeset 8453 499aa167ea79
parent 8439 14d94a8a9fb6
child 8477 ad08f0d710f3
permissions -rw-r--r--
WinRT: made WinRT path retrieval be available in both UCS-2 and UTF-8 flavors
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@6342
    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
/* *INDENT-OFF* */
slouken@6342
    42
extern "C" {
slouken@6342
    43
/* *INDENT-ON* */
slouken@6342
    44
#endif
slouken@6342
    45
icculus@6635
    46
/* Platform specific functions for iOS */
slouken@6683
    47
#if defined(__IPHONEOS__) && __IPHONEOS__
slouken@6342
    48
slouken@6342
    49
extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
slouken@6346
    50
extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
slouken@6342
    51
slouken@6630
    52
#endif /* __IPHONEOS__ */
slouken@6630
    53
slouken@6630
    54
icculus@6636
    55
/* Platform specific functions for Android */
slouken@6683
    56
#if defined(__ANDROID__) && __ANDROID__
slouken@6630
    57
slouken@6630
    58
/* Get the JNI environment for the current thread
slouken@6630
    59
   This returns JNIEnv*, but the prototype is void* so we don't need jni.h
slouken@6630
    60
 */
slouken@6630
    61
extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
slouken@6630
    62
slouken@6630
    63
/* Get the SDL Activity object for the application
slouken@6630
    64
   This returns jobject, but the prototype is void* so we don't need jni.h
slouken@6630
    65
 */
slouken@6630
    66
extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
slouken@6630
    67
slouken@6630
    68
/* See the official Android developer guide for more information:
slouken@6630
    69
   http://developer.android.com/guide/topics/data/data-storage.html
slouken@6630
    70
*/
slouken@6630
    71
#define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
slouken@6630
    72
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
slouken@6630
    73
slouken@6646
    74
/* Get the path used for internal storage for this application.
slouken@6646
    75
   This path is unique to your application and cannot be written to
slouken@6646
    76
   by other applications.
slouken@6646
    77
 */
slouken@6630
    78
extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
slouken@6630
    79
slouken@6630
    80
/* Get the current state of external storage, a bitmask of these values:
slouken@6630
    81
    SDL_ANDROID_EXTERNAL_STORAGE_READ
slouken@6630
    82
    SDL_ANDROID_EXTERNAL_STORAGE_WRITE
slouken@6630
    83
   If external storage is currently unavailable, this will return 0.
slouken@6630
    84
*/
slouken@6630
    85
extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
slouken@6630
    86
slouken@6646
    87
/* Get the path used for external storage for this application.
slouken@6646
    88
   This path is unique to your application, but is public and can be
slouken@6646
    89
   written to by other applications.
slouken@6646
    90
 */
slouken@6630
    91
extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
slouken@6630
    92
slouken@6630
    93
#endif /* __ANDROID__ */
slouken@6630
    94
slouken@6342
    95
dludwig@8388
    96
/* Platform specific functions for Windows RT */
dludwig@8388
    97
#if defined(__WINRT__) && __WINRT__
dludwig@8388
    98
dludwig@8420
    99
/**
dludwig@8420
   100
 *  \brief Windows RT / Windows Phone path types
dludwig@8420
   101
 */
dludwig@8420
   102
typedef enum
dludwig@8420
   103
{
dludwig@8420
   104
    /** \brief The installed app's root directory.
dludwig@8420
   105
        Files here are likely to be read-only. */
dludwig@8420
   106
    SDL_WINRT_PATH_INSTALLED_LOCATION,
dludwig@8405
   107
dludwig@8420
   108
    /** \brief The app's local data store.  Files may be written here */
dludwig@8420
   109
    SDL_WINRT_PATH_LOCAL_FOLDER,
dludwig@8405
   110
dludwig@8420
   111
    /** \brief The app's roaming data store.  Unsupported on Windows Phone.
dludwig@8420
   112
        Files written here may be copied to other machines via a network
dludwig@8420
   113
        connection.
dludwig@8420
   114
    */
dludwig@8420
   115
    SDL_WINRT_PATH_ROAMING_FOLDER,
dludwig@8388
   116
dludwig@8420
   117
    /** \brief The app's temporary data store.  Unsupported on Windows Phone.
dludwig@8420
   118
        Files written here may be deleted at any time. */
dludwig@8420
   119
    SDL_WINRT_PATH_TEMP_FOLDER
dludwig@8420
   120
} SDL_WinRT_Path;
dludwig@8420
   121
dludwig@8420
   122
dludwig@8420
   123
/**
dludwig@8420
   124
 *  \brief Retrieves a Windows RT defined path on the local file system
dludwig@8420
   125
 *
dludwig@8420
   126
 *  \note Documentation on most app-specific path types on Windows RT
dludwig@8420
   127
 *      can be found on MSDN, at the URL:
dludwig@8420
   128
 *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
dludwig@8420
   129
 *
dludwig@8420
   130
 *  \param pathType The type of path to retrieve.
dludwig@8420
   131
 *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
dludwig@8420
   132
 *      if the path is not available for any reason.  Not all paths are
dludwig@8420
   133
 *      available on all versions of Windows.  This is especially true on
dludwig@8420
   134
 *      Windows Phone.  Check the documentation for the given
dludwig@8420
   135
 *      SDL_WinRT_Path for more information on which path types are
dludwig@8420
   136
 *      supported where.
dludwig@8388
   137
 */
dludwig@8453
   138
extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
dludwig@8453
   139
dludwig@8453
   140
/**
dludwig@8453
   141
 *  \brief Retrieves a Windows RT defined path on the local file system
dludwig@8453
   142
 *
dludwig@8453
   143
 *  \note Documentation on most app-specific path types on Windows RT
dludwig@8453
   144
 *      can be found on MSDN, at the URL:
dludwig@8453
   145
 *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
dludwig@8453
   146
 *
dludwig@8453
   147
 *  \param pathType The type of path to retrieve.
dludwig@8453
   148
 *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
dludwig@8453
   149
 *      if the path is not available for any reason.  Not all paths are
dludwig@8453
   150
 *      available on all versions of Windows.  This is especially true on
dludwig@8453
   151
 *      Windows Phone.  Check the documentation for the given
dludwig@8453
   152
 *      SDL_WinRT_Path for more information on which path types are
dludwig@8453
   153
 *      supported where.
dludwig@8453
   154
 */
dludwig@8453
   155
extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
dludwig@8453
   156
dludwig@8388
   157
dludwig@8388
   158
#endif /* __WINRT__ */
dludwig@8388
   159
dludwig@8388
   160
slouken@6342
   161
/* Ends C function definitions when using C++ */
slouken@6342
   162
#ifdef __cplusplus
slouken@6342
   163
/* *INDENT-OFF* */
slouken@6342
   164
}
slouken@6342
   165
/* *INDENT-ON* */
slouken@6342
   166
#endif
slouken@6342
   167
#include "close_code.h"
slouken@6342
   168
slouken@6342
   169
#endif /* _SDL_system_h */
slouken@6342
   170
slouken@6342
   171
/* vi: set ts=4 sw=4 expandtab: */