include/SDL.h
author David Ludwig <dludwig@pobox.com>
Mon, 01 Apr 2013 21:33:06 -0400
changeset 8453 499aa167ea79
parent 6885 700f1b25f77f
child 6918 6f4bf9b784f2
permissions -rw-r--r--
WinRT: made WinRT path retrieval be available in both UCS-2 and UTF-8 flavors
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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.h
    24  *  
    25  *  Main include header for the SDL library
    26  */
    27 
    28 /**
    29  *  \mainpage Simple DirectMedia Layer (SDL)
    30  *  
    31  *  http://www.libsdl.org/
    32  *  
    33  *  \section intro_sec Introduction
    34  *  
    35  *  This is the Simple DirectMedia Layer, a general API that provides low
    36  *  level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
    37  *  and 2D framebuffer across multiple platforms.
    38  *  
    39  *  SDL is written in C, but works with C++ natively, and has bindings to
    40  *  several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
    41  *  Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
    42  *  Pike, Pliant, Python, Ruby, and Smalltalk.
    43  *  
    44  *  This library is distributed under GNU LGPL version 2, which can be
    45  *  found in the file  "COPYING".  This license allows you to use SDL
    46  *  freely in commercial programs as long as you link with the dynamic
    47  *  library.
    48  *  
    49  *  The best way to learn how to use SDL is to check out the header files in
    50  *  the "include" subdirectory and the programs in the "test" subdirectory.
    51  *  The header files and test programs are well commented and always up to date.
    52  *  More documentation and FAQs are available online at:
    53  *  	http://wiki.libsdl.org/
    54  *  
    55  *  If you need help with the library, or just want to discuss SDL related
    56  *  issues, you can join the developers mailing list:
    57  *  	http://www.libsdl.org/mailing-list.php
    58  *  
    59  *  Enjoy!
    60  *  	Sam Lantinga				(slouken@libsdl.org)
    61  */
    62 
    63 #ifndef _SDL_H
    64 #define _SDL_H
    65 
    66 #include "SDL_main.h"
    67 #include "SDL_stdinc.h"
    68 #include "SDL_assert.h"
    69 #include "SDL_atomic.h"
    70 #include "SDL_audio.h"
    71 #include "SDL_clipboard.h"
    72 #include "SDL_cpuinfo.h"
    73 #include "SDL_endian.h"
    74 #include "SDL_error.h"
    75 #include "SDL_events.h"
    76 #include "SDL_gamecontroller.h"
    77 #include "SDL_hints.h"
    78 #include "SDL_loadso.h"
    79 #include "SDL_log.h"
    80 #include "SDL_messagebox.h"
    81 #include "SDL_mutex.h"
    82 #include "SDL_power.h"
    83 #include "SDL_render.h"
    84 #include "SDL_rwops.h"
    85 #include "SDL_system.h"
    86 #include "SDL_thread.h"
    87 #include "SDL_timer.h"
    88 #include "SDL_version.h"
    89 #include "SDL_video.h"
    90 
    91 #include "begin_code.h"
    92 /* Set up for C function definitions, even when using C++ */
    93 #ifdef __cplusplus
    94 /* *INDENT-OFF* */
    95 extern "C" {
    96 /* *INDENT-ON* */
    97 #endif
    98 
    99 /* As of version 0.5, SDL is loaded dynamically into the application */
   100 
   101 /**
   102  *  \name SDL_INIT_*
   103  *  
   104  *  These are the flags which may be passed to SDL_Init().  You should
   105  *  specify the subsystems which you will be using in your application.
   106  */
   107 /*@{*/
   108 #define SDL_INIT_TIMER          0x00000001
   109 #define SDL_INIT_AUDIO          0x00000010
   110 #define SDL_INIT_VIDEO          0x00000020
   111 #define SDL_INIT_JOYSTICK       0x00000200
   112 #define SDL_INIT_HAPTIC         0x00001000
   113 #define SDL_INIT_GAMECONTROLLER 0x00002000		/**< turn on game controller also implicitly does JOYSTICK */
   114 #define SDL_INIT_NOPARACHUTE    0x00100000      /**< Don't catch fatal signals */
   115 #define SDL_INIT_EVERYTHING     0x0000FFFF
   116 /*@}*/
   117 
   118 /**
   119  *  This function initializes  the subsystems specified by \c flags
   120  *  Unless the ::SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
   121  *  signal handlers for some commonly ignored fatal signals (like SIGSEGV).
   122  */
   123 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
   124 
   125 /**
   126  *  This function initializes specific SDL subsystems
   127  */
   128 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
   129 
   130 /**
   131  *  This function cleans up specific SDL subsystems
   132  */
   133 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
   134 
   135 /**
   136  *  This function returns a mask of the specified subsystems which have
   137  *  previously been initialized.
   138  *  
   139  *  If \c flags is 0, it returns a mask of all initialized subsystems.
   140  */
   141 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
   142 
   143 /**
   144  *  This function cleans up all initialized subsystems. You should
   145  *  call it upon all exit conditions.
   146  */
   147 extern DECLSPEC void SDLCALL SDL_Quit(void);
   148 
   149 /* Ends C function definitions when using C++ */
   150 #ifdef __cplusplus
   151 /* *INDENT-OFF* */
   152 }
   153 /* *INDENT-ON* */
   154 #endif
   155 #include "close_code.h"
   156 
   157 #endif /* _SDL_H */
   158 
   159 /* vi: set ts=4 sw=4 expandtab: */