include/SDL_system.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 12 Apr 2015 21:02:21 -0400
changeset 9556 db92b9d74129
parent 9540 32ddc92d78cf
child 9597 345bc53b52b8
permissions -rw-r--r--
Patched to compile on C89 compilers.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 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 /**
    47    \brief Returns the D3D9 adapter index that matches the specified display index.
    48 
    49    This adapter index can be passed to IDirect3D9::CreateDevice and controls
    50    on which monitor a full screen application will appear.
    51 */
    52 extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
    53 
    54 typedef struct IDirect3DDevice9 IDirect3DDevice9;
    55 /**
    56    \brief Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
    57 
    58    Once you are done using the device, you should release it to avoid a resource leak.
    59  */
    60 extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
    61 
    62 /**
    63    \brief Returns the DXGI Adapter and Output indices for the specified display index.
    64 
    65    These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
    66    required to create a DX10 or DX11 device and swap chain.
    67  */
    68 extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
    69 
    70 #endif /* __WIN32__ */
    71 
    72 
    73 /* Platform specific functions for iOS */
    74 #if defined(__IPHONEOS__) && __IPHONEOS__
    75 
    76 #define SDL_iOSSetAnimationCallback(window, interval, callback, callbackParam) SDL_iPhoneSetAnimationCallback(window, interval, callback, callbackParam)
    77 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    78 
    79 #define SDL_iOSSetEventPump(enabled) SDL_iPhoneSetEventPump(enabled)
    80 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    81 
    82 #endif /* __IPHONEOS__ */
    83 
    84 
    85 /* Platform specific functions for Android */
    86 #if defined(__ANDROID__) && __ANDROID__
    87 
    88 /**
    89    \brief Get the JNI environment for the current thread
    90 
    91    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    92  */
    93 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    94 
    95 /**
    96    \brief Get the SDL Activity object for the application
    97 
    98    This returns jobject, but the prototype is void* so we don't need jni.h
    99    The jobject returned by SDL_AndroidGetActivity is a local reference.
   100    It is the caller's responsibility to properly release it
   101    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
   102  */
   103 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
   104 
   105 /**
   106    See the official Android developer guide for more information:
   107    http://developer.android.com/guide/topics/data/data-storage.html
   108 */
   109 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   110 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   111 
   112 /**
   113    \brief Get the path used for internal storage for this application.
   114 
   115    This path is unique to your application and cannot be written to
   116    by other applications.
   117  */
   118 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
   119 
   120 /**
   121    \brief Get the current state of external storage, a bitmask of these values:
   122     SDL_ANDROID_EXTERNAL_STORAGE_READ
   123     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   124 
   125    If external storage is currently unavailable, this will return 0.
   126 */
   127 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   128 
   129 /**
   130    \brief Get the path used for external storage for this application.
   131 
   132    This path is unique to your application, but is public and can be
   133    written to by other applications.
   134  */
   135 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
   136 
   137 #endif /* __ANDROID__ */
   138 
   139 /* Platform specific functions for WinRT */
   140 #if defined(__WINRT__) && __WINRT__
   141 
   142 /**
   143  *  \brief WinRT / Windows Phone path types
   144  */
   145 typedef enum
   146 {
   147     /** \brief The installed app's root directory.
   148         Files here are likely to be read-only. */
   149     SDL_WINRT_PATH_INSTALLED_LOCATION,
   150 
   151     /** \brief The app's local data store.  Files may be written here */
   152     SDL_WINRT_PATH_LOCAL_FOLDER,
   153 
   154     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   155         Files written here may be copied to other machines via a network
   156         connection.
   157     */
   158     SDL_WINRT_PATH_ROAMING_FOLDER,
   159 
   160     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   161         Files written here may be deleted at any time. */
   162     SDL_WINRT_PATH_TEMP_FOLDER
   163 } SDL_WinRT_Path;
   164 
   165 
   166 /**
   167  *  \brief Retrieves a WinRT defined path on the local file system
   168  *
   169  *  \note Documentation on most app-specific path types on WinRT
   170  *      can be found on MSDN, at the URL:
   171  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   172  *
   173  *  \param pathType The type of path to retrieve.
   174  *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   175  *      if the path is not available for any reason.  Not all paths are
   176  *      available on all versions of Windows.  This is especially true on
   177  *      Windows Phone.  Check the documentation for the given
   178  *      SDL_WinRT_Path for more information on which path types are
   179  *      supported where.
   180  */
   181 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   182 
   183 /**
   184  *  \brief Retrieves a WinRT defined path on the local file system
   185  *
   186  *  \note Documentation on most app-specific path types on WinRT
   187  *      can be found on MSDN, at the URL:
   188  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   189  *
   190  *  \param pathType The type of path to retrieve.
   191  *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   192  *      if the path is not available for any reason.  Not all paths are
   193  *      available on all versions of Windows.  This is especially true on
   194  *      Windows Phone.  Check the documentation for the given
   195  *      SDL_WinRT_Path for more information on which path types are
   196  *      supported where.
   197  */
   198 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   199 
   200 #endif /* __WINRT__ */
   201 
   202 /* Ends C function definitions when using C++ */
   203 #ifdef __cplusplus
   204 }
   205 #endif
   206 #include "close_code.h"
   207 
   208 #endif /* _SDL_system_h */
   209 
   210 /* vi: set ts=4 sw=4 expandtab: */