include/SDL.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2020 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_gamecontroller.h"
  44 #include "SDL_haptic.h"
  45 #include "SDL_hints.h"
  46 #include "SDL_joystick.h"
  47 #include "SDL_loadso.h"
  48 #include "SDL_log.h"
  49 #include "SDL_messagebox.h"
  50 #include "SDL_metal.h"
  51 #include "SDL_mutex.h"
  52 #include "SDL_power.h"
  53 #include "SDL_render.h"
  54 #include "SDL_rwops.h"
  55 #include "SDL_sensor.h"
  56 #include "SDL_shape.h"
  57 #include "SDL_system.h"
  58 #include "SDL_thread.h"
  59 #include "SDL_timer.h"
  60 #include "SDL_version.h"
  61 #include "SDL_video.h"
  62 #include "SDL_vulkan.h"
  63 #include "SDL_locale.h"
  64 #include "SDL_misc.h"
  65
  66 #include "begin_code.h"
  67 /* Set up for C function definitions, even when using C++ */
  68 #ifdef __cplusplus
  69 extern "C" {
  70 #endif
  71
  72 /* As of version 0.5, SDL is loaded dynamically into the application */
  73
  74 /**
  75  *  \name SDL_INIT_*
  76  *
  77  *  These are the flags which may be passed to SDL_Init().  You should
  78  *  specify the subsystems which you will be using in your application.
  79  */
  80 /* @{ */
  81 #define SDL_INIT_TIMER          0x00000001u
  82 #define SDL_INIT_AUDIO          0x00000010u
  83 #define SDL_INIT_VIDEO          0x00000020u  /**< SDL_INIT_VIDEO implies SDL_INIT_EVENTS */
  84 #define SDL_INIT_JOYSTICK       0x00000200u  /**< SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS */
  85 #define SDL_INIT_HAPTIC         0x00001000u
  86 #define SDL_INIT_GAMECONTROLLER 0x00002000u  /**< SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK */
  87 #define SDL_INIT_EVENTS         0x00004000u
  88 #define SDL_INIT_SENSOR         0x00008000u
  89 #define SDL_INIT_NOPARACHUTE    0x00100000u  /**< compatibility; this flag is ignored. */
  90 #define SDL_INIT_EVERYTHING ( \
  91                 SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
  92                 SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER | SDL_INIT_SENSOR \
  93             )
  94 /* @} */
  95
  96 /**
  97  *  This function initializes  the subsystems specified by \c flags
  98  */
  99 extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
 100
 101 /**
 102  *  This function initializes specific SDL subsystems
 103  *
 104  *  Subsystem initialization is ref-counted, you must call
 105  *  SDL_QuitSubSystem() for each SDL_InitSubSystem() to correctly
 106  *  shutdown a subsystem manually (or call SDL_Quit() to force shutdown).
 107  *  If a subsystem is already loaded then this call will
 108  *  increase the ref-count and return.
 109  */
 110 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
 111
 112 /**
 113  *  This function cleans up specific SDL subsystems
 114  */
 115 extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
 116
 117 /**
 118  *  This function returns a mask of the specified subsystems which have
 119  *  previously been initialized.
 120  *
 121  *  If \c flags is 0, it returns a mask of all initialized subsystems.
 122  */
 123 extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
 124
 125 /**
 126  *  This function cleans up all initialized subsystems. You should
 127  *  call it upon all exit conditions.
 128  */
 129 extern DECLSPEC void SDLCALL SDL_Quit(void);
 130
 131 /* Ends C function definitions when using C++ */
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135 #include "close_code.h"
 136
 137 #endif /* SDL_h_ */
 138
 139 /* vi: set ts=4 sw=4 expandtab: */