SDL.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2014 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_joystick.h"
  37. #include "SDL_gamecontroller.h"
  38. #include "SDL_haptic.h"
  39. #include "SDL_hints.h"
  40. #include "SDL_loadso.h"
  41. #include "SDL_log.h"
  42. #include "SDL_messagebox.h"
  43. #include "SDL_mutex.h"
  44. #include "SDL_power.h"
  45. #include "SDL_render.h"
  46. #include "SDL_rwops.h"
  47. #include "SDL_system.h"
  48. #include "SDL_thread.h"
  49. #include "SDL_timer.h"
  50. #include "SDL_version.h"
  51. #include "SDL_video.h"
  52. #include "begin_code.h"
  53. /* Set up for C function definitions, even when using C++ */
  54. #ifdef __cplusplus
  55. extern "C" {
  56. #endif
  57. /* As of version 0.5, SDL is loaded dynamically into the application */
  58. /**
  59. * \name SDL_INIT_*
  60. *
  61. * These are the flags which may be passed to SDL_Init(). You should
  62. * specify the subsystems which you will be using in your application.
  63. */
  64. /* @{ */
  65. #define SDL_INIT_TIMER 0x00000001
  66. #define SDL_INIT_AUDIO 0x00000010
  67. #define SDL_INIT_VIDEO 0x00000020 /**< SDL_INIT_VIDEO implies SDL_INIT_EVENTS */
  68. #define SDL_INIT_JOYSTICK 0x00000200 /**< SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS */
  69. #define SDL_INIT_HAPTIC 0x00001000
  70. #define SDL_INIT_GAMECONTROLLER 0x00002000 /**< SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK */
  71. #define SDL_INIT_EVENTS 0x00004000
  72. #define SDL_INIT_NOPARACHUTE 0x00100000 /**< compatibility; this flag is ignored. */
  73. #define SDL_INIT_EVERYTHING ( \
  74. SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
  75. SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER \
  76. )
  77. /* @} */
  78. /**
  79. * This function initializes the subsystems specified by \c flags
  80. */
  81. extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
  82. /**
  83. * This function initializes specific SDL subsystems
  84. *
  85. * Subsystem initialization is ref-counted, you must call
  86. * SDL_QuitSubSystem for each SDL_InitSubSystem to correctly
  87. * shutdown a subsystem manually (or call SDL_Quit to force shutdown).
  88. * If a subsystem is already loaded then this call will
  89. * increase the ref-count and return.
  90. */
  91. extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
  92. /**
  93. * This function cleans up specific SDL subsystems
  94. */
  95. extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
  96. /**
  97. * This function returns a mask of the specified subsystems which have
  98. * previously been initialized.
  99. *
  100. * If \c flags is 0, it returns a mask of all initialized subsystems.
  101. */
  102. extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
  103. /**
  104. * This function cleans up all initialized subsystems. You should
  105. * call it upon all exit conditions.
  106. */
  107. extern DECLSPEC void SDLCALL SDL_Quit(void);
  108. /* Ends C function definitions when using C++ */
  109. #ifdef __cplusplus
  110. }
  111. #endif
  112. #include "close_code.h"
  113. #endif /* _SDL_H */
  114. /* vi: set ts=4 sw=4 expandtab: */