include/SDL.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 12 Apr 2015 20:28:28 -0400
changeset 9553 75dca0c33be6
parent 9023 276802355854
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Merged.
     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.h
    24  *
    25  *  Main include header for the SDL library
    26  */
    27 
    28 
    29 #ifndef _SDL_H
    30 #define _SDL_H
    31 
    32 #include "SDL_main.h"
    33 #include "SDL_stdinc.h"
    34 #include "SDL_assert.h"
    35 #include "SDL_atomic.h"
    36 #include "SDL_audio.h"
    37 #include "SDL_clipboard.h"
    38 #include "SDL_cpuinfo.h"
    39 #include "SDL_endian.h"
    40 #include "SDL_error.h"
    41 #include "SDL_events.h"
    42 #include "SDL_filesystem.h"
    43 #include "SDL_joystick.h"
    44 #include "SDL_gamecontroller.h"
    45 #include "SDL_haptic.h"
    46 #include "SDL_hints.h"
    47 #include "SDL_loadso.h"
    48 #include "SDL_log.h"
    49 #include "SDL_messagebox.h"
    50 #include "SDL_mutex.h"
    51 #include "SDL_power.h"
    52 #include "SDL_render.h"
    53 #include "SDL_rwops.h"
    54 #include "SDL_system.h"
    55 #include "SDL_thread.h"
    56 #include "SDL_timer.h"
    57 #include "SDL_version.h"
    58 #include "SDL_video.h"
    59 
    60 #include "begin_code.h"
    61 /* Set up for C function definitions, even when using C++ */
    62 #ifdef __cplusplus
    63 extern "C" {
    64 #endif
    65 
    66 /* As of version 0.5, SDL is loaded dynamically into the application */
    67 
    68 /**
    69  *  \name SDL_INIT_*
    70  *
    71  *  These are the flags which may be passed to SDL_Init().  You should
    72  *  specify the subsystems which you will be using in your application.
    73  */
    74 /* @{ */
    75 #define SDL_INIT_TIMER          0x00000001
    76 #define SDL_INIT_AUDIO          0x00000010
    77 #define SDL_INIT_VIDEO          0x00000020  /**< SDL_INIT_VIDEO implies SDL_INIT_EVENTS */
    78 #define SDL_INIT_JOYSTICK       0x00000200  /**< SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS */
    79 #define SDL_INIT_HAPTIC         0x00001000
    80 #define SDL_INIT_GAMECONTROLLER 0x00002000  /**< SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK */
    81 #define SDL_INIT_EVENTS         0x00004000
    82 #define SDL_INIT_NOPARACHUTE    0x00100000  /**< compatibility; this flag is ignored. */
    83 #define SDL_INIT_EVERYTHING ( \
    84                 SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
    85                 SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER \
    86             )
    87 /* @} */
    88 
    89 /**
    90  *  This function initializes  the subsystems specified by \c flags
    91  */
    92 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
    93 
    94 /**
    95  *  This function initializes specific SDL subsystems
    96  *
    97  *  Subsystem initialization is ref-counted, you must call
    98  *  SDL_QuitSubSystem for each SDL_InitSubSystem to correctly
    99  *  shutdown a subsystem manually (or call SDL_Quit to force shutdown).
   100  *  If a subsystem is already loaded then this call will
   101  *  increase the ref-count and return.
   102  */
   103 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
   104 
   105 /**
   106  *  This function cleans up specific SDL subsystems
   107  */
   108 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
   109 
   110 /**
   111  *  This function returns a mask of the specified subsystems which have
   112  *  previously been initialized.
   113  *
   114  *  If \c flags is 0, it returns a mask of all initialized subsystems.
   115  */
   116 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
   117 
   118 /**
   119  *  This function cleans up all initialized subsystems. You should
   120  *  call it upon all exit conditions.
   121  */
   122 extern DECLSPEC void SDLCALL SDL_Quit(void);
   123 
   124 /* Ends C function definitions when using C++ */
   125 #ifdef __cplusplus
   126 }
   127 #endif
   128 #include "close_code.h"
   129 
   130 #endif /* _SDL_H */
   131 
   132 /* vi: set ts=4 sw=4 expandtab: */