include/SDL_system.h
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Mon, 12 Jan 2015 23:20:52 +0100
changeset 9309 221b071c37d6
parent 8877 0d691f3734ac
child 9533 e5693e855338
permissions -rw-r--r--
Added and fixed doxygen markup in header file.
     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 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    77 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    78 
    79 #endif /* __IPHONEOS__ */
    80 
    81 
    82 /* Platform specific functions for Android */
    83 #if defined(__ANDROID__) && __ANDROID__
    84 
    85 /**
    86    \brief Get the JNI environment for the current thread
    87 
    88    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    89  */
    90 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    91 
    92 /**
    93    \brief Get the SDL Activity object for the application
    94 
    95    This returns jobject, but the prototype is void* so we don't need jni.h
    96    The jobject returned by SDL_AndroidGetActivity is a local reference.
    97    It is the caller's responsibility to properly release it
    98    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
    99  */
   100 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
   101 
   102 /**
   103    See the official Android developer guide for more information:
   104    http://developer.android.com/guide/topics/data/data-storage.html
   105 */
   106 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   107 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   108 
   109 /**
   110    \brief Get the path used for internal storage for this application.
   111 
   112    This path is unique to your application and cannot be written to
   113    by other applications.
   114  */
   115 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
   116 
   117 /**
   118    \brief Get the current state of external storage, a bitmask of these values:
   119     SDL_ANDROID_EXTERNAL_STORAGE_READ
   120     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   121 
   122    If external storage is currently unavailable, this will return 0.
   123 */
   124 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   125 
   126 /**
   127    \brief Get the path used for external storage for this application.
   128 
   129    This path is unique to your application, but is public and can be
   130    written to by other applications.
   131  */
   132 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
   133 
   134 #endif /* __ANDROID__ */
   135 
   136 /* Platform specific functions for WinRT */
   137 #if defined(__WINRT__) && __WINRT__
   138 
   139 /**
   140  *  \brief WinRT / Windows Phone path types
   141  */
   142 typedef enum
   143 {
   144     /** \brief The installed app's root directory.
   145         Files here are likely to be read-only. */
   146     SDL_WINRT_PATH_INSTALLED_LOCATION,
   147 
   148     /** \brief The app's local data store.  Files may be written here */
   149     SDL_WINRT_PATH_LOCAL_FOLDER,
   150 
   151     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   152         Files written here may be copied to other machines via a network
   153         connection.
   154     */
   155     SDL_WINRT_PATH_ROAMING_FOLDER,
   156 
   157     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   158         Files written here may be deleted at any time. */
   159     SDL_WINRT_PATH_TEMP_FOLDER
   160 } SDL_WinRT_Path;
   161 
   162 
   163 /**
   164  *  \brief Retrieves a WinRT defined path on the local file system
   165  *
   166  *  \note Documentation on most app-specific path types on WinRT
   167  *      can be found on MSDN, at the URL:
   168  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   169  *
   170  *  \param pathType The type of path to retrieve.
   171  *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   172  *      if the path is not available for any reason.  Not all paths are
   173  *      available on all versions of Windows.  This is especially true on
   174  *      Windows Phone.  Check the documentation for the given
   175  *      SDL_WinRT_Path for more information on which path types are
   176  *      supported where.
   177  */
   178 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   179 
   180 /**
   181  *  \brief Retrieves a WinRT defined path on the local file system
   182  *
   183  *  \note Documentation on most app-specific path types on WinRT
   184  *      can be found on MSDN, at the URL:
   185  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   186  *
   187  *  \param pathType The type of path to retrieve.
   188  *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   189  *      if the path is not available for any reason.  Not all paths are
   190  *      available on all versions of Windows.  This is especially true on
   191  *      Windows Phone.  Check the documentation for the given
   192  *      SDL_WinRT_Path for more information on which path types are
   193  *      supported where.
   194  */
   195 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   196 
   197 #endif /* __WINRT__ */
   198 
   199 /* Ends C function definitions when using C++ */
   200 #ifdef __cplusplus
   201 }
   202 #endif
   203 #include "close_code.h"
   204 
   205 #endif /* _SDL_system_h */
   206 
   207 /* vi: set ts=4 sw=4 expandtab: */