include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 09 Mar 2014 11:06:11 -0700
changeset 8582 c3e9a2b93517
parent 8535 e8ee0708ef5c
child 8583 fb2933ca805f
permissions -rw-r--r--
Fixed line endings on WinRT source code
     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 #include "SDL_keyboard.h"
    33 #include "SDL_render.h"
    34 #include "SDL_video.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 extern "C" {
    40 #endif
    41 
    42 
    43 /* Platform specific functions for Windows */
    44 #ifdef __WIN32__
    45 
    46 /* Returns the D3D9 adapter index that matches the specified display index.
    47    This adapter index can be passed to IDirect3D9::CreateDevice and controls
    48    on which monitor a full screen application will appear.
    49 */
    50 extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
    51 
    52 /* Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
    53    Once you are done using the device, you should release it to avoid a resource leak.
    54  */
    55 typedef struct IDirect3DDevice9 IDirect3DDevice9;
    56 extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
    57 
    58 #endif /* __WIN32__ */
    59 
    60 
    61 /* Platform specific functions for iOS */
    62 #if defined(__IPHONEOS__) && __IPHONEOS__
    63 
    64 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    65 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    66 
    67 #endif /* __IPHONEOS__ */
    68 
    69 
    70 /* Platform specific functions for Android */
    71 #if defined(__ANDROID__) && __ANDROID__
    72 
    73 /* Get the JNI environment for the current thread
    74    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    75  */
    76 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    77 
    78 /* Get the SDL Activity object for the application
    79    This returns jobject, but the prototype is void* so we don't need jni.h
    80    The jobject returned by SDL_AndroidGetActivity is a local reference.
    81    It is the caller's responsibility to properly release it
    82    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
    83  */
    84 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
    85 
    86 /* See the official Android developer guide for more information:
    87    http://developer.android.com/guide/topics/data/data-storage.html
    88 */
    89 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
    90 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
    91 
    92 /* Get the path used for internal storage for this application.
    93    This path is unique to your application and cannot be written to
    94    by other applications.
    95  */
    96 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    97 
    98 /* Get the current state of external storage, a bitmask of these values:
    99     SDL_ANDROID_EXTERNAL_STORAGE_READ
   100     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   101    If external storage is currently unavailable, this will return 0.
   102 */
   103 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   104 
   105 /* Get the path used for external storage for this application.
   106    This path is unique to your application, but is public and can be
   107    written to by other applications.
   108  */
   109 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
   110 
   111 #endif /* __ANDROID__ */
   112 
   113 /* Platform specific functions for WinRT */
   114 #if defined(__WINRT__) && __WINRT__
   115 
   116 /**
   117  *  \brief WinRT / Windows Phone path types
   118  */
   119 typedef enum
   120 {
   121     /** \brief The installed app's root directory.
   122         Files here are likely to be read-only. */
   123     SDL_WINRT_PATH_INSTALLED_LOCATION,
   124 
   125     /** \brief The app's local data store.  Files may be written here */
   126     SDL_WINRT_PATH_LOCAL_FOLDER,
   127 
   128     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   129         Files written here may be copied to other machines via a network
   130         connection.
   131     */
   132     SDL_WINRT_PATH_ROAMING_FOLDER,
   133 
   134     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   135         Files written here may be deleted at any time. */
   136     SDL_WINRT_PATH_TEMP_FOLDER
   137 } SDL_WinRT_Path;
   138 
   139 
   140 /**
   141  *  \brief Retrieves a WinRT defined path on the local file system
   142  *
   143  *  \note Documentation on most app-specific path types on WinRT
   144  *      can be found on MSDN, at the URL:
   145  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   146  *
   147  *  \param pathType The type of path to retrieve.
   148  *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   149  *      if the path is not available for any reason.  Not all paths are
   150  *      available on all versions of Windows.  This is especially true on
   151  *      Windows Phone.  Check the documentation for the given
   152  *      SDL_WinRT_Path for more information on which path types are
   153  *      supported where.
   154  */
   155 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   156 
   157 /**
   158  *  \brief Retrieves a WinRT defined path on the local file system
   159  *
   160  *  \note Documentation on most app-specific path types on WinRT
   161  *      can be found on MSDN, at the URL:
   162  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   163  *
   164  *  \param pathType The type of path to retrieve.
   165  *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   166  *      if the path is not available for any reason.  Not all paths are
   167  *      available on all versions of Windows.  This is especially true on
   168  *      Windows Phone.  Check the documentation for the given
   169  *      SDL_WinRT_Path for more information on which path types are
   170  *      supported where.
   171  */
   172 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   173 
   174 #endif /* __WINRT__ */
   175 
   176 
   177 /* Ends C function definitions when using C++ */
   178 #ifdef __cplusplus
   179 }
   180 #endif
   181 #include "close_code.h"
   182 
   183 #endif /* _SDL_system_h */
   184 
   185 /* vi: set ts=4 sw=4 expandtab: */