SDL_video.h 69 KB

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