include/SDL_system.h
author Alex Szpakowski <slime73@gmail.com>
Fri, 08 Aug 2014 15:14:09 -0300
branchiOS-improvements
changeset 9514 5b56ab9ff5fe
parent 8877 0d691f3734ac
child 9533 e5693e855338
permissions -rw-r--r--
Added iOS-specific functions to get the window view's current OpenGL Renderbuffer and Framebuffer objects, so they can be more easily rebound when necessary.
     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 /* 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 /* Returns the DXGI Adapter and Output indices for the specified display index. 
    59    These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
    60    required to create a DX10 or DX11 device and swap chain.
    61  */
    62 extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
    63 
    64 #endif /* __WIN32__ */
    65 
    66 
    67 /* Platform specific functions for iOS */
    68 #if defined(__IPHONEOS__) && __IPHONEOS__
    69 
    70 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    71 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    72 
    73 /* Returns the OpenGL Renderbuffer Object associated with the window's main view.
    74    The Renderbuffer must be bound when calling SDL_GL_SwapWindow.
    75  */
    76 extern DECLSPEC Uint32 SDLCALL SDL_iPhoneGetViewRenderbuffer(SDL_Window * window);
    77 
    78 /* Returns the OpenGL Framebuffer Object associated with the window's main view.
    79    The Framebuffer must be bound when rendering to the screen.
    80  */
    81 extern DECLSPEC Uint32 SDLCALL SDL_iPhoneGetViewFramebuffer(SDL_Window * window);
    82 
    83 #endif /* __IPHONEOS__ */
    84 
    85 
    86 /* Platform specific functions for Android */
    87 #if defined(__ANDROID__) && __ANDROID__
    88 
    89 /* Get the JNI environment for the current thread
    90    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    91  */
    92 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    93 
    94 /* Get the SDL Activity object for the application
    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 /* See the official Android developer guide for more information:
   103    http://developer.android.com/guide/topics/data/data-storage.html
   104 */
   105 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   106 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   107 
   108 /* Get the path used for internal storage for this application.
   109    This path is unique to your application and cannot be written to
   110    by other applications.
   111  */
   112 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
   113 
   114 /* Get the current state of external storage, a bitmask of these values:
   115     SDL_ANDROID_EXTERNAL_STORAGE_READ
   116     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   117    If external storage is currently unavailable, this will return 0.
   118 */
   119 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   120 
   121 /* Get the path used for external storage for this application.
   122    This path is unique to your application, but is public and can be
   123    written to by other applications.
   124  */
   125 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
   126 
   127 #endif /* __ANDROID__ */
   128 
   129 /* Platform specific functions for WinRT */
   130 #if defined(__WINRT__) && __WINRT__
   131 
   132 /**
   133  *  \brief WinRT / Windows Phone path types
   134  */
   135 typedef enum
   136 {
   137     /** \brief The installed app's root directory.
   138         Files here are likely to be read-only. */
   139     SDL_WINRT_PATH_INSTALLED_LOCATION,
   140 
   141     /** \brief The app's local data store.  Files may be written here */
   142     SDL_WINRT_PATH_LOCAL_FOLDER,
   143 
   144     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   145         Files written here may be copied to other machines via a network
   146         connection.
   147     */
   148     SDL_WINRT_PATH_ROAMING_FOLDER,
   149 
   150     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   151         Files written here may be deleted at any time. */
   152     SDL_WINRT_PATH_TEMP_FOLDER
   153 } SDL_WinRT_Path;
   154 
   155 
   156 /**
   157  *  \brief Retrieves a WinRT defined path on the local file system
   158  *
   159  *  \note Documentation on most app-specific path types on WinRT
   160  *      can be found on MSDN, at the URL:
   161  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   162  *
   163  *  \param pathType The type of path to retrieve.
   164  *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   165  *      if the path is not available for any reason.  Not all paths are
   166  *      available on all versions of Windows.  This is especially true on
   167  *      Windows Phone.  Check the documentation for the given
   168  *      SDL_WinRT_Path for more information on which path types are
   169  *      supported where.
   170  */
   171 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   172 
   173 /**
   174  *  \brief Retrieves a WinRT defined path on the local file system
   175  *
   176  *  \note Documentation on most app-specific path types on WinRT
   177  *      can be found on MSDN, at the URL:
   178  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   179  *
   180  *  \param pathType The type of path to retrieve.
   181  *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   182  *      if the path is not available for any reason.  Not all paths are
   183  *      available on all versions of Windows.  This is especially true on
   184  *      Windows Phone.  Check the documentation for the given
   185  *      SDL_WinRT_Path for more information on which path types are
   186  *      supported where.
   187  */
   188 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   189 
   190 #endif /* __WINRT__ */
   191 
   192 /* Ends C function definitions when using C++ */
   193 #ifdef __cplusplus
   194 }
   195 #endif
   196 #include "close_code.h"
   197 
   198 #endif /* _SDL_system_h */
   199 
   200 /* vi: set ts=4 sw=4 expandtab: */