SDL_video.h 69 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952
  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2023 Sam Lantinga <[email protected]>
  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_video.h
  20. *
  21. * Header file for SDL video functions.
  22. */
  23. #ifndef SDL_video_h_
  24. #define SDL_video_h_
  25. #include <SDL3/SDL_stdinc.h>
  26. #include <SDL3/SDL_pixels.h>
  27. #include <SDL3/SDL_rect.h>
  28. #include <SDL3/SDL_surface.h>
  29. #include <SDL3/SDL_begin_code.h>
  30. /* Set up for C function definitions, even when using C++ */
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. typedef Uint32 SDL_DisplayID;
  35. typedef Uint32 SDL_WindowID;
  36. /**
  37. * \brief The structure that defines a display mode
  38. *
  39. * \sa SDL_GetFullscreenDisplayModes()
  40. * \sa SDL_GetDesktopDisplayMode()
  41. * \sa SDL_GetCurrentDisplayMode()
  42. * \sa SDL_SetWindowFullscreenMode()
  43. * \sa SDL_GetWindowFullscreenMode()
  44. */
  45. typedef struct
  46. {
  47. SDL_DisplayID displayID; /**< the display this mode is associated with */
  48. Uint32 format; /**< pixel format */
  49. int pixel_w; /**< width in pixels (used for creating back buffers) */
  50. int pixel_h; /**< height in pixels (used for creating back buffers) */
  51. int screen_w; /**< width in screen coordinates (used for creating windows) */
  52. int screen_h; /**< height in screen coordinates (used for creating windows) */
  53. float display_scale; /**< scale converting screen coordinates to pixels (e.g. a 2560x1440 screen size mode with 1.5 scale would have 3840x2160 pixels) */
  54. float refresh_rate; /**< refresh rate (or zero for unspecified) */
  55. void *driverdata; /**< driver-specific data, initialize to 0 */
  56. } SDL_DisplayMode;
  57. /**
  58. * \brief The type used to identify a window
  59. *
  60. * \sa SDL_CreateWindow()
  61. * \sa SDL_CreateWindowFrom()
  62. * \sa SDL_DestroyWindow()
  63. * \sa SDL_FlashWindow()
  64. * \sa SDL_GetWindowData()
  65. * \sa SDL_GetWindowFlags()
  66. * \sa SDL_GetWindowGrab()
  67. * \sa SDL_GetWindowKeyboardGrab()
  68. * \sa SDL_GetWindowMouseGrab()
  69. * \sa SDL_GetWindowPosition()
  70. * \sa SDL_GetWindowSize()
  71. * \sa SDL_GetWindowTitle()
  72. * \sa SDL_HideWindow()
  73. * \sa SDL_MaximizeWindow()
  74. * \sa SDL_MinimizeWindow()
  75. * \sa SDL_RaiseWindow()
  76. * \sa SDL_RestoreWindow()
  77. * \sa SDL_SetWindowData()
  78. * \sa SDL_SetWindowFullscreen()
  79. * \sa SDL_SetWindowGrab()
  80. * \sa SDL_SetWindowKeyboardGrab()
  81. * \sa SDL_SetWindowMouseGrab()
  82. * \sa SDL_SetWindowIcon()
  83. * \sa SDL_SetWindowPosition()
  84. * \sa SDL_SetWindowSize()
  85. * \sa SDL_SetWindowBordered()
  86. * \sa SDL_SetWindowResizable()
  87. * \sa SDL_SetWindowTitle()
  88. * \sa SDL_ShowWindow()
  89. */
  90. typedef struct SDL_Window SDL_Window;
  91. /**
  92. * \brief The flags on a window
  93. *
  94. * \sa SDL_GetWindowFlags()
  95. */
  96. typedef enum
  97. {
  98. SDL_WINDOW_FULLSCREEN = 0x00000001, /**< window is in fullscreen mode */
  99. SDL_WINDOW_OPENGL = 0x00000002, /**< window usable with OpenGL context */
  100. /* 0x00000004 was SDL_WINDOW_SHOWN in SDL2, please reserve this bit for sdl2-compat. */
  101. SDL_WINDOW_HIDDEN = 0x00000008, /**< window is not visible */
  102. SDL_WINDOW_BORDERLESS = 0x00000010, /**< no window decoration */
  103. SDL_WINDOW_RESIZABLE = 0x00000020, /**< window can be resized */
  104. SDL_WINDOW_MINIMIZED = 0x00000040, /**< window is minimized */
  105. SDL_WINDOW_MAXIMIZED = 0x00000080, /**< window is maximized */
  106. SDL_WINDOW_MOUSE_GRABBED = 0x00000100, /**< window has grabbed mouse input */
  107. SDL_WINDOW_INPUT_FOCUS = 0x00000200, /**< window has input focus */
  108. SDL_WINDOW_MOUSE_FOCUS = 0x00000400, /**< window has mouse focus */
  109. /* 0x00001000 was SDL_WINDOW_FULLSCREEN_DESKTOP in SDL2, please reserve this bit for sdl2-compat. */
  110. SDL_WINDOW_FOREIGN = 0x00000800, /**< window not created by SDL */
  111. /* 0x00002000 was SDL_WINDOW_ALLOW_HIGHDPI in SDL2, please reserve this bit for sdl2-compat. */
  112. SDL_WINDOW_MOUSE_CAPTURE = 0x00004000, /**< window has mouse captured (unrelated to MOUSE_GRABBED) */
  113. SDL_WINDOW_ALWAYS_ON_TOP = 0x00008000, /**< window should always be above others */
  114. SDL_WINDOW_SKIP_TASKBAR = 0x00010000, /**< window should not be added to the taskbar */
  115. SDL_WINDOW_UTILITY = 0x00020000, /**< window should be treated as a utility window */
  116. SDL_WINDOW_TOOLTIP = 0x00040000, /**< window should be treated as a tooltip */
  117. SDL_WINDOW_POPUP_MENU = 0x00080000, /**< window should be treated as a popup menu */
  118. SDL_WINDOW_KEYBOARD_GRABBED = 0x00100000, /**< window has grabbed keyboard input */
  119. SDL_WINDOW_VULKAN = 0x10000000, /**< window usable for Vulkan surface */
  120. SDL_WINDOW_METAL = 0x20000000, /**< window usable for Metal view */
  121. } SDL_WindowFlags;
  122. /**
  123. * \brief Used to indicate that you don't care what the window position is.
  124. */
  125. #define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
  126. #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
  127. #define SDL_WINDOWPOS_UNDEFINED SDL_WINDOWPOS_UNDEFINED_DISPLAY(0)
  128. #define SDL_WINDOWPOS_ISUNDEFINED(X) \
  129. (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
  130. /**
  131. * \brief Used to indicate that the window position should be centered.
  132. */
  133. #define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
  134. #define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
  135. #define SDL_WINDOWPOS_CENTERED SDL_WINDOWPOS_CENTERED_DISPLAY(0)
  136. #define SDL_WINDOWPOS_ISCENTERED(X) \
  137. (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
  138. /**
  139. * \brief Display orientation
  140. */
  141. typedef enum
  142. {
  143. SDL_ORIENTATION_UNKNOWN, /**< The display orientation can't be determined */
  144. SDL_ORIENTATION_LANDSCAPE, /**< The display is in landscape mode, with the right side up, relative to portrait mode */
  145. SDL_ORIENTATION_LANDSCAPE_FLIPPED, /**< The display is in landscape mode, with the left side up, relative to portrait mode */
  146. SDL_ORIENTATION_PORTRAIT, /**< The display is in portrait mode */
  147. SDL_ORIENTATION_PORTRAIT_FLIPPED /**< The display is in portrait mode, upside down */
  148. } SDL_DisplayOrientation;
  149. /**
  150. * \brief Window flash operation
  151. */
  152. typedef enum
  153. {
  154. SDL_FLASH_CANCEL, /**< Cancel any window flash state */
  155. SDL_FLASH_BRIEFLY, /**< Flash the window briefly to get attention */
  156. SDL_FLASH_UNTIL_FOCUSED /**< Flash the window until it gets focus */
  157. } SDL_FlashOperation;
  158. /**
  159. * \brief An opaque handle to an OpenGL context.
  160. */
  161. typedef void *SDL_GLContext;
  162. /**
  163. * \brief Opaque EGL types.
  164. */
  165. typedef void *SDL_EGLDisplay;
  166. typedef void *SDL_EGLConfig;
  167. typedef void *SDL_EGLSurface;
  168. typedef intptr_t SDL_EGLAttrib;
  169. typedef int SDL_EGLint;
  170. /**
  171. * \brief EGL attribute initialization callback types.
  172. */
  173. typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void);
  174. typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void);
  175. /**
  176. * \brief OpenGL configuration attributes
  177. */
  178. typedef enum
  179. {
  180. SDL_GL_RED_SIZE,
  181. SDL_GL_GREEN_SIZE,
  182. SDL_GL_BLUE_SIZE,
  183. SDL_GL_ALPHA_SIZE,
  184. SDL_GL_BUFFER_SIZE,
  185. SDL_GL_DOUBLEBUFFER,
  186. SDL_GL_DEPTH_SIZE,
  187. SDL_GL_STENCIL_SIZE,
  188. SDL_GL_ACCUM_RED_SIZE,
  189. SDL_GL_ACCUM_GREEN_SIZE,
  190. SDL_GL_ACCUM_BLUE_SIZE,
  191. SDL_GL_ACCUM_ALPHA_SIZE,
  192. SDL_GL_STEREO,
  193. SDL_GL_MULTISAMPLEBUFFERS,
  194. SDL_GL_MULTISAMPLESAMPLES,
  195. SDL_GL_ACCELERATED_VISUAL,
  196. SDL_GL_RETAINED_BACKING,
  197. SDL_GL_CONTEXT_MAJOR_VERSION,
  198. SDL_GL_CONTEXT_MINOR_VERSION,
  199. SDL_GL_CONTEXT_FLAGS,
  200. SDL_GL_CONTEXT_PROFILE_MASK,
  201. SDL_GL_SHARE_WITH_CURRENT_CONTEXT,
  202. SDL_GL_FRAMEBUFFER_SRGB_CAPABLE,
  203. SDL_GL_CONTEXT_RELEASE_BEHAVIOR,
  204. SDL_GL_CONTEXT_RESET_NOTIFICATION,
  205. SDL_GL_CONTEXT_NO_ERROR,
  206. SDL_GL_FLOATBUFFERS,
  207. SDL_GL_EGL_PLATFORM
  208. } SDL_GLattr;
  209. typedef enum
  210. {
  211. SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
  212. SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
  213. SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
  214. } SDL_GLprofile;
  215. typedef enum
  216. {
  217. SDL_GL_CONTEXT_DEBUG_FLAG = 0x0001,
  218. SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG = 0x0002,
  219. SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG = 0x0004,
  220. SDL_GL_CONTEXT_RESET_ISOLATION_FLAG = 0x0008
  221. } SDL_GLcontextFlag;
  222. typedef enum
  223. {
  224. SDL_GL_CONTEXT_RELEASE_BEHAVIOR_NONE = 0x0000,
  225. SDL_GL_CONTEXT_RELEASE_BEHAVIOR_FLUSH = 0x0001
  226. } SDL_GLcontextReleaseFlag;
  227. typedef enum
  228. {
  229. SDL_GL_CONTEXT_RESET_NO_NOTIFICATION = 0x0000,
  230. SDL_GL_CONTEXT_RESET_LOSE_CONTEXT = 0x0001
  231. } SDL_GLContextResetNotification;
  232. /* Function prototypes */
  233. /**
  234. * Get the number of video drivers compiled into SDL.
  235. *
  236. * \returns a number >= 1 on success or a negative error code on failure; call
  237. * SDL_GetError() for more information.
  238. *
  239. * \since This function is available since SDL 3.0.0.
  240. *
  241. * \sa SDL_GetVideoDriver
  242. */
  243. extern DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
  244. /**
  245. * Get the name of a built in video driver.
  246. *
  247. * The video drivers are presented in the order in which they are normally
  248. * checked during initialization.
  249. *
  250. * \param index the index of a video driver
  251. * \returns the name of the video driver with the given **index**.
  252. *
  253. * \since This function is available since SDL 3.0.0.
  254. *
  255. * \sa SDL_GetNumVideoDrivers
  256. */
  257. extern DECLSPEC const char *SDLCALL SDL_GetVideoDriver(int index);
  258. /**
  259. * Get the name of the currently initialized video driver.
  260. *
  261. * \returns the name of the current video driver or NULL if no driver has been
  262. * initialized.
  263. *
  264. * \since This function is available since SDL 3.0.0.
  265. *
  266. * \sa SDL_GetNumVideoDrivers
  267. * \sa SDL_GetVideoDriver
  268. */
  269. extern DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
  270. /**
  271. * Get a list of currently connected displays.
  272. *
  273. * \param count a pointer filled in with the number of displays returned
  274. * \returns a 0 terminated array of display instance IDs which should be freed
  275. * with SDL_free(), or NULL on error; call SDL_GetError() for more
  276. * details.
  277. *
  278. * \since This function is available since SDL 3.0.0.
  279. */
  280. extern DECLSPEC SDL_DisplayID *SDLCALL SDL_GetDisplays(int *count);
  281. /**
  282. * Return the primary display.
  283. *
  284. * \returns the instance ID of the primary display on success or 0 on failure;
  285. * call SDL_GetError() for more information.
  286. *
  287. * \since This function is available since SDL 3.0.0.
  288. *
  289. * \sa SDL_GetDisplays
  290. */
  291. extern DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void);
  292. /**
  293. * Get the name of a display in UTF-8 encoding.
  294. *
  295. * \param displayID the instance ID of the display to query
  296. * \returns the name of a display or NULL on failure; call SDL_GetError() for
  297. * more information.
  298. *
  299. * \since This function is available since SDL 3.0.0.
  300. *
  301. * \sa SDL_GetDisplays
  302. */
  303. extern DECLSPEC const char *SDLCALL SDL_GetDisplayName(SDL_DisplayID displayID);
  304. /**
  305. * Get the desktop area represented by a display, in screen coordinates.
  306. *
  307. * The primary display is always located at (0,0).
  308. *
  309. * \param displayID the instance ID of the display to query
  310. * \param rect the SDL_Rect structure filled in with the display bounds
  311. * \returns 0 on success or a negative error code on failure; call
  312. * SDL_GetError() for more information.
  313. *
  314. * \since This function is available since SDL 3.0.0.
  315. *
  316. * \sa SDL_GetDisplayUsableBounds
  317. * \sa SDL_GetDisplays
  318. */
  319. extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);
  320. /**
  321. * Get the usable desktop area represented by a display, in screen
  322. * coordinates.
  323. *
  324. * This is the same area as SDL_GetDisplayBounds() reports, but with portions
  325. * reserved by the system removed. For example, on Apple's macOS, this
  326. * subtracts the area occupied by the menu bar and dock.
  327. *
  328. * Setting a window to be fullscreen generally bypasses these unusable areas,
  329. * so these are good guidelines for the maximum space available to a
  330. * non-fullscreen window.
  331. *
  332. * \param displayID the instance ID of the display to query
  333. * \param rect the SDL_Rect structure filled in with the display bounds
  334. * \returns 0 on success or a negative error code on failure; call
  335. * SDL_GetError() for more information.
  336. *
  337. * \since This function is available since SDL 3.0.0.
  338. *
  339. * \sa SDL_GetDisplayBounds
  340. * \sa SDL_GetDisplays
  341. */
  342. extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);
  343. /**
  344. * Get the dots/pixels-per-inch for a display.
  345. *
  346. * Diagonal, horizontal and vertical DPI can all be optionally returned if the
  347. * appropriate parameter is non-NULL.
  348. *
  349. * **WARNING**: This reports the DPI that the hardware reports, and it is not
  350. * always reliable! It is almost always better to use SDL_GetWindowSize() to
  351. * find the window size, which might be in logical points instead of pixels,
  352. * and then SDL_GetWindowSizeInPixels() or SDL_GetRendererOutputSize(), and
  353. * compare the two values to get an actual scaling value between the two. We
  354. * will be rethinking how high-dpi details should be managed in SDL3 to make
  355. * things more consistent, reliable, and clear.
  356. *
  357. * \param displayID the instance ID of the display to query
  358. * \param ddpi a pointer filled in with the diagonal DPI of the display; may
  359. * be NULL
  360. * \param hdpi a pointer filled in with the horizontal DPI of the display; may
  361. * be NULL
  362. * \param vdpi a pointer filled in with the vertical DPI of the display; may
  363. * be NULL
  364. * \returns 0 on success or a negative error code on failure; call
  365. * SDL_GetError() for more information.
  366. *
  367. * \since This function is available since SDL 3.0.0.
  368. *
  369. * \sa SDL_GetDisplays
  370. */
  371. extern DECLSPEC int SDLCALL SDL_GetDisplayPhysicalDPI(SDL_DisplayID displayID, float *ddpi, float *hdpi, float *vdpi);
  372. /**
  373. * Get the orientation of a display.
  374. *
  375. * \param displayID the instance ID of the display to query
  376. * \returns The SDL_DisplayOrientation enum value of the display, or
  377. * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
  378. *
  379. * \since This function is available since SDL 3.0.0.
  380. *
  381. * \sa SDL_GetDisplays
  382. */
  383. extern DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetDisplayOrientation(SDL_DisplayID displayID);
  384. /**
  385. * Get a list of fullscreen display modes available on a display.
  386. *
  387. * The display modes are sorted in this priority:
  388. * - screen_w -> largest to smallest
  389. * - screen_h -> largest to smallest
  390. * - pixel_w -> largest to smallest
  391. * - pixel_h -> largest to smallest
  392. * - bits per pixel -> more colors to fewer colors
  393. * - packed pixel layout -> largest to smallest
  394. * - refresh rate -> highest to lowest
  395. *
  396. * \param displayID the instance ID of the display to query
  397. * \param count a pointer filled in with the number of displays returned
  398. * \returns a NULL terminated array of display mode pointers which should be freed
  399. * with SDL_free(), or NULL on error; call SDL_GetError() for more
  400. * details.
  401. *
  402. * \since This function is available since SDL 3.0.0.
  403. *
  404. * \sa SDL_GetDisplays
  405. */
  406. extern DECLSPEC const SDL_DisplayMode **SDLCALL SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count);
  407. /**
  408. * Get the closest match to the requested display mode.
  409. *
  410. * The available display modes are scanned and `closest` is filled in with the
  411. * closest mode matching the requested mode and returned. The mode format and
  412. * refresh rate default to the desktop mode if they are set to 0. The modes
  413. * are scanned with size being first priority, format being second priority,
  414. * and finally checking the refresh rate. If all the available modes are too
  415. * small, then NULL is returned.
  416. *
  417. * \param displayID the instance ID of the display to query
  418. * \param w the width in pixels of the desired display mode
  419. * \param h the height in pixels of the desired display mode
  420. * \param refresh_rate the refresh rate of the desired display mode, or 0.0f for the desktop refresh rate
  421. * \returns a pointer to the closest display mode equal to or larger than the desired mode, or NULL on error; call SDL_GetError() for more information.
  422. * \returns the passed in value `closest` or NULL if no matching video mode
  423. * was available; call SDL_GetError() for more information.
  424. *
  425. * \since This function is available since SDL 3.0.0.
  426. *
  427. * \sa SDL_GetDisplays
  428. * \sa SDL_GetFullscreenDisplayModes
  429. */
  430. extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate);
  431. /**
  432. * Get information about the desktop's display mode.
  433. *
  434. * There's a difference between this function and SDL_GetCurrentDisplayMode()
  435. * when SDL runs fullscreen and has changed the resolution. In that case this
  436. * function will return the previous native display mode, and not the current
  437. * display mode.
  438. *
  439. * \param displayID the instance ID of the display to query
  440. * \returns a pointer to the desktop display mode or NULL on error; call
  441. * SDL_GetError() for more information.
  442. *
  443. * \since This function is available since SDL 3.0.0.
  444. *
  445. * \sa SDL_GetCurrentDisplayMode
  446. * \sa SDL_GetDisplays
  447. */
  448. extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);
  449. /**
  450. * Get information about the current display mode.
  451. *
  452. * There's a difference between this function and SDL_GetDesktopDisplayMode()
  453. * when SDL runs fullscreen and has changed the resolution. In that case this
  454. * function will return the current display mode, and not the previous native
  455. * display mode.
  456. *
  457. * \param displayID the instance ID of the display to query
  458. * \returns a pointer to the desktop display mode or NULL on error; call
  459. * SDL_GetError() for more information.
  460. *
  461. * \since This function is available since SDL 3.0.0.
  462. *
  463. * \sa SDL_GetDesktopDisplayMode
  464. * \sa SDL_GetDisplays
  465. */
  466. extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayID displayID);
  467. /**
  468. * Get the display containing a point
  469. *
  470. * \param point the point to query
  471. * \returns the instance ID of the display containing the point or 0 on
  472. * failure; call SDL_GetError() for more information.
  473. *
  474. * \since This function is available since SDL 3.0.0.
  475. *
  476. * \sa SDL_GetDisplayBounds
  477. * \sa SDL_GetDisplays
  478. */
  479. extern DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point *point);
  480. /**
  481. * Get the display primarily containing a rect
  482. *
  483. * \param rect the rect to query
  484. * \returns the instance ID of the display entirely containing the rect or
  485. * closest to the center of the rect on success or 0 on failure; call
  486. * SDL_GetError() for more information.
  487. *
  488. * \since This function is available since SDL 3.0.0.
  489. *
  490. * \sa SDL_GetDisplayBounds
  491. * \sa SDL_GetDisplays
  492. */
  493. extern DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect *rect);
  494. /**
  495. * Get the display associated with a window.
  496. *
  497. * \param window the window to query
  498. * \returns the instance ID of the display containing the center of the window
  499. * on success or 0 on failure; call SDL_GetError() for more
  500. * information.
  501. *
  502. * \since This function is available since SDL 3.0.0.
  503. *
  504. * \sa SDL_GetDisplayBounds
  505. * \sa SDL_GetDisplays
  506. */
  507. extern DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *window);
  508. /**
  509. * Set the display mode to use when a window is visible and fullscreen.
  510. *
  511. * This only affects the display mode used when the window is fullscreen. To
  512. * change the window size when the window is not fullscreen, use
  513. * SDL_SetWindowSize().
  514. *
  515. * \param window the window to affect
  516. * \param mode a pointer to the display mode to use, which can be NULL for desktop mode, or one of the fullscreen modes returned by SDL_GetFullscreenDisplayModes().
  517. * \returns 0 on success or a negative error code on failure; call
  518. * SDL_GetError() for more information.
  519. *
  520. * \since This function is available since SDL 3.0.0.
  521. *
  522. * \sa SDL_GetWindowFullscreenMode
  523. * \sa SDL_SetWindowFullscreen
  524. */
  525. extern DECLSPEC int SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode);
  526. /**
  527. * Query the display mode to use when a window is visible at fullscreen.
  528. *
  529. * \param window the window to query
  530. * \returns a pointer to the fullscreen mode to use or NULL for desktop mode
  531. *
  532. * \since This function is available since SDL 3.0.0.
  533. *
  534. * \sa SDL_SetWindowFullscreenMode
  535. * \sa SDL_SetWindowFullscreen
  536. */
  537. extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetWindowFullscreenMode(SDL_Window *window);
  538. /**
  539. * Get the raw ICC profile data for the screen the window is currently on.
  540. *
  541. * Data returned should be freed with SDL_free.
  542. *
  543. * \param window the window to query
  544. * \param size the size of the ICC profile
  545. * \returns the raw ICC profile data on success or NULL on failure; call
  546. * SDL_GetError() for more information.
  547. *
  548. * \since This function is available since SDL 3.0.0.
  549. */
  550. extern DECLSPEC void *SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, size_t *size);
  551. /**
  552. * Get the pixel format associated with the window.
  553. *
  554. * \param window the window to query
  555. * \returns the pixel format of the window on success or
  556. * SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
  557. * information.
  558. *
  559. * \since This function is available since SDL 3.0.0.
  560. */
  561. extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window);
  562. /**
  563. * Create a window with the specified position, dimensions, and flags.
  564. *
  565. * `flags` may be any of the following OR'd together:
  566. *
  567. * - `SDL_WINDOW_FULLSCREEN`: fullscreen window at desktop resolution
  568. * - `SDL_WINDOW_OPENGL`: window usable with an OpenGL context
  569. * - `SDL_WINDOW_VULKAN`: window usable with a Vulkan instance
  570. * - `SDL_WINDOW_METAL`: window usable with a Metal instance
  571. * - `SDL_WINDOW_HIDDEN`: window is not visible
  572. * - `SDL_WINDOW_BORDERLESS`: no window decoration
  573. * - `SDL_WINDOW_RESIZABLE`: window can be resized
  574. * - `SDL_WINDOW_MINIMIZED`: window is minimized
  575. * - `SDL_WINDOW_MAXIMIZED`: window is maximized
  576. * - `SDL_WINDOW_MOUSE_GRABBED`: window has grabbed mouse focus
  577. *
  578. * The SDL_Window is implicitly shown if SDL_WINDOW_HIDDEN is not set.
  579. *
  580. * On Apple's macOS, you **must** set the NSHighResolutionCapable Info.plist
  581. * property to YES, otherwise you will not receive a High-DPI OpenGL canvas.
  582. *
  583. * The window size in pixels may differ from its size in screen coordinates if
  584. * the window is on a high density display (one with an OS scaling factor).
  585. * Use SDL_GetWindowSize() to query the client area's size in screen
  586. * coordinates, and SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize()
  587. * to query the drawable size in pixels. Note that the drawable size can vary
  588. * after the window is created and should be queried again if you get an
  589. * SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.
  590. *
  591. * If the window is set fullscreen, the width and height parameters `w` and
  592. * `h` will not be used. However, invalid size parameters (e.g. too large) may
  593. * still fail. Window size is actually limited to 16384 x 16384 for all
  594. * platforms at window creation.
  595. *
  596. * If the window is created with any of the SDL_WINDOW_OPENGL or
  597. * SDL_WINDOW_VULKAN flags, then the corresponding LoadLibrary function
  598. * (SDL_GL_LoadLibrary or SDL_Vulkan_LoadLibrary) is called and the
  599. * corresponding UnloadLibrary function is called by SDL_DestroyWindow().
  600. *
  601. * If SDL_WINDOW_VULKAN is specified and there isn't a working Vulkan driver,
  602. * SDL_CreateWindow() will fail because SDL_Vulkan_LoadLibrary() will fail.
  603. *
  604. * If SDL_WINDOW_METAL is specified on an OS that does not support Metal,
  605. * SDL_CreateWindow() will fail.
  606. *
  607. * On non-Apple devices, SDL requires you to either not link to the Vulkan
  608. * loader or link to a dynamic library version. This limitation may be removed
  609. * in a future version of SDL.
  610. *
  611. * \param title the title of the window, in UTF-8 encoding
  612. * \param x the x position of the window, `SDL_WINDOWPOS_CENTERED`, or
  613. * `SDL_WINDOWPOS_UNDEFINED`
  614. * \param y the y position of the window, `SDL_WINDOWPOS_CENTERED`, or
  615. * `SDL_WINDOWPOS_UNDEFINED`
  616. * \param w the width of the window, in screen coordinates
  617. * \param h the height of the window, in screen coordinates
  618. * \param flags 0, or one or more SDL_WindowFlags OR'd together
  619. * \returns the window that was created or NULL on failure; call
  620. * SDL_GetError() for more information.
  621. *
  622. * \since This function is available since SDL 3.0.0.
  623. *
  624. * \sa SDL_CreateWindowFrom
  625. * \sa SDL_DestroyWindow
  626. */
  627. extern DECLSPEC SDL_Window *SDLCALL SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags);
  628. /**
  629. * Create an SDL window from an existing native window.
  630. *
  631. * In some cases (e.g. OpenGL) and on some platforms (e.g. Microsoft Windows)
  632. * the hint `SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT` needs to be configured
  633. * before using SDL_CreateWindowFrom().
  634. *
  635. * \param data a pointer to driver-dependent window creation data, typically
  636. * your native window cast to a void*
  637. * \returns the window that was created or NULL on failure; call
  638. * SDL_GetError() for more information.
  639. *
  640. * \since This function is available since SDL 3.0.0.
  641. *
  642. * \sa SDL_CreateWindow
  643. * \sa SDL_DestroyWindow
  644. */
  645. extern DECLSPEC SDL_Window *SDLCALL SDL_CreateWindowFrom(const void *data);
  646. /**
  647. * Get the numeric ID of a window.
  648. *
  649. * The numeric ID is what SDL_WindowEvent references, and is necessary to map
  650. * these events to specific SDL_Window objects.
  651. *
  652. * \param window the window to query
  653. * \returns the ID of the window on success or 0 on failure; call
  654. * SDL_GetError() for more information.
  655. *
  656. * \since This function is available since SDL 3.0.0.
  657. *
  658. * \sa SDL_GetWindowFromID
  659. */
  660. extern DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window);
  661. /**
  662. * Get a window from a stored ID.
  663. *
  664. * The numeric ID is what SDL_WindowEvent references, and is necessary to map
  665. * these events to specific SDL_Window objects.
  666. *
  667. * \param id the ID of the window
  668. * \returns the window associated with `id` or NULL if it doesn't exist; call
  669. * SDL_GetError() for more information.
  670. *
  671. * \since This function is available since SDL 3.0.0.
  672. *
  673. * \sa SDL_GetWindowID
  674. */
  675. extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowFromID(SDL_WindowID id);
  676. /**
  677. * Get the window flags.
  678. *
  679. * \param window the window to query
  680. * \returns a mask of the SDL_WindowFlags associated with `window`
  681. *
  682. * \since This function is available since SDL 3.0.0.
  683. *
  684. * \sa SDL_CreateWindow
  685. * \sa SDL_HideWindow
  686. * \sa SDL_MaximizeWindow
  687. * \sa SDL_MinimizeWindow
  688. * \sa SDL_SetWindowFullscreen
  689. * \sa SDL_SetWindowGrab
  690. * \sa SDL_ShowWindow
  691. */
  692. extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window *window);
  693. /**
  694. * Set the title of a window.
  695. *
  696. * This string is expected to be in UTF-8 encoding.
  697. *
  698. * \param window the window to change
  699. * \param title the desired window title in UTF-8 format
  700. * \returns 0 on success or a negative error code on failure; call
  701. * SDL_GetError() for more information.
  702. *
  703. * \since This function is available since SDL 3.0.0.
  704. *
  705. * \sa SDL_GetWindowTitle
  706. */
  707. extern DECLSPEC int SDLCALL SDL_SetWindowTitle(SDL_Window *window, const char *title);
  708. /**
  709. * Get the title of a window.
  710. *
  711. * \param window the window to query
  712. * \returns the title of the window in UTF-8 format or "" if there is no
  713. * title.
  714. *
  715. * \since This function is available since SDL 3.0.0.
  716. *
  717. * \sa SDL_SetWindowTitle
  718. */
  719. extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window *window);
  720. /**
  721. * Set the icon for a window.
  722. *
  723. * \param window the window to change
  724. * \param icon an SDL_Surface structure containing the icon for the window
  725. * \returns 0 on success or a negative error code on failure; call
  726. * SDL_GetError() for more information.
  727. *
  728. * \since This function is available since SDL 3.0.0.
  729. */
  730. extern DECLSPEC int SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);
  731. /**
  732. * Associate an arbitrary named pointer with a window.
  733. *
  734. * `name` is case-sensitive.
  735. *
  736. * \param window the window to associate with the pointer
  737. * \param name the name of the pointer
  738. * \param userdata the associated pointer
  739. * \returns the previous value associated with `name`.
  740. *
  741. * \since This function is available since SDL 3.0.0.
  742. *
  743. * \sa SDL_GetWindowData
  744. */
  745. extern DECLSPEC void *SDLCALL SDL_SetWindowData(SDL_Window *window, const char *name, void *userdata);
  746. /**
  747. * Retrieve the data pointer associated with a window.
  748. *
  749. * \param window the window to query
  750. * \param name the name of the pointer
  751. * \returns the value associated with `name`.
  752. *
  753. * \since This function is available since SDL 3.0.0.
  754. *
  755. * \sa SDL_SetWindowData
  756. */
  757. extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window *window, const char *name);
  758. /**
  759. * Set the position of a window, in screen coordinates.
  760. *
  761. * \param window the window to reposition
  762. * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
  763. * `SDL_WINDOWPOS_UNDEFINED`
  764. * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
  765. * `SDL_WINDOWPOS_UNDEFINED`
  766. *
  767. * \since This function is available since SDL 3.0.0.
  768. *
  769. * \sa SDL_GetWindowPosition
  770. */
  771. extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x, int y);
  772. /**
  773. * Get the position of a window, in screen coordinates.
  774. *
  775. * If you do not need the value for one of the positions a NULL may be passed
  776. * in the `x` or `y` parameter.
  777. *
  778. * \param window the window to query
  779. * \param x a pointer filled in with the x position of the window, may be NULL
  780. * \param y a pointer filled in with the y position of the window, may be NULL
  781. *
  782. * \since This function is available since SDL 3.0.0.
  783. *
  784. * \sa SDL_SetWindowPosition
  785. */
  786. extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x, int *y);
  787. /**
  788. * Set the size of a window's client area, in screen coordinates.
  789. *
  790. * The window size in screen coordinates may differ from the size in pixels if
  791. * the window is on a high density display (one with an OS scaling factor).
  792. *
  793. * This only affects the size of the window when not in fullscreen mode. To change
  794. * the fullscreen mode of a window, use SDL_SetWindowFullscreenMode()
  795. *
  796. * \param window the window to change
  797. * \param w the width of the window, must be > 0
  798. * \param h the height of the window, must be > 0
  799. * \returns 0 on success or a negative error code on failure; call
  800. * SDL_GetError() for more information.
  801. *
  802. * \since This function is available since SDL 3.0.0.
  803. *
  804. * \sa SDL_GetWindowSize
  805. * \sa SDL_SetWindowFullscreenMode
  806. */
  807. extern DECLSPEC int SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int h);
  808. /**
  809. * Get the size of a window's client area, in screen coordinates.
  810. *
  811. * NULL can safely be passed as the `w` or `h` parameter if the width or
  812. * height value is not desired.
  813. *
  814. * The window size in screen coordinates may differ from the size in pixels if
  815. * the window is on a high density display (one with an OS scaling factor).
  816. * Use SDL_GetWindowSizeInPixels() or SDL_GetRenderOutputSize() to get the
  817. * real client area size in pixels.
  818. *
  819. * \param window the window to query the width and height from
  820. * \param w a pointer filled in with the width of the window, may be NULL
  821. * \param h a pointer filled in with the height of the window, may be NULL
  822. *
  823. * \since This function is available since SDL 3.0.0.
  824. *
  825. * \sa SDL_GetRenderOutputSize
  826. * \sa SDL_GetWindowSizeInPixels
  827. * \sa SDL_SetWindowSize
  828. */
  829. extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, int *h);
  830. /**
  831. * Get the size of a window's borders (decorations) around the client area, in
  832. * screen coordinates.
  833. *
  834. * Note: If this function fails (returns -1), the size values will be
  835. * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
  836. * window in question was borderless.
  837. *
  838. * Note: This function may fail on systems where the window has not yet been
  839. * decorated by the display server (for example, immediately after calling
  840. * SDL_CreateWindow). It is recommended that you wait at least until the
  841. * window has been presented and composited, so that the window system has a
  842. * chance to decorate the window and provide the border dimensions to SDL.
  843. *
  844. * This function also returns -1 if getting the information is not supported.
  845. *
  846. * \param window the window to query the size values of the border
  847. * (decorations) from
  848. * \param top pointer to variable for storing the size of the top border; NULL
  849. * is permitted
  850. * \param left pointer to variable for storing the size of the left border;
  851. * NULL is permitted
  852. * \param bottom pointer to variable for storing the size of the bottom
  853. * border; NULL is permitted
  854. * \param right pointer to variable for storing the size of the right border;
  855. * NULL is permitted
  856. * \returns 0 on success or a negative error code on failure; call
  857. * SDL_GetError() for more information.
  858. *
  859. * \since This function is available since SDL 3.0.0.
  860. *
  861. * \sa SDL_GetWindowSize
  862. */
  863. extern DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right);
  864. /**
  865. * Get the size of a window's client area, in pixels.
  866. *
  867. * The window size in pixels may differ from the size in screen coordinates if
  868. * the window is on a high density display (one with an OS scaling factor).
  869. *
  870. * \param window the window from which the drawable size should be queried
  871. * \param w a pointer to variable for storing the width in pixels, may be NULL
  872. * \param h a pointer to variable for storing the height in pixels, may be
  873. * NULL
  874. *
  875. * \since This function is available since SDL 3.0.0.
  876. *
  877. * \sa SDL_CreateWindow
  878. * \sa SDL_GetWindowSize
  879. */
  880. extern DECLSPEC void SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, int *w, int *h);
  881. /**
  882. * Set the minimum size of a window's client area, in screen coordinates.
  883. *
  884. * \param window the window to change
  885. * \param min_w the minimum width of the window
  886. * \param min_h the minimum height of the window
  887. * \returns 0 on success or a negative error code on failure; call
  888. * SDL_GetError() for more information.
  889. *
  890. * \since This function is available since SDL 3.0.0.
  891. *
  892. * \sa SDL_GetWindowMinimumSize
  893. * \sa SDL_SetWindowMaximumSize
  894. */
  895. extern DECLSPEC int SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int min_w, int min_h);
  896. /**
  897. * Get the minimum size of a window's client area, in screen coordinates.
  898. *
  899. * \param window the window to query
  900. * \param w a pointer filled in with the minimum width of the window, may be
  901. * NULL
  902. * \param h a pointer filled in with the minimum height of the window, may be
  903. * NULL
  904. *
  905. * \since This function is available since SDL 3.0.0.
  906. *
  907. * \sa SDL_GetWindowMaximumSize
  908. * \sa SDL_SetWindowMinimumSize
  909. */
  910. extern DECLSPEC void SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int *w, int *h);
  911. /**
  912. * Set the maximum size of a window's client area, in screen coordinates.
  913. *
  914. * \param window the window to change
  915. * \param max_w the maximum width of the window
  916. * \param max_h the maximum height of the window
  917. * \returns 0 on success or a negative error code on failure; call
  918. * SDL_GetError() for more information.
  919. *
  920. * \since This function is available since SDL 3.0.0.
  921. *
  922. * \sa SDL_GetWindowMaximumSize
  923. * \sa SDL_SetWindowMinimumSize
  924. */
  925. extern DECLSPEC int SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int max_w, int max_h);
  926. /**
  927. * Get the maximum size of a window's client area, in screen coordinates.
  928. *
  929. * \param window the window to query
  930. * \param w a pointer filled in with the maximum width of the window, may be
  931. * NULL
  932. * \param h a pointer filled in with the maximum height of the window, may be
  933. * NULL
  934. *
  935. * \since This function is available since SDL 3.0.0.
  936. *
  937. * \sa SDL_GetWindowMinimumSize
  938. * \sa SDL_SetWindowMaximumSize
  939. */
  940. extern DECLSPEC void SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int *w, int *h);
  941. /**
  942. * Set the border state of a window.
  943. *
  944. * This will add or remove the window's `SDL_WINDOW_BORDERLESS` flag and add
  945. * or remove the border from the actual window. This is a no-op if the
  946. * window's border already matches the requested state.
  947. *
  948. * You can't change the border state of a fullscreen window.
  949. *
  950. * \param window the window of which to change the border state
  951. * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border
  952. *
  953. * \since This function is available since SDL 3.0.0.
  954. *
  955. * \sa SDL_GetWindowFlags
  956. */
  957. extern DECLSPEC void SDLCALL SDL_SetWindowBordered(SDL_Window *window, SDL_bool bordered);
  958. /**
  959. * Set the user-resizable state of a window.
  960. *
  961. * This will add or remove the window's `SDL_WINDOW_RESIZABLE` flag and
  962. * allow/disallow user resizing of the window. This is a no-op if the window's
  963. * resizable state already matches the requested state.
  964. *
  965. * You can't change the resizable state of a fullscreen window.
  966. *
  967. * \param window the window of which to change the resizable state
  968. * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow
  969. *
  970. * \since This function is available since SDL 3.0.0.
  971. *
  972. * \sa SDL_GetWindowFlags
  973. */
  974. extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window *window, SDL_bool resizable);
  975. /**
  976. * Set the window to always be above the others.
  977. *
  978. * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
  979. * will bring the window to the front and keep the window above the rest.
  980. *
  981. * \param window The window of which to change the always on top state
  982. * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to
  983. * disable
  984. *
  985. * \since This function is available since SDL 3.0.0.
  986. *
  987. * \sa SDL_GetWindowFlags
  988. */
  989. extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, SDL_bool on_top);
  990. /**
  991. * Show a window.
  992. *
  993. * \param window the window to show
  994. *
  995. * \since This function is available since SDL 3.0.0.
  996. *
  997. * \sa SDL_HideWindow
  998. * \sa SDL_RaiseWindow
  999. */
  1000. extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window *window);
  1001. /**
  1002. * Hide a window.
  1003. *
  1004. * \param window the window to hide
  1005. *
  1006. * \since This function is available since SDL 3.0.0.
  1007. *
  1008. * \sa SDL_ShowWindow
  1009. */
  1010. extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window *window);
  1011. /**
  1012. * Raise a window above other windows and set the input focus.
  1013. *
  1014. * \param window the window to raise
  1015. *
  1016. * \since This function is available since SDL 3.0.0.
  1017. */
  1018. extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window *window);
  1019. /**
  1020. * Make a window as large as possible.
  1021. *
  1022. * \param window the window to maximize
  1023. *
  1024. * \since This function is available since SDL 3.0.0.
  1025. *
  1026. * \sa SDL_MinimizeWindow
  1027. * \sa SDL_RestoreWindow
  1028. */
  1029. extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window *window);
  1030. /**
  1031. * Minimize a window to an iconic representation.
  1032. *
  1033. * \param window the window to minimize
  1034. *
  1035. * \since This function is available since SDL 3.0.0.
  1036. *
  1037. * \sa SDL_MaximizeWindow
  1038. * \sa SDL_RestoreWindow
  1039. */
  1040. extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window *window);
  1041. /**
  1042. * Restore the size and position of a minimized or maximized window.
  1043. *
  1044. * \param window the window to restore
  1045. *
  1046. * \since This function is available since SDL 3.0.0.
  1047. *
  1048. * \sa SDL_MaximizeWindow
  1049. * \sa SDL_MinimizeWindow
  1050. */
  1051. extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window *window);
  1052. /**
  1053. * Set a window's fullscreen state.
  1054. *
  1055. * By default a window in fullscreen state uses fullscreen desktop mode,
  1056. * but a specific display mode can be set using SDL_SetWindowFullscreenMode().
  1057. *
  1058. * \param window the window to change
  1059. * \param fullscreen SDL_TRUE for fullscreen mode, SDL_FALSE for windowed mode
  1060. * \returns 0 on success or a negative error code on failure; call
  1061. * SDL_GetError() for more information.
  1062. *
  1063. * \since This function is available since SDL 3.0.0.
  1064. *
  1065. * \sa SDL_GetWindowFullscreenMode
  1066. * \sa SDL_SetWindowFullscreenMode
  1067. */
  1068. extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, SDL_bool fullscreen);
  1069. /**
  1070. * Get the SDL surface associated with the window.
  1071. *
  1072. * A new surface will be created with the optimal format for the window, if
  1073. * necessary. This surface will be freed when the window is destroyed. Do not
  1074. * free this surface.
  1075. *
  1076. * This surface will be invalidated if the window is resized. After resizing a
  1077. * window this function must be called again to return a valid surface.
  1078. *
  1079. * You may not combine this with 3D or the rendering API on this window.
  1080. *
  1081. * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
  1082. *
  1083. * \param window the window to query
  1084. * \returns the surface associated with the window, or NULL on failure; call
  1085. * SDL_GetError() for more information.
  1086. *
  1087. * \since This function is available since SDL 3.0.0.
  1088. *
  1089. * \sa SDL_UpdateWindowSurface
  1090. * \sa SDL_UpdateWindowSurfaceRects
  1091. */
  1092. extern DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window);
  1093. /**
  1094. * Copy the window surface to the screen.
  1095. *
  1096. * This is the function you use to reflect any changes to the surface on the
  1097. * screen.
  1098. *
  1099. * This function is equivalent to the SDL 1.2 API SDL_Flip().
  1100. *
  1101. * \param window the window to update
  1102. * \returns 0 on success or a negative error code on failure; call
  1103. * SDL_GetError() for more information.
  1104. *
  1105. * \since This function is available since SDL 3.0.0.
  1106. *
  1107. * \sa SDL_GetWindowSurface
  1108. * \sa SDL_UpdateWindowSurfaceRects
  1109. */
  1110. extern DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
  1111. /**
  1112. * Copy areas of the window surface to the screen.
  1113. *
  1114. * This is the function you use to reflect changes to portions of the surface
  1115. * on the screen.
  1116. *
  1117. * This function is equivalent to the SDL 1.2 API SDL_UpdateRects().
  1118. *
  1119. * \param window the window to update
  1120. * \param rects an array of SDL_Rect structures representing areas of the
  1121. * surface to copy, in pixels
  1122. * \param numrects the number of rectangles
  1123. * \returns 0 on success or a negative error code on failure; call
  1124. * SDL_GetError() for more information.
  1125. *
  1126. * \since This function is available since SDL 3.0.0.
  1127. *
  1128. * \sa SDL_GetWindowSurface
  1129. * \sa SDL_UpdateWindowSurface
  1130. */
  1131. extern DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window, const SDL_Rect *rects, int numrects);
  1132. /**
  1133. * Set a window's input grab mode.
  1134. *
  1135. * When input is grabbed, the mouse is confined to the window. This function
  1136. * will also grab the keyboard if `SDL_HINT_GRAB_KEYBOARD` is set. To grab the
  1137. * keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().
  1138. *
  1139. * If the caller enables a grab while another window is currently grabbed, the
  1140. * other window loses its grab in favor of the caller's window.
  1141. *
  1142. * \param window the window for which the input grab mode should be set
  1143. * \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input
  1144. *
  1145. * \since This function is available since SDL 3.0.0.
  1146. *
  1147. * \sa SDL_GetGrabbedWindow
  1148. * \sa SDL_GetWindowGrab
  1149. */
  1150. extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed);
  1151. /**
  1152. * Set a window's keyboard grab mode.
  1153. *
  1154. * Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or
  1155. * the Meta/Super key. Note that not all system keyboard shortcuts can be
  1156. * captured by applications (one example is Ctrl+Alt+Del on Windows).
  1157. *
  1158. * This is primarily intended for specialized applications such as VNC clients
  1159. * or VM frontends. Normal games should not use keyboard grab.
  1160. *
  1161. * When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the
  1162. * window is full-screen to ensure the user is not trapped in your
  1163. * application. If you have a custom keyboard shortcut to exit fullscreen
  1164. * mode, you may suppress this behavior with
  1165. * `SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED`.
  1166. *
  1167. * If the caller enables a grab while another window is currently grabbed, the
  1168. * other window loses its grab in favor of the caller's window.
  1169. *
  1170. * \param window The window for which the keyboard grab mode should be set.
  1171. * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
  1172. *
  1173. * \since This function is available since SDL 3.0.0.
  1174. *
  1175. * \sa SDL_GetWindowKeyboardGrab
  1176. * \sa SDL_SetWindowMouseGrab
  1177. * \sa SDL_SetWindowGrab
  1178. */
  1179. extern DECLSPEC void SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, SDL_bool grabbed);
  1180. /**
  1181. * Set a window's mouse grab mode.
  1182. *
  1183. * Mouse grab confines the mouse cursor to the window.
  1184. *
  1185. * \param window The window for which the mouse grab mode should be set.
  1186. * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release.
  1187. *
  1188. * \since This function is available since SDL 3.0.0.
  1189. *
  1190. * \sa SDL_GetWindowMouseGrab
  1191. * \sa SDL_SetWindowKeyboardGrab
  1192. * \sa SDL_SetWindowGrab
  1193. */
  1194. extern DECLSPEC void SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, SDL_bool grabbed);
  1195. /**
  1196. * Get a window's input grab mode.
  1197. *
  1198. * \param window the window to query
  1199. * \returns SDL_TRUE if input is grabbed, SDL_FALSE otherwise.
  1200. *
  1201. * \since This function is available since SDL 3.0.0.
  1202. *
  1203. * \sa SDL_SetWindowGrab
  1204. */
  1205. extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowGrab(SDL_Window *window);
  1206. /**
  1207. * Get a window's keyboard grab mode.
  1208. *
  1209. * \param window the window to query
  1210. * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
  1211. *
  1212. * \since This function is available since SDL 3.0.0.
  1213. *
  1214. * \sa SDL_SetWindowKeyboardGrab
  1215. * \sa SDL_GetWindowGrab
  1216. */
  1217. extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *window);
  1218. /**
  1219. * Get a window's mouse grab mode.
  1220. *
  1221. * \param window the window to query
  1222. * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
  1223. *
  1224. * \since This function is available since SDL 3.0.0.
  1225. *
  1226. * \sa SDL_SetWindowKeyboardGrab
  1227. * \sa SDL_GetWindowGrab
  1228. */
  1229. extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowMouseGrab(SDL_Window *window);
  1230. /**
  1231. * Get the window that currently has an input grab enabled.
  1232. *
  1233. * \returns the window if input is grabbed or NULL otherwise.
  1234. *
  1235. * \since This function is available since SDL 3.0.0.
  1236. *
  1237. * \sa SDL_GetWindowGrab
  1238. * \sa SDL_SetWindowGrab
  1239. */
  1240. extern DECLSPEC SDL_Window *SDLCALL SDL_GetGrabbedWindow(void);
  1241. /**
  1242. * Confines the cursor to the specified area of a window.
  1243. *
  1244. * Note that this does NOT grab the cursor, it only defines the area a cursor
  1245. * is restricted to when the window has mouse focus.
  1246. *
  1247. * \param window The window that will be associated with the barrier.
  1248. * \param rect A rectangle area in window-relative coordinates. If NULL the
  1249. * barrier for the specified window will be destroyed.
  1250. * \returns 0 on success or a negative error code on failure; call
  1251. * SDL_GetError() for more information.
  1252. *
  1253. * \since This function is available since SDL 3.0.0.
  1254. *
  1255. * \sa SDL_GetWindowMouseRect
  1256. * \sa SDL_SetWindowMouseGrab
  1257. */
  1258. extern DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);
  1259. /**
  1260. * Get the mouse confinement rectangle of a window.
  1261. *
  1262. * \param window The window to query
  1263. * \returns A pointer to the mouse confinement rectangle of a window, or NULL
  1264. * if there isn't one.
  1265. *
  1266. * \since This function is available since SDL 3.0.0.
  1267. *
  1268. * \sa SDL_SetWindowMouseRect
  1269. */
  1270. extern DECLSPEC const SDL_Rect *SDLCALL SDL_GetWindowMouseRect(SDL_Window *window);
  1271. /**
  1272. * Set the opacity for a window.
  1273. *
  1274. * The parameter `opacity` will be clamped internally between 0.0f
  1275. * (transparent) and 1.0f (opaque).
  1276. *
  1277. * This function also returns -1 if setting the opacity isn't supported.
  1278. *
  1279. * \param window the window which will be made transparent or opaque
  1280. * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque)
  1281. * \returns 0 on success or a negative error code on failure; call
  1282. * SDL_GetError() for more information.
  1283. *
  1284. * \since This function is available since SDL 3.0.0.
  1285. *
  1286. * \sa SDL_GetWindowOpacity
  1287. */
  1288. extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float opacity);
  1289. /**
  1290. * Get the opacity of a window.
  1291. *
  1292. * If transparency isn't supported on this platform, opacity will be reported
  1293. * as 1.0f without error.
  1294. *
  1295. * The parameter `opacity` is ignored if it is NULL.
  1296. *
  1297. * This function also returns -1 if an invalid window was provided.
  1298. *
  1299. * \param window the window to get the current opacity value from
  1300. * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
  1301. * \returns 0 on success or a negative error code on failure; call
  1302. * SDL_GetError() for more information.
  1303. *
  1304. * \since This function is available since SDL 3.0.0.
  1305. *
  1306. * \sa SDL_SetWindowOpacity
  1307. */
  1308. extern DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window *window, float *out_opacity);
  1309. /**
  1310. * Set the window as a modal for another window.
  1311. *
  1312. * \param modal_window the window that should be set modal
  1313. * \param parent_window the parent window for the modal window
  1314. * \returns 0 on success or a negative error code on failure; call
  1315. * SDL_GetError() for more information.
  1316. *
  1317. * \since This function is available since SDL 3.0.0.
  1318. */
  1319. extern DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window *modal_window, SDL_Window *parent_window);
  1320. /**
  1321. * Explicitly set input focus to the window.
  1322. *
  1323. * You almost certainly want SDL_RaiseWindow() instead of this function. Use
  1324. * this with caution, as you might give focus to a window that is completely
  1325. * obscured by other windows.
  1326. *
  1327. * \param window the window that should get the input focus
  1328. * \returns 0 on success or a negative error code on failure; call
  1329. * SDL_GetError() for more information.
  1330. *
  1331. * \since This function is available since SDL 3.0.0.
  1332. *
  1333. * \sa SDL_RaiseWindow
  1334. */
  1335. extern DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window *window);
  1336. /**
  1337. * Possible return values from the SDL_HitTest callback.
  1338. *
  1339. * \sa SDL_HitTest
  1340. */
  1341. typedef enum
  1342. {
  1343. SDL_HITTEST_NORMAL, /**< Region is normal. No special properties. */
  1344. SDL_HITTEST_DRAGGABLE, /**< Region can drag entire window. */
  1345. SDL_HITTEST_RESIZE_TOPLEFT,
  1346. SDL_HITTEST_RESIZE_TOP,
  1347. SDL_HITTEST_RESIZE_TOPRIGHT,
  1348. SDL_HITTEST_RESIZE_RIGHT,
  1349. SDL_HITTEST_RESIZE_BOTTOMRIGHT,
  1350. SDL_HITTEST_RESIZE_BOTTOM,
  1351. SDL_HITTEST_RESIZE_BOTTOMLEFT,
  1352. SDL_HITTEST_RESIZE_LEFT
  1353. } SDL_HitTestResult;
  1354. /**
  1355. * Callback used for hit-testing.
  1356. *
  1357. * \param win the SDL_Window where hit-testing was set on
  1358. * \param area an SDL_Point which should be hit-tested
  1359. * \param data what was passed as `callback_data` to SDL_SetWindowHitTest()
  1360. * \return an SDL_HitTestResult value.
  1361. *
  1362. * \sa SDL_SetWindowHitTest
  1363. */
  1364. typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
  1365. const SDL_Point *area,
  1366. void *data);
  1367. /**
  1368. * Provide a callback that decides if a window region has special properties.
  1369. *
  1370. * Normally windows are dragged and resized by decorations provided by the
  1371. * system window manager (a title bar, borders, etc), but for some apps, it
  1372. * makes sense to drag them from somewhere else inside the window itself; for
  1373. * example, one might have a borderless window that wants to be draggable from
  1374. * any part, or simulate its own title bar, etc.
  1375. *
  1376. * This function lets the app provide a callback that designates pieces of a
  1377. * given window as special. This callback is run during event processing if we
  1378. * need to tell the OS to treat a region of the window specially; the use of
  1379. * this callback is known as "hit testing."
  1380. *
  1381. * Mouse input may not be delivered to your application if it is within a
  1382. * special area; the OS will often apply that input to moving the window or
  1383. * resizing the window and not deliver it to the application.
  1384. *
  1385. * Specifying NULL for a callback disables hit-testing. Hit-testing is
  1386. * disabled by default.
  1387. *
  1388. * Platforms that don't support this functionality will return -1
  1389. * unconditionally, even if you're attempting to disable hit-testing.
  1390. *
  1391. * Your callback may fire at any time, and its firing does not indicate any
  1392. * specific behavior (for example, on Windows, this certainly might fire when
  1393. * the OS is deciding whether to drag your window, but it fires for lots of
  1394. * other reasons, too, some unrelated to anything you probably care about _and
  1395. * when the mouse isn't actually at the location it is testing_). Since this
  1396. * can fire at any time, you should try to keep your callback efficient,
  1397. * devoid of allocations, etc.
  1398. *
  1399. * \param window the window to set hit-testing on
  1400. * \param callback the function to call when doing a hit-test
  1401. * \param callback_data an app-defined void pointer passed to **callback**
  1402. * \returns 0 on success or -1 on error (including unsupported); call
  1403. * SDL_GetError() for more information.
  1404. *
  1405. * \since This function is available since SDL 3.0.0.
  1406. */
  1407. extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest callback, void *callback_data);
  1408. /**
  1409. * Request a window to demand attention from the user.
  1410. *
  1411. * \param window the window to be flashed
  1412. * \param operation the flash operation
  1413. * \returns 0 on success or a negative error code on failure; call
  1414. * SDL_GetError() for more information.
  1415. *
  1416. * \since This function is available since SDL 3.0.0.
  1417. */
  1418. extern DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOperation operation);
  1419. /**
  1420. * Destroy a window.
  1421. *
  1422. * If `window` is NULL, this function will return immediately after setting
  1423. * the SDL error message to "Invalid window". See SDL_GetError().
  1424. *
  1425. * \param window the window to destroy
  1426. *
  1427. * \since This function is available since SDL 3.0.0.
  1428. *
  1429. * \sa SDL_CreateWindow
  1430. * \sa SDL_CreateWindowFrom
  1431. */
  1432. extern DECLSPEC void SDLCALL SDL_DestroyWindow(SDL_Window *window);
  1433. /**
  1434. * Check whether the screensaver is currently enabled.
  1435. *
  1436. * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
  1437. * the screensaver was enabled by default.
  1438. *
  1439. * The default can also be changed using `SDL_HINT_VIDEO_ALLOW_SCREENSAVER`.
  1440. *
  1441. * \returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is
  1442. * disabled.
  1443. *
  1444. * \since This function is available since SDL 3.0.0.
  1445. *
  1446. * \sa SDL_DisableScreenSaver
  1447. * \sa SDL_EnableScreenSaver
  1448. */
  1449. extern DECLSPEC SDL_bool SDLCALL SDL_ScreenSaverEnabled(void);
  1450. /**
  1451. * Allow the screen to be blanked by a screen saver.
  1452. *
  1453. * \since This function is available since SDL 3.0.0.
  1454. *
  1455. * \sa SDL_DisableScreenSaver
  1456. * \sa SDL_ScreenSaverEnabled
  1457. */
  1458. extern DECLSPEC void SDLCALL SDL_EnableScreenSaver(void);
  1459. /**
  1460. * Prevent the screen from being blanked by a screen saver.
  1461. *
  1462. * If you disable the screensaver, it is automatically re-enabled when SDL
  1463. * quits.
  1464. *
  1465. * The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2
  1466. * the screensaver was enabled by default.
  1467. *
  1468. * \since This function is available since SDL 3.0.0.
  1469. *
  1470. * \sa SDL_EnableScreenSaver
  1471. * \sa SDL_ScreenSaverEnabled
  1472. */
  1473. extern DECLSPEC void SDLCALL SDL_DisableScreenSaver(void);
  1474. /**
  1475. * \name OpenGL support functions
  1476. */
  1477. /* @{ */
  1478. /**
  1479. * Dynamically load an OpenGL library.
  1480. *
  1481. * This should be done after initializing the video driver, but before
  1482. * creating any OpenGL windows. If no OpenGL library is loaded, the default
  1483. * library will be loaded upon creation of the first OpenGL window.
  1484. *
  1485. * If you do this, you need to retrieve all of the GL functions used in your
  1486. * program from the dynamic library using SDL_GL_GetProcAddress().
  1487. *
  1488. * \param path the platform dependent OpenGL library name, or NULL to open the
  1489. * default OpenGL library
  1490. * \returns 0 on success or a negative error code on failure; call
  1491. * SDL_GetError() for more information.
  1492. *
  1493. * \since This function is available since SDL 3.0.0.
  1494. *
  1495. * \sa SDL_GL_GetProcAddress
  1496. * \sa SDL_GL_UnloadLibrary
  1497. */
  1498. extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  1499. /**
  1500. * Get an OpenGL function by name.
  1501. *
  1502. * If the GL library is loaded at runtime with SDL_GL_LoadLibrary(), then all
  1503. * GL functions must be retrieved this way. Usually this is used to retrieve
  1504. * function pointers to OpenGL extensions.
  1505. *
  1506. * There are some quirks to looking up OpenGL functions that require some
  1507. * extra care from the application. If you code carefully, you can handle
  1508. * these quirks without any platform-specific code, though:
  1509. *
  1510. * - On Windows, function pointers are specific to the current GL context;
  1511. * this means you need to have created a GL context and made it current
  1512. * before calling SDL_GL_GetProcAddress(). If you recreate your context or
  1513. * create a second context, you should assume that any existing function
  1514. * pointers aren't valid to use with it. This is (currently) a
  1515. * Windows-specific limitation, and in practice lots of drivers don't suffer
  1516. * this limitation, but it is still the way the wgl API is documented to
  1517. * work and you should expect crashes if you don't respect it. Store a copy
  1518. * of the function pointers that comes and goes with context lifespan.
  1519. * - On X11, function pointers returned by this function are valid for any
  1520. * context, and can even be looked up before a context is created at all.
  1521. * This means that, for at least some common OpenGL implementations, if you
  1522. * look up a function that doesn't exist, you'll get a non-NULL result that
  1523. * is _NOT_ safe to call. You must always make sure the function is actually
  1524. * available for a given GL context before calling it, by checking for the
  1525. * existence of the appropriate extension with SDL_GL_ExtensionSupported(),
  1526. * or verifying that the version of OpenGL you're using offers the function
  1527. * as core functionality.
  1528. * - Some OpenGL drivers, on all platforms, *will* return NULL if a function
  1529. * isn't supported, but you can't count on this behavior. Check for
  1530. * extensions you use, and if you get a NULL anyway, act as if that
  1531. * extension wasn't available. This is probably a bug in the driver, but you
  1532. * can code defensively for this scenario anyhow.
  1533. * - Just because you're on Linux/Unix, don't assume you'll be using X11.
  1534. * Next-gen display servers are waiting to replace it, and may or may not
  1535. * make the same promises about function pointers.
  1536. * - OpenGL function pointers must be declared `APIENTRY` as in the example
  1537. * code. This will ensure the proper calling convention is followed on
  1538. * platforms where this matters (Win32) thereby avoiding stack corruption.
  1539. *
  1540. * \param proc the name of an OpenGL function
  1541. * \returns a pointer to the named OpenGL function. The returned pointer
  1542. * should be cast to the appropriate function signature.
  1543. *
  1544. * \since This function is available since SDL 3.0.0.
  1545. *
  1546. * \sa SDL_GL_ExtensionSupported
  1547. * \sa SDL_GL_LoadLibrary
  1548. * \sa SDL_GL_UnloadLibrary
  1549. */
  1550. extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char *proc);
  1551. /**
  1552. * Get an EGL library function by name.
  1553. *
  1554. * If an EGL library is loaded, this function allows applications to get entry
  1555. * points for EGL functions. This is useful to provide to an EGL API and
  1556. * extension loader.
  1557. *
  1558. * \param proc the name of an EGL function
  1559. * \returns a pointer to the named EGL function. The returned pointer should
  1560. * be cast to the appropriate function signature.
  1561. *
  1562. * \since This function is available since SDL 3.0.0.
  1563. *
  1564. * \sa SDL_GL_GetCurrentEGLDisplay
  1565. */
  1566. extern DECLSPEC SDL_FunctionPointer SDLCALL SDL_EGL_GetProcAddress(const char *proc);
  1567. /**
  1568. * Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
  1569. *
  1570. * \since This function is available since SDL 3.0.0.
  1571. *
  1572. * \sa SDL_GL_LoadLibrary
  1573. */
  1574. extern DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
  1575. /**
  1576. * Check if an OpenGL extension is supported for the current context.
  1577. *
  1578. * This function operates on the current GL context; you must have created a
  1579. * context and it must be current before calling this function. Do not assume
  1580. * that all contexts you create will have the same set of extensions
  1581. * available, or that recreating an existing context will offer the same
  1582. * extensions again.
  1583. *
  1584. * While it's probably not a massive overhead, this function is not an O(1)
  1585. * operation. Check the extensions you care about after creating the GL
  1586. * context and save that information somewhere instead of calling the function
  1587. * every time you need to know.
  1588. *
  1589. * \param extension the name of the extension to check
  1590. * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
  1591. *
  1592. * \since This function is available since SDL 3.0.0.
  1593. */
  1594. extern DECLSPEC SDL_bool SDLCALL SDL_GL_ExtensionSupported(const char *extension);
  1595. /**
  1596. * Reset all previously set OpenGL context attributes to their default values.
  1597. *
  1598. * \since This function is available since SDL 3.0.0.
  1599. *
  1600. * \sa SDL_GL_GetAttribute
  1601. * \sa SDL_GL_SetAttribute
  1602. */
  1603. extern DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
  1604. /**
  1605. * Set an OpenGL window attribute before window creation.
  1606. *
  1607. * This function sets the OpenGL attribute `attr` to `value`. The requested
  1608. * attributes should be set before creating an OpenGL window. You should use
  1609. * SDL_GL_GetAttribute() to check the values after creating the OpenGL
  1610. * context, since the values obtained can differ from the requested ones.
  1611. *
  1612. * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to set
  1613. * \param value the desired value for the attribute
  1614. * \returns 0 on success or a negative error code on failure; call
  1615. * SDL_GetError() for more information.
  1616. *
  1617. * \since This function is available since SDL 3.0.0.
  1618. *
  1619. * \sa SDL_GL_GetAttribute
  1620. * \sa SDL_GL_ResetAttributes
  1621. */
  1622. extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
  1623. /**
  1624. * Get the actual value for an attribute from the current context.
  1625. *
  1626. * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to get
  1627. * \param value a pointer filled in with the current value of `attr`
  1628. * \returns 0 on success or a negative error code on failure; call
  1629. * SDL_GetError() for more information.
  1630. *
  1631. * \since This function is available since SDL 3.0.0.
  1632. *
  1633. * \sa SDL_GL_ResetAttributes
  1634. * \sa SDL_GL_SetAttribute
  1635. */
  1636. extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value);
  1637. /**
  1638. * Create an OpenGL context for an OpenGL window, and make it current.
  1639. *
  1640. * Windows users new to OpenGL should note that, for historical reasons, GL
  1641. * functions added after OpenGL version 1.1 are not available by default.
  1642. * Those functions must be loaded at run-time, either with an OpenGL
  1643. * extension-handling library or with SDL_GL_GetProcAddress() and its related
  1644. * functions.
  1645. *
  1646. * SDL_GLContext is an alias for `void *`. It's opaque to the application.
  1647. *
  1648. * \param window the window to associate with the context
  1649. * \returns the OpenGL context associated with `window` or NULL on error; call
  1650. * SDL_GetError() for more details.
  1651. *
  1652. * \since This function is available since SDL 3.0.0.
  1653. *
  1654. * \sa SDL_GL_DeleteContext
  1655. * \sa SDL_GL_MakeCurrent
  1656. */
  1657. extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *window);
  1658. /**
  1659. * Set up an OpenGL context for rendering into an OpenGL window.
  1660. *
  1661. * The context must have been created with a compatible window.
  1662. *
  1663. * \param window the window to associate with the context
  1664. * \param context the OpenGL context to associate with the window
  1665. * \returns 0 on success or a negative error code on failure; call
  1666. * SDL_GetError() for more information.
  1667. *
  1668. * \since This function is available since SDL 3.0.0.
  1669. *
  1670. * \sa SDL_GL_CreateContext
  1671. */
  1672. extern DECLSPEC int SDLCALL SDL_GL_MakeCurrent(SDL_Window *window, SDL_GLContext context);
  1673. /**
  1674. * Get the currently active OpenGL window.
  1675. *
  1676. * \returns the currently active OpenGL window on success or NULL on failure;
  1677. * call SDL_GetError() for more information.
  1678. *
  1679. * \since This function is available since SDL 3.0.0.
  1680. */
  1681. extern DECLSPEC SDL_Window *SDLCALL SDL_GL_GetCurrentWindow(void);
  1682. /**
  1683. * Get the currently active OpenGL context.
  1684. *
  1685. * \returns the currently active OpenGL context or NULL on failure; call
  1686. * SDL_GetError() for more information.
  1687. *
  1688. * \since This function is available since SDL 3.0.0.
  1689. *
  1690. * \sa SDL_GL_MakeCurrent
  1691. */
  1692. extern DECLSPEC SDL_GLContext SDLCALL SDL_GL_GetCurrentContext(void);
  1693. /**
  1694. * Get the currently active EGL display.
  1695. *
  1696. * \returns the currently active EGL display or NULL on failure; call
  1697. * SDL_GetError() for more information.
  1698. *
  1699. * \since This function is available since SDL 3.0.0.
  1700. */
  1701. extern DECLSPEC SDL_EGLDisplay SDLCALL SDL_EGL_GetCurrentEGLDisplay(void);
  1702. /**
  1703. * Get the currently active EGL config.
  1704. *
  1705. * \returns the currently active EGL config or NULL on failure; call
  1706. * SDL_GetError() for more information.
  1707. *
  1708. * \since This function is available since SDL 3.0.0.
  1709. */
  1710. extern DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentEGLConfig(void);
  1711. /**
  1712. * Get the EGL surface associated with the window.
  1713. *
  1714. * \returns the EGLSurface pointer associated with the window, or NULL on
  1715. * failure.
  1716. *
  1717. * \since This function is available since SDL 3.0.0.
  1718. */
  1719. extern DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowEGLSurface(SDL_Window *window);
  1720. /**
  1721. * Sets the callbacks for defining custom EGLAttrib arrays for EGL
  1722. * initialization.
  1723. *
  1724. * Each callback should return a pointer to an EGL attribute array terminated
  1725. * with EGL_NONE. Callbacks may return NULL pointers to signal an error, which
  1726. * will cause the SDL_CreateWindow process to fail gracefully.
  1727. *
  1728. * The arrays returned by each callback will be appended to the existing
  1729. * attribute arrays defined by SDL.
  1730. *
  1731. * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.
  1732. *
  1733. * \param platformAttribCallback Callback for attributes to pass to
  1734. * eglGetPlatformDisplay.
  1735. * \param surfaceAttribCallback Callback for attributes to pass to
  1736. * eglCreateSurface.
  1737. * \param contextAttribCallback Callback for attributes to pass to
  1738. * eglCreateContext.
  1739. *
  1740. * \since This function is available since SDL 3.0.0.
  1741. */
  1742. extern DECLSPEC void SDLCALL SDL_EGL_SetEGLAttributeCallbacks(SDL_EGLAttribArrayCallback platformAttribCallback,
  1743. SDL_EGLIntArrayCallback surfaceAttribCallback,
  1744. SDL_EGLIntArrayCallback contextAttribCallback);
  1745. /**
  1746. * Set the swap interval for the current OpenGL context.
  1747. *
  1748. * Some systems allow specifying -1 for the interval, to enable adaptive
  1749. * vsync. Adaptive vsync works the same as vsync, but if you've already missed
  1750. * the vertical retrace for a given frame, it swaps buffers immediately, which
  1751. * might be less jarring for the user during occasional framerate drops. If an
  1752. * application requests adaptive vsync and the system does not support it,
  1753. * this function will fail and return -1. In such a case, you should probably
  1754. * retry the call with 1 for the interval.
  1755. *
  1756. * Adaptive vsync is implemented for some glX drivers with
  1757. * GLX_EXT_swap_control_tear, and for some Windows drivers with
  1758. * WGL_EXT_swap_control_tear.
  1759. *
  1760. * Read more on the Khronos wiki:
  1761. * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
  1762. *
  1763. * \param interval 0 for immediate updates, 1 for updates synchronized with
  1764. * the vertical retrace, -1 for adaptive vsync
  1765. * \returns 0 on success or -1 if setting the swap interval is not supported;
  1766. * call SDL_GetError() for more information.
  1767. *
  1768. * \since This function is available since SDL 3.0.0.
  1769. *
  1770. * \sa SDL_GL_GetSwapInterval
  1771. */
  1772. extern DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
  1773. /**
  1774. * Get the swap interval for the current OpenGL context.
  1775. *
  1776. * If the system can't determine the swap interval, or there isn't a valid
  1777. * current context, this function will set *interval to 0 as a safe default.
  1778. *
  1779. * \param interval Output interval value. 0 if there is no vertical retrace
  1780. * synchronization, 1 if the buffer swap is synchronized with
  1781. * the vertical retrace, and -1 if late swaps happen
  1782. * immediately instead of waiting for the next retrace
  1783. * \returns 0 on success or -1 error. call SDL_GetError() for more
  1784. * information.
  1785. *
  1786. * \since This function is available since SDL 3.0.0.
  1787. *
  1788. * \sa SDL_GL_SetSwapInterval
  1789. */
  1790. extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(int *interval);
  1791. /**
  1792. * Update a window with OpenGL rendering.
  1793. *
  1794. * This is used with double-buffered OpenGL contexts, which are the default.
  1795. *
  1796. * On macOS, make sure you bind 0 to the draw framebuffer before swapping the
  1797. * window, otherwise nothing will happen. If you aren't using
  1798. * glBindFramebuffer(), this is the default and you won't have to do anything
  1799. * extra.
  1800. *
  1801. * \param window the window to change
  1802. * \returns 0 on success or a negative error code on failure; call
  1803. * SDL_GetError() for more information.
  1804. *
  1805. * \since This function is available since SDL 3.0.0.
  1806. */
  1807. extern DECLSPEC int SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
  1808. /**
  1809. * Delete an OpenGL context.
  1810. *
  1811. * \param context the OpenGL context to be deleted
  1812. *
  1813. * \since This function is available since SDL 3.0.0.
  1814. *
  1815. * \sa SDL_GL_CreateContext
  1816. */
  1817. extern DECLSPEC void SDLCALL SDL_GL_DeleteContext(SDL_GLContext context);
  1818. /* @} *//* OpenGL support functions */
  1819. /* Ends C function definitions when using C++ */
  1820. #ifdef __cplusplus
  1821. }
  1822. #endif
  1823. #include <SDL3/SDL_close_code.h>
  1824. #endif /* SDL_video_h_ */