SDL.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
  4. This software is provided 'as-is', without any express or implied
  5. warranty. In no event will the authors be held liable for any damages
  6. arising from the use of this software.
  7. Permission is granted to anyone to use this software for any purpose,
  8. including commercial applications, and to alter it and redistribute it
  9. freely, subject to the following restrictions:
  10. 1. The origin of this software must not be misrepresented; you must not
  11. claim that you wrote the original software. If you use this software
  12. in a product, an acknowledgment in the product documentation would be
  13. appreciated but is not required.
  14. 2. Altered source versions must be plainly marked as such, and must not be
  15. misrepresented as being the original software.
  16. 3. This notice may not be removed or altered from any source distribution.
  17. */
  18. /**
  19. * \file SDL.h
  20. *
  21. * Main include header for the SDL library
  22. */
  23. #ifndef SDL_h_
  24. #define SDL_h_
  25. #include "SDL_main.h"
  26. #include "SDL_stdinc.h"
  27. #include "SDL_assert.h"
  28. #include "SDL_atomic.h"
  29. #include "SDL_audio.h"
  30. #include "SDL_clipboard.h"
  31. #include "SDL_cpuinfo.h"
  32. #include "SDL_endian.h"
  33. #include "SDL_error.h"
  34. #include "SDL_events.h"
  35. #include "SDL_filesystem.h"
  36. #include "SDL_gamecontroller.h"
  37. #include "SDL_haptic.h"
  38. #include "SDL_hints.h"
  39. #include "SDL_joystick.h"
  40. #include "SDL_loadso.h"
  41. #include "SDL_log.h"
  42. #include "SDL_messagebox.h"
  43. #include "SDL_metal.h"
  44. #include "SDL_mutex.h"
  45. #include "SDL_power.h"
  46. #include "SDL_render.h"
  47. #include "SDL_rwops.h"
  48. #include "SDL_sensor.h"
  49. #include "SDL_shape.h"
  50. #include "SDL_system.h"
  51. #include "SDL_thread.h"
  52. #include "SDL_timer.h"
  53. #include "SDL_version.h"
  54. #include "SDL_video.h"
  55. #include "SDL_locale.h"
  56. #include "SDL_misc.h"
  57. #include "begin_code.h"
  58. /* Set up for C function definitions, even when using C++ */
  59. #ifdef __cplusplus
  60. extern "C" {
  61. #endif
  62. /* As of version 0.5, SDL is loaded dynamically into the application */
  63. /**
  64. * \name SDL_INIT_*
  65. *
  66. * These are the flags which may be passed to SDL_Init(). You should
  67. * specify the subsystems which you will be using in your application.
  68. */
  69. /* @{ */
  70. #define SDL_INIT_TIMER 0x00000001u
  71. #define SDL_INIT_AUDIO 0x00000010u
  72. #define SDL_INIT_VIDEO 0x00000020u /**< SDL_INIT_VIDEO implies SDL_INIT_EVENTS */
  73. #define SDL_INIT_JOYSTICK 0x00000200u /**< SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS */
  74. #define SDL_INIT_HAPTIC 0x00001000u
  75. #define SDL_INIT_GAMECONTROLLER 0x00002000u /**< SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK */
  76. #define SDL_INIT_EVENTS 0x00004000u
  77. #define SDL_INIT_SENSOR 0x00008000u
  78. #define SDL_INIT_NOPARACHUTE 0x00100000u /**< compatibility; this flag is ignored. */
  79. #define SDL_INIT_EVERYTHING ( \
  80. SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
  81. SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER | SDL_INIT_SENSOR \
  82. )
  83. /* @} */
  84. /**
  85. * This function initializes the subsystems specified by \c flags
  86. */
  87. extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
  88. /**
  89. * This function initializes specific SDL subsystems
  90. *
  91. * Subsystem initialization is ref-counted, you must call
  92. * SDL_QuitSubSystem() for each SDL_InitSubSystem() to correctly
  93. * shutdown a subsystem manually (or call SDL_Quit() to force shutdown).
  94. * If a subsystem is already loaded then this call will
  95. * increase the ref-count and return.
  96. */
  97. extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
  98. /**
  99. * This function cleans up specific SDL subsystems
  100. */
  101. extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
  102. /**
  103. * This function returns a mask of the specified subsystems which have
  104. * previously been initialized.
  105. *
  106. * If \c flags is 0, it returns a mask of all initialized subsystems.
  107. */
  108. extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
  109. /**
  110. * This function cleans up all initialized subsystems. You should
  111. * call it upon all exit conditions.
  112. */
  113. extern DECLSPEC void SDLCALL SDL_Quit(void);
  114. /* Ends C function definitions when using C++ */
  115. #ifdef __cplusplus
  116. }
  117. #endif
  118. #include "close_code.h"
  119. #endif /* SDL_h_ */
  120. /* vi: set ts=4 sw=4 expandtab: */