include/SDL_system.h
branchiOS-improvements
changeset 9533 e5693e855338
parent 9514 5b56ab9ff5fe
parent 9309 221b071c37d6
child 9539 ea3513fe64a0
     1.1 --- a/include/SDL_system.h	Thu Jan 15 01:06:14 2015 -0400
     1.2 +++ b/include/SDL_system.h	Thu Jan 15 01:15:24 2015 -0400
     1.3 @@ -43,19 +43,25 @@
     1.4  /* Platform specific functions for Windows */
     1.5  #ifdef __WIN32__
     1.6  
     1.7 -/* Returns the D3D9 adapter index that matches the specified display index.
     1.8 +/**
     1.9 +   \brief Returns the D3D9 adapter index that matches the specified display index.
    1.10 +
    1.11     This adapter index can be passed to IDirect3D9::CreateDevice and controls
    1.12     on which monitor a full screen application will appear.
    1.13  */
    1.14  extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
    1.15  
    1.16 -/* Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
    1.17 +typedef struct IDirect3DDevice9 IDirect3DDevice9;
    1.18 +/**
    1.19 +   \brief Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
    1.20 +
    1.21     Once you are done using the device, you should release it to avoid a resource leak.
    1.22   */
    1.23 -typedef struct IDirect3DDevice9 IDirect3DDevice9;
    1.24  extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
    1.25  
    1.26 -/* Returns the DXGI Adapter and Output indices for the specified display index. 
    1.27 +/**
    1.28 +   \brief Returns the DXGI Adapter and Output indices for the specified display index.
    1.29 +
    1.30     These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
    1.31     required to create a DX10 or DX11 device and swap chain.
    1.32   */
    1.33 @@ -70,12 +76,16 @@
    1.34  extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    1.35  extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    1.36  
    1.37 -/* Returns the OpenGL Renderbuffer Object associated with the window's main view.
    1.38 +/**
    1.39 +   \brief Returns the OpenGL Renderbuffer Object associated with the window's main view.
    1.40 +
    1.41     The Renderbuffer must be bound when calling SDL_GL_SwapWindow.
    1.42   */
    1.43  extern DECLSPEC Uint32 SDLCALL SDL_iPhoneGetViewRenderbuffer(SDL_Window * window);
    1.44  
    1.45 -/* Returns the OpenGL Framebuffer Object associated with the window's main view.
    1.46 +/**
    1.47 +   \brief Returns the OpenGL Framebuffer Object associated with the window's main view.
    1.48 +
    1.49     The Framebuffer must be bound when rendering to the screen.
    1.50   */
    1.51  extern DECLSPEC Uint32 SDLCALL SDL_iPhoneGetViewFramebuffer(SDL_Window * window);
    1.52 @@ -86,12 +96,16 @@
    1.53  /* Platform specific functions for Android */
    1.54  #if defined(__ANDROID__) && __ANDROID__
    1.55  
    1.56 -/* Get the JNI environment for the current thread
    1.57 +/**
    1.58 +   \brief Get the JNI environment for the current thread
    1.59 +
    1.60     This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    1.61   */
    1.62  extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    1.63  
    1.64 -/* Get the SDL Activity object for the application
    1.65 +/**
    1.66 +   \brief Get the SDL Activity object for the application
    1.67 +
    1.68     This returns jobject, but the prototype is void* so we don't need jni.h
    1.69     The jobject returned by SDL_AndroidGetActivity is a local reference.
    1.70     It is the caller's responsibility to properly release it
    1.71 @@ -99,26 +113,33 @@
    1.72   */
    1.73  extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
    1.74  
    1.75 -/* See the official Android developer guide for more information:
    1.76 +/**
    1.77 +   See the official Android developer guide for more information:
    1.78     http://developer.android.com/guide/topics/data/data-storage.html
    1.79  */
    1.80  #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
    1.81  #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
    1.82  
    1.83 -/* Get the path used for internal storage for this application.
    1.84 +/**
    1.85 +   \brief Get the path used for internal storage for this application.
    1.86 +
    1.87     This path is unique to your application and cannot be written to
    1.88     by other applications.
    1.89   */
    1.90  extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    1.91  
    1.92 -/* Get the current state of external storage, a bitmask of these values:
    1.93 +/**
    1.94 +   \brief Get the current state of external storage, a bitmask of these values:
    1.95      SDL_ANDROID_EXTERNAL_STORAGE_READ
    1.96      SDL_ANDROID_EXTERNAL_STORAGE_WRITE
    1.97 +
    1.98     If external storage is currently unavailable, this will return 0.
    1.99  */
   1.100  extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   1.101  
   1.102 -/* Get the path used for external storage for this application.
   1.103 +/**
   1.104 +   \brief Get the path used for external storage for this application.
   1.105 +
   1.106     This path is unique to your application, but is public and can be
   1.107     written to by other applications.
   1.108   */
   1.109 @@ -161,7 +182,7 @@
   1.110   *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   1.111   *
   1.112   *  \param pathType The type of path to retrieve.
   1.113 - *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   1.114 + *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   1.115   *      if the path is not available for any reason.  Not all paths are
   1.116   *      available on all versions of Windows.  This is especially true on
   1.117   *      Windows Phone.  Check the documentation for the given
   1.118 @@ -178,7 +199,7 @@
   1.119   *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   1.120   *
   1.121   *  \param pathType The type of path to retrieve.
   1.122 - *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   1.123 + *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   1.124   *      if the path is not available for any reason.  Not all paths are
   1.125   *      available on all versions of Windows.  This is especially true on
   1.126   *      Windows Phone.  Check the documentation for the given