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