SDL_render.h 71 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762
  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2024 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_render.h
  20. *
  21. * Header file for SDL 2D rendering functions.
  22. *
  23. * This API supports the following features:
  24. * * single pixel points
  25. * * single pixel lines
  26. * * filled rectangles
  27. * * texture images
  28. *
  29. * The primitives may be drawn in opaque, blended, or additive modes.
  30. *
  31. * The texture images may be drawn in opaque, blended, or additive modes.
  32. * They can have an additional color tint or alpha modulation applied to
  33. * them, and may also be stretched with linear interpolation.
  34. *
  35. * This API is designed to accelerate simple 2D operations. You may
  36. * want more functionality such as polygons and particle effects and
  37. * in that case you should use SDL's OpenGL/Direct3D support or one
  38. * of the many good 3D engines.
  39. *
  40. * These functions must be called from the main thread.
  41. * See this bug for details: https://github.com/libsdl-org/SDL/issues/986
  42. */
  43. #ifndef SDL_render_h_
  44. #define SDL_render_h_
  45. #include <SDL3/SDL_stdinc.h>
  46. #include <SDL3/SDL_events.h>
  47. #include <SDL3/SDL_properties.h>
  48. #include <SDL3/SDL_rect.h>
  49. #include <SDL3/SDL_video.h>
  50. #include <SDL3/SDL_begin_code.h>
  51. /* Set up for C function definitions, even when using C++ */
  52. #ifdef __cplusplus
  53. extern "C" {
  54. #endif
  55. /**
  56. * Flags used when creating a rendering context
  57. */
  58. typedef enum
  59. {
  60. SDL_RENDERER_SOFTWARE = 0x00000001, /**< The renderer is a software fallback */
  61. SDL_RENDERER_ACCELERATED = 0x00000002, /**< The renderer uses hardware
  62. acceleration */
  63. SDL_RENDERER_PRESENTVSYNC = 0x00000004 /**< Present is synchronized
  64. with the refresh rate */
  65. } SDL_RendererFlags;
  66. /**
  67. * Information on the capabilities of a render driver or context.
  68. */
  69. typedef struct SDL_RendererInfo
  70. {
  71. const char *name; /**< The name of the renderer */
  72. Uint32 flags; /**< Supported ::SDL_RendererFlags */
  73. Uint32 num_texture_formats; /**< The number of available texture formats */
  74. Uint32 texture_formats[16]; /**< The available texture formats */
  75. int max_texture_width; /**< The maximum texture width */
  76. int max_texture_height; /**< The maximum texture height */
  77. } SDL_RendererInfo;
  78. /**
  79. * Vertex structure
  80. */
  81. typedef struct SDL_Vertex
  82. {
  83. SDL_FPoint position; /**< Vertex position, in SDL_Renderer coordinates */
  84. SDL_Color color; /**< Vertex color */
  85. SDL_FPoint tex_coord; /**< Normalized texture coordinates, if needed */
  86. } SDL_Vertex;
  87. /**
  88. * The access pattern allowed for a texture.
  89. */
  90. typedef enum
  91. {
  92. SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
  93. SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
  94. SDL_TEXTUREACCESS_TARGET /**< Texture can be used as a render target */
  95. } SDL_TextureAccess;
  96. /**
  97. * Flip constants for SDL_RenderTextureRotated
  98. */
  99. typedef enum
  100. {
  101. SDL_FLIP_NONE = 0x00000000, /**< Do not flip */
  102. SDL_FLIP_HORIZONTAL = 0x00000001, /**< flip horizontally */
  103. SDL_FLIP_VERTICAL = 0x00000002 /**< flip vertically */
  104. } SDL_RendererFlip;
  105. /**
  106. * How the logical size is mapped to the output
  107. */
  108. typedef enum
  109. {
  110. SDL_LOGICAL_PRESENTATION_DISABLED, /**< There is no logical size in effect */
  111. SDL_LOGICAL_PRESENTATION_STRETCH, /**< The rendered content is stretched to the output resolution */
  112. SDL_LOGICAL_PRESENTATION_LETTERBOX, /**< The rendered content is fit to the largest dimension and the other dimension is letterboxed with black bars */
  113. SDL_LOGICAL_PRESENTATION_OVERSCAN, /**< The rendered content is fit to the smallest dimension and the other dimension extends beyond the output bounds */
  114. SDL_LOGICAL_PRESENTATION_INTEGER_SCALE /**< The rendered content is scaled up by integer multiples to fit the output resolution */
  115. } SDL_RendererLogicalPresentation;
  116. /**
  117. * A structure representing rendering state
  118. */
  119. struct SDL_Renderer;
  120. typedef struct SDL_Renderer SDL_Renderer;
  121. /**
  122. * An efficient driver-specific representation of pixel data
  123. */
  124. struct SDL_Texture;
  125. typedef struct SDL_Texture SDL_Texture;
  126. /* Function prototypes */
  127. /**
  128. * Get the number of 2D rendering drivers available for the current display.
  129. *
  130. * A render driver is a set of code that handles rendering and texture
  131. * management on a particular display. Normally there is only one, but some
  132. * drivers may have several available with different capabilities.
  133. *
  134. * There may be none if SDL was compiled without render support.
  135. *
  136. * \returns a number >= 0 on success or a negative error code on failure; call
  137. * SDL_GetError() for more information.
  138. *
  139. * \since This function is available since SDL 3.0.0.
  140. *
  141. * \sa SDL_CreateRenderer
  142. * \sa SDL_GetRenderDriver
  143. */
  144. extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
  145. /**
  146. * Use this function to get the name of a built in 2D rendering driver.
  147. *
  148. * The list of rendering drivers is given in the order that they are normally
  149. * initialized by default; the drivers that seem more reasonable to choose
  150. * first (as far as the SDL developers believe) are earlier in the list.
  151. *
  152. * The names of drivers are all simple, low-ASCII identifiers, like "opengl",
  153. * "direct3d12" or "metal". These never have Unicode characters, and are not
  154. * meant to be proper names.
  155. *
  156. * The returned value points to a static, read-only string; do not modify or
  157. * free it!
  158. *
  159. * \param index the index of the rendering driver; the value ranges from 0 to
  160. * SDL_GetNumRenderDrivers() - 1
  161. * \returns the name of the rendering driver at the requested index, or NULL
  162. * if an invalid index was specified.
  163. *
  164. * \since This function is available since SDL 3.0.0.
  165. *
  166. * \sa SDL_GetNumRenderDrivers
  167. */
  168. extern DECLSPEC const char *SDLCALL SDL_GetRenderDriver(int index);
  169. /**
  170. * Create a window and default renderer.
  171. *
  172. * \param width the width of the window
  173. * \param height the height of the window
  174. * \param window_flags the flags used to create the window (see
  175. * SDL_CreateWindow())
  176. * \param window a pointer filled with the window, or NULL on error
  177. * \param renderer a pointer filled with the renderer, or NULL on error
  178. * \returns 0 on success or a negative error code on failure; call
  179. * SDL_GetError() for more information.
  180. *
  181. * \since This function is available since SDL 3.0.0.
  182. *
  183. * \sa SDL_CreateRenderer
  184. * \sa SDL_CreateWindow
  185. */
  186. extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(int width, int height, Uint32 window_flags, SDL_Window **window, SDL_Renderer **renderer);
  187. /**
  188. * Create a 2D rendering context for a window.
  189. *
  190. * If you want a specific renderer, you can specify its name here. A list of
  191. * available renderers can be obtained by calling SDL_GetRenderDriver multiple
  192. * times, with indices from 0 to SDL_GetNumRenderDrivers()-1. If you don't
  193. * need a specific renderer, specify NULL and SDL will attempt to choose the
  194. * best option for you, based on what is available on the user's system.
  195. *
  196. * By default the rendering size matches the window size in pixels, but you
  197. * can call SDL_SetRenderLogicalPresentation() to change the content size and
  198. * scaling options.
  199. *
  200. * \param window the window where rendering is displayed
  201. * \param name the name of the rendering driver to initialize, or NULL to
  202. * initialize the first one supporting the requested flags
  203. * \param flags 0, or one or more SDL_RendererFlags OR'd together
  204. * \returns a valid rendering context or NULL if there was an error; call
  205. * SDL_GetError() for more information.
  206. *
  207. * \since This function is available since SDL 3.0.0.
  208. *
  209. * \sa SDL_CreateRendererWithProperties
  210. * \sa SDL_CreateSoftwareRenderer
  211. * \sa SDL_DestroyRenderer
  212. * \sa SDL_GetNumRenderDrivers
  213. * \sa SDL_GetRenderDriver
  214. * \sa SDL_GetRendererInfo
  215. */
  216. extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window, const char *name, Uint32 flags);
  217. /**
  218. * Create a 2D rendering context for a window, with the specified properties.
  219. *
  220. * These are the supported properties:
  221. *
  222. * - `SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER`: the window where rendering
  223. * is displayed
  224. * - `SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER`: the surface where
  225. * rendering is displayed, if you want a software renderer without a window
  226. * - `SDL_PROPERTY_RENDERER_CREATE_NAME_STRING`: the name of the rendering
  227. * driver to use, if a specific one is desired
  228. * - `SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN`: true if you want
  229. * present synchronized with the refresh rate
  230. *
  231. * \param props the properties to use
  232. * \returns a valid rendering context or NULL if there was an error; call
  233. * SDL_GetError() for more information.
  234. *
  235. * \since This function is available since SDL 3.0.0.
  236. *
  237. * \sa SDL_CreateRenderer
  238. * \sa SDL_CreateSoftwareRenderer
  239. * \sa SDL_DestroyRenderer
  240. * \sa SDL_GetRendererInfo
  241. */
  242. extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_PropertiesID props);
  243. #define SDL_PROPERTY_RENDERER_CREATE_WINDOW_POINTER "window"
  244. #define SDL_PROPERTY_RENDERER_CREATE_SURFACE_POINTER "surface"
  245. #define SDL_PROPERTY_RENDERER_CREATE_NAME_STRING "name"
  246. #define SDL_PROPERTY_RENDERER_CREATE_PRESENT_VSYNC_BOOLEAN "present_vsync"
  247. /**
  248. * Create a 2D software rendering context for a surface.
  249. *
  250. * Two other API which can be used to create SDL_Renderer:
  251. * SDL_CreateRenderer() and SDL_CreateWindowAndRenderer(). These can _also_
  252. * create a software renderer, but they are intended to be used with an
  253. * SDL_Window as the final destination and not an SDL_Surface.
  254. *
  255. * \param surface the SDL_Surface structure representing the surface where
  256. * rendering is done
  257. * \returns a valid rendering context or NULL if there was an error; call
  258. * SDL_GetError() for more information.
  259. *
  260. * \since This function is available since SDL 3.0.0.
  261. *
  262. * \sa SDL_CreateRenderer
  263. * \sa SDL_CreateWindowRenderer
  264. * \sa SDL_DestroyRenderer
  265. */
  266. extern DECLSPEC SDL_Renderer *SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface *surface);
  267. /**
  268. * Get the renderer associated with a window.
  269. *
  270. * \param window the window to query
  271. * \returns the rendering context on success or NULL on failure; call
  272. * SDL_GetError() for more information.
  273. *
  274. * \since This function is available since SDL 3.0.0.
  275. *
  276. * \sa SDL_CreateRenderer
  277. */
  278. extern DECLSPEC SDL_Renderer *SDLCALL SDL_GetRenderer(SDL_Window *window);
  279. /**
  280. * Get the window associated with a renderer.
  281. *
  282. * \param renderer the renderer to query
  283. * \returns the window on success or NULL on failure; call SDL_GetError() for
  284. * more information.
  285. *
  286. * \since This function is available since SDL 3.0.0.
  287. */
  288. extern DECLSPEC SDL_Window *SDLCALL SDL_GetRenderWindow(SDL_Renderer *renderer);
  289. /**
  290. * Get information about a rendering context.
  291. *
  292. * \param renderer the rendering context
  293. * \param info an SDL_RendererInfo structure filled with information about the
  294. * current renderer
  295. * \returns 0 on success or a negative error code on failure; call
  296. * SDL_GetError() for more information.
  297. *
  298. * \since This function is available since SDL 3.0.0.
  299. *
  300. * \sa SDL_CreateRenderer
  301. */
  302. extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_RendererInfo *info);
  303. /**
  304. * Get the properties associated with a renderer.
  305. *
  306. * The following read-only properties are provided by SDL:
  307. *
  308. * - `SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER`: the IDirect3DDevice9
  309. * associated with the renderer
  310. * - `SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER`: the ID3D11Device associated
  311. * with the renderer
  312. * - `SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER`: the ID3D12Device associated
  313. * with the renderer
  314. * - `SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER`: the
  315. * ID3D12CommandQueue associated with the renderer
  316. *
  317. * \param renderer the rendering context
  318. * \returns a valid property ID on success or 0 on failure; call
  319. * SDL_GetError() for more information.
  320. *
  321. * \since This function is available since SDL 3.0.0.
  322. *
  323. * \sa SDL_GetProperty
  324. * \sa SDL_SetProperty
  325. */
  326. extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Renderer *renderer);
  327. #define SDL_PROPERTY_RENDERER_D3D9_DEVICE_POINTER "SDL.renderer.d3d9.device"
  328. #define SDL_PROPERTY_RENDERER_D3D11_DEVICE_POINTER "SDL.renderer.d3d11.device"
  329. #define SDL_PROPERTY_RENDERER_D3D12_DEVICE_POINTER "SDL.renderer.d3d12.device"
  330. #define SDL_PROPERTY_RENDERER_D3D12_COMMAND_QUEUE_POINTER "SDL.renderer.d3d12.command_queue"
  331. /**
  332. * Get the output size in pixels of a rendering context.
  333. *
  334. * This returns the true output size in pixels, ignoring any render targets or
  335. * logical size and presentation.
  336. *
  337. * \param renderer the rendering context
  338. * \param w a pointer filled in with the width in pixels
  339. * \param h a pointer filled in with the height in pixels
  340. * \returns 0 on success or a negative error code on failure; call
  341. * SDL_GetError() for more information.
  342. *
  343. * \since This function is available since SDL 3.0.0.
  344. *
  345. * \sa SDL_GetRenderer
  346. */
  347. extern DECLSPEC int SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *renderer, int *w, int *h);
  348. /**
  349. * Get the current output size in pixels of a rendering context.
  350. *
  351. * If a rendering target is active, this will return the size of the rendering
  352. * target in pixels, otherwise if a logical size is set, it will return the
  353. * logical size, otherwise it will return the value of
  354. * SDL_GetRenderOutputSize().
  355. *
  356. * \param renderer the rendering context
  357. * \param w a pointer filled in with the current width
  358. * \param h a pointer filled in with the current height
  359. * \returns 0 on success or a negative error code on failure; call
  360. * SDL_GetError() for more information.
  361. *
  362. * \since This function is available since SDL 3.0.0.
  363. *
  364. * \sa SDL_GetRenderOutputSize
  365. * \sa SDL_GetRenderer
  366. */
  367. extern DECLSPEC int SDLCALL SDL_GetCurrentRenderOutputSize(SDL_Renderer *renderer, int *w, int *h);
  368. /**
  369. * Create a texture for a rendering context.
  370. *
  371. * You can set the texture scaling method by setting
  372. * `SDL_HINT_RENDER_SCALE_QUALITY` before creating the texture.
  373. *
  374. * \param renderer the rendering context
  375. * \param format one of the enumerated values in SDL_PixelFormatEnum
  376. * \param access one of the enumerated values in SDL_TextureAccess
  377. * \param w the width of the texture in pixels
  378. * \param h the height of the texture in pixels
  379. * \returns a pointer to the created texture or NULL if no rendering context
  380. * was active, the format was unsupported, or the width or height
  381. * were out of range; call SDL_GetError() for more information.
  382. *
  383. * \since This function is available since SDL 3.0.0.
  384. *
  385. * \sa SDL_CreateTextureFromSurface
  386. * \sa SDL_CreateTextureWithProperties
  387. * \sa SDL_DestroyTexture
  388. * \sa SDL_QueryTexture
  389. * \sa SDL_UpdateTexture
  390. */
  391. extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTexture(SDL_Renderer *renderer, Uint32 format, int access, int w, int h);
  392. /**
  393. * Create a texture from an existing surface.
  394. *
  395. * The surface is not modified or freed by this function.
  396. *
  397. * The SDL_TextureAccess hint for the created texture is
  398. * `SDL_TEXTUREACCESS_STATIC`.
  399. *
  400. * The pixel format of the created texture may be different from the pixel
  401. * format of the surface. Use SDL_QueryTexture() to query the pixel format of
  402. * the texture.
  403. *
  404. * \param renderer the rendering context
  405. * \param surface the SDL_Surface structure containing pixel data used to fill
  406. * the texture
  407. * \returns the created texture or NULL on failure; call SDL_GetError() for
  408. * more information.
  409. *
  410. * \since This function is available since SDL 3.0.0.
  411. *
  412. * \sa SDL_CreateTexture
  413. * \sa SDL_CreateTextureWithProperties
  414. * \sa SDL_DestroyTexture
  415. * \sa SDL_QueryTexture
  416. */
  417. extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *renderer, SDL_Surface *surface);
  418. /**
  419. * Create a texture for a rendering context with the specified properties.
  420. *
  421. * These are the supported properties:
  422. *
  423. * - `SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER`: one of the enumerated values
  424. * in SDL_PixelFormatEnum, defaults to the best RGBA format for the renderer
  425. * - `SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER`: one of the enumerated values
  426. * in SDL_TextureAccess, defaults to SDL_TEXTUREACCESS_STATIC
  427. * - `SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER`: the width of the texture in
  428. * pixels, required
  429. * - `SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER`: the height of the texture in
  430. * pixels, required
  431. *
  432. * With the direct3d11 renderer:
  433. *
  434. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D
  435. * associated with the texture, if you want to wrap an existing texture.
  436. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER`: the
  437. * ID3D11Texture2D associated with the U plane of a YUV texture, if you want
  438. * to wrap an existing texture.
  439. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER`: the
  440. * ID3D11Texture2D associated with the V plane of a YUV texture, if you want
  441. * to wrap an existing texture.
  442. *
  443. * With the direct3d12 renderer:
  444. *
  445. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER`: the ID3D12Resource
  446. * associated with the texture, if you want to wrap an existing texture.
  447. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource
  448. * associated with the U plane of a YUV texture, if you want to wrap an
  449. * existing texture.
  450. * - `SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource
  451. * associated with the V plane of a YUV texture, if you want to wrap an
  452. * existing texture.
  453. *
  454. * With the opengl renderer:
  455. *
  456. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER`: the GLuint texture
  457. * associated with the texture, if you want to wrap an existing texture.
  458. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint
  459. * texture associated with the UV plane of an NV12 texture, if you want to
  460. * wrap an existing texture.
  461. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture
  462. * associated with the U plane of a YUV texture, if you want to wrap an
  463. * existing texture.
  464. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture
  465. * associated with the V plane of a YUV texture, if you want to wrap an
  466. * existing texture.
  467. *
  468. * With the opengles2 renderer:
  469. *
  470. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint
  471. * texture associated with the texture, if you want to wrap an existing
  472. * texture.
  473. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER`: the GLuint
  474. * texture associated with the texture, if you want to wrap an existing
  475. * texture.
  476. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint
  477. * texture associated with the UV plane of an NV12 texture, if you want to
  478. * wrap an existing texture.
  479. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint
  480. * texture associated with the U plane of a YUV texture, if you want to wrap
  481. * an existing texture.
  482. * - `SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint
  483. * texture associated with the V plane of a YUV texture, if you want to wrap
  484. * an existing texture.
  485. *
  486. * \param renderer the rendering context
  487. * \param props the properties to use
  488. * \returns a pointer to the created texture or NULL if no rendering context
  489. * was active, the format was unsupported, or the width or height
  490. * were out of range; call SDL_GetError() for more information.
  491. *
  492. * \since This function is available since SDL 3.0.0.
  493. *
  494. * \sa SDL_CreateTextureFromSurface
  495. * \sa SDL_CreateTexture
  496. * \sa SDL_DestroyTexture
  497. * \sa SDL_QueryTexture
  498. * \sa SDL_UpdateTexture
  499. */
  500. extern DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureWithProperties(SDL_Renderer *renderer, SDL_PropertiesID props);
  501. #define SDL_PROPERTY_TEXTURE_CREATE_FORMAT_NUMBER "format"
  502. #define SDL_PROPERTY_TEXTURE_CREATE_ACCESS_NUMBER "access"
  503. #define SDL_PROPERTY_TEXTURE_CREATE_WIDTH_NUMBER "width"
  504. #define SDL_PROPERTY_TEXTURE_CREATE_HEIGHT_NUMBER "height"
  505. #define SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_POINTER "d3d11.texture"
  506. #define SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER "d3d11.texture_u"
  507. #define SDL_PROPERTY_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER "d3d11.texture_v"
  508. #define SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_POINTER "d3d12.texture"
  509. #define SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER "d3d12.texture_u"
  510. #define SDL_PROPERTY_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER "d3d12.texture_v"
  511. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER "opengl.texture"
  512. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER "opengl.texture_uv"
  513. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER "opengl.texture_u"
  514. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER "opengl.texture_v"
  515. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER "opengles2.texture"
  516. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER "opengles2.texture"
  517. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER "opengles2.texture_uv"
  518. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER "opengles2.texture_u"
  519. #define SDL_PROPERTY_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER "opengles2.texture_v"
  520. /**
  521. * Get the properties associated with a texture.
  522. *
  523. * The following read-only properties are provided by SDL:
  524. *
  525. * With the direct3d11 renderer:
  526. *
  527. * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER`: the ID3D11Texture2D
  528. * associated with the texture
  529. * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER`: the ID3D11Texture2D
  530. * associated with the U plane of a YUV texture
  531. * - `SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER`: the ID3D11Texture2D
  532. * associated with the V plane of a YUV texture
  533. *
  534. * With the direct3d12 renderer:
  535. *
  536. * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER`: the ID3D12Resource
  537. * associated with the texture
  538. * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER`: the ID3D12Resource
  539. * associated with the U plane of a YUV texture
  540. * - `SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER`: the ID3D12Resource
  541. * associated with the V plane of a YUV texture
  542. *
  543. * With the opengl renderer:
  544. *
  545. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER`: the GLuint texture
  546. * associated with the texture
  547. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER`: the GLuint texture
  548. * associated with the UV plane of an NV12 texture
  549. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER`: the GLuint texture
  550. * associated with the U plane of a YUV texture
  551. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER`: the GLuint texture
  552. * associated with the V plane of a YUV texture
  553. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT`: the texture coordinate width
  554. * of the texture (0.0 - 1.0)
  555. * - `SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT`: the texture coordinate height
  556. * of the texture (0.0 - 1.0)
  557. *
  558. * With the opengles2 renderer:
  559. *
  560. * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER`: the GLuint texture
  561. * associated with the texture
  562. * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER`: the GLuint texture
  563. * associated with the UV plane of an NV12 texture
  564. * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER`: the GLuint texture
  565. * associated with the U plane of a YUV texture
  566. * - `SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER`: the GLuint texture
  567. * associated with the V plane of a YUV texture
  568. *
  569. * \param texture the texture to query
  570. * \returns a valid property ID on success or 0 on failure; call
  571. * SDL_GetError() for more information.
  572. *
  573. * \since This function is available since SDL 3.0.0.
  574. *
  575. * \sa SDL_GetProperty
  576. * \sa SDL_SetProperty
  577. */
  578. extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetTextureProperties(SDL_Texture *texture);
  579. #define SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_POINTER "SDL.texture.d3d11.texture" /* the ID3D11Texture2D associated with the texture */
  580. #define SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_U_POINTER "SDL.texture.d3d11.texture_u" /* the ID3D11Texture2D associated with the U plane of a YUV texture */
  581. #define SDL_PROPERTY_TEXTURE_D3D11_TEXTURE_V_POINTER "SDL.texture.d3d11.texture_v" /* the ID3D11Texture2D associated with the V plane of a YUV texture */
  582. #define SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_POINTER "SDL.texture.d3d12.texture" /* the ID3D12Resource associated with the texture */
  583. #define SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_U_POINTER "SDL.texture.d3d12.texture_u" /* the ID3D12Resource associated with the U plane of a YUV texture */
  584. #define SDL_PROPERTY_TEXTURE_D3D12_TEXTURE_V_POINTER "SDL.texture.d3d12.texture_v" /* the ID3D12Resource associated with the V plane of a YUV texture */
  585. #define SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_NUMBER "SDL.texture.opengl.texture" /* the GLuint texture associated with the texture */
  586. #define SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_UV_NUMBER "SDL.texture.opengl.texture_uv" /* the GLuint texture associated with the UV plane of an NV12 texture */
  587. #define SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_U_NUMBER "SDL.texture.opengl.texture_u" /* the GLuint texture associated with the U plane of a YUV texture */
  588. #define SDL_PROPERTY_TEXTURE_OPENGL_TEXTURE_V_NUMBER "SDL.texture.opengl.texture_v" /* the GLuint texture associated with the V plane of a YUV texture */
  589. #define SDL_PROPERTY_TEXTURE_OPENGL_TEX_W_FLOAT "SDL.texture.opengl.tex_w" /* the texture coordinate width of the texture (0.0 - 1.0) */
  590. #define SDL_PROPERTY_TEXTURE_OPENGL_TEX_H_FLOAT "SDL.texture.opengl.tex_h" /* the texture coordinate height of the texture (0.0 - 1.0) */
  591. #define SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_NUMBER "SDL.texture.opengles2.texture" /* the GLuint texture associated with the texture */
  592. #define SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER "SDL.texture.opengles2.texture_uv" /* the GLuint texture associated with the UV plane of an NV12 texture */
  593. #define SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER "SDL.texture.opengles2.texture_u" /* the GLuint texture associated with the U plane of a YUV texture */
  594. #define SDL_PROPERTY_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER "SDL.texture.opengles2.texture_v" /* the GLuint texture associated with the V plane of a YUV texture */
  595. /**
  596. * Get the renderer that created an SDL_Texture.
  597. *
  598. * \param texture the texture to query
  599. * \returns a pointer to the SDL_Renderer that created the texture, or NULL on
  600. * failure; call SDL_GetError() for more information.
  601. *
  602. * \threadsafety It is safe to call this function from any thread.
  603. *
  604. * \since This function is available since SDL 3.0.0.
  605. *
  606. * \sa SDL_CreateTexture
  607. * \sa SDL_CreateTextureFromSurface
  608. * \sa SDL_CreateTextureWithProperties
  609. */
  610. extern DECLSPEC SDL_Renderer *SDLCALL SDL_GetTextureRenderer(SDL_Texture *texture);
  611. /**
  612. * Query the attributes of a texture.
  613. *
  614. * \param texture the texture to query
  615. * \param format a pointer filled in with the raw format of the texture; the
  616. * actual format may differ, but pixel transfers will use this
  617. * format (one of the SDL_PixelFormatEnum values). This argument
  618. * can be NULL if you don't need this information.
  619. * \param access a pointer filled in with the actual access to the texture
  620. * (one of the SDL_TextureAccess values). This argument can be
  621. * NULL if you don't need this information.
  622. * \param w a pointer filled in with the width of the texture in pixels. This
  623. * argument can be NULL if you don't need this information.
  624. * \param h a pointer filled in with the height of the texture in pixels. This
  625. * argument can be NULL if you don't need this information.
  626. * \returns 0 on success or a negative error code on failure; call
  627. * SDL_GetError() for more information.
  628. *
  629. * \since This function is available since SDL 3.0.0.
  630. *
  631. * \sa SDL_CreateTexture
  632. */
  633. extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture *texture, Uint32 *format, int *access, int *w, int *h);
  634. /**
  635. * Set an additional color value multiplied into render copy operations.
  636. *
  637. * When this texture is rendered, during the copy operation each source color
  638. * channel is modulated by the appropriate color value according to the
  639. * following formula:
  640. *
  641. * `srcC = srcC * (color / 255)`
  642. *
  643. * Color modulation is not always supported by the renderer; it will return -1
  644. * if color modulation is not supported.
  645. *
  646. * \param texture the texture to update
  647. * \param r the red color value multiplied into copy operations
  648. * \param g the green color value multiplied into copy operations
  649. * \param b the blue color value multiplied into copy operations
  650. * \returns 0 on success or a negative error code on failure; call
  651. * SDL_GetError() for more information.
  652. *
  653. * \since This function is available since SDL 3.0.0.
  654. *
  655. * \sa SDL_GetTextureColorMod
  656. * \sa SDL_SetTextureAlphaMod
  657. */
  658. extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b);
  659. /**
  660. * Get the additional color value multiplied into render copy operations.
  661. *
  662. * \param texture the texture to query
  663. * \param r a pointer filled in with the current red color value
  664. * \param g a pointer filled in with the current green color value
  665. * \param b a pointer filled in with the current blue color value
  666. * \returns 0 on success or a negative error code on failure; call
  667. * SDL_GetError() for more information.
  668. *
  669. * \since This function is available since SDL 3.0.0.
  670. *
  671. * \sa SDL_GetTextureAlphaMod
  672. * \sa SDL_SetTextureColorMod
  673. */
  674. extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture, Uint8 *r, Uint8 *g, Uint8 *b);
  675. /**
  676. * Set an additional alpha value multiplied into render copy operations.
  677. *
  678. * When this texture is rendered, during the copy operation the source alpha
  679. * value is modulated by this alpha value according to the following formula:
  680. *
  681. * `srcA = srcA * (alpha / 255)`
  682. *
  683. * Alpha modulation is not always supported by the renderer; it will return -1
  684. * if alpha modulation is not supported.
  685. *
  686. * \param texture the texture to update
  687. * \param alpha the source alpha value multiplied into copy operations
  688. * \returns 0 on success or a negative error code on failure; call
  689. * SDL_GetError() for more information.
  690. *
  691. * \since This function is available since SDL 3.0.0.
  692. *
  693. * \sa SDL_GetTextureAlphaMod
  694. * \sa SDL_SetTextureColorMod
  695. */
  696. extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture, Uint8 alpha);
  697. /**
  698. * Get the additional alpha value multiplied into render copy operations.
  699. *
  700. * \param texture the texture to query
  701. * \param alpha a pointer filled in with the current alpha value
  702. * \returns 0 on success or a negative error code on failure; call
  703. * SDL_GetError() for more information.
  704. *
  705. * \since This function is available since SDL 3.0.0.
  706. *
  707. * \sa SDL_GetTextureColorMod
  708. * \sa SDL_SetTextureAlphaMod
  709. */
  710. extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture, Uint8 *alpha);
  711. /**
  712. * Set the blend mode for a texture, used by SDL_RenderTexture().
  713. *
  714. * If the blend mode is not supported, the closest supported mode is chosen
  715. * and this function returns -1.
  716. *
  717. * \param texture the texture to update
  718. * \param blendMode the SDL_BlendMode to use for texture blending
  719. * \returns 0 on success or a negative error code on failure; call
  720. * SDL_GetError() for more information.
  721. *
  722. * \since This function is available since SDL 3.0.0.
  723. *
  724. * \sa SDL_GetTextureBlendMode
  725. * \sa SDL_RenderTexture
  726. */
  727. extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode);
  728. /**
  729. * Get the blend mode used for texture copy operations.
  730. *
  731. * \param texture the texture to query
  732. * \param blendMode a pointer filled in with the current SDL_BlendMode
  733. * \returns 0 on success or a negative error code on failure; call
  734. * SDL_GetError() for more information.
  735. *
  736. * \since This function is available since SDL 3.0.0.
  737. *
  738. * \sa SDL_SetTextureBlendMode
  739. */
  740. extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode *blendMode);
  741. /**
  742. * Set the scale mode used for texture scale operations.
  743. *
  744. * If the scale mode is not supported, the closest supported mode is chosen.
  745. *
  746. * \param texture The texture to update.
  747. * \param scaleMode the SDL_ScaleMode to use for texture scaling.
  748. * \returns 0 on success or a negative error code on failure; call
  749. * SDL_GetError() for more information.
  750. *
  751. * \since This function is available since SDL 3.0.0.
  752. *
  753. * \sa SDL_GetTextureScaleMode
  754. */
  755. extern DECLSPEC int SDLCALL SDL_SetTextureScaleMode(SDL_Texture *texture, SDL_ScaleMode scaleMode);
  756. /**
  757. * Get the scale mode used for texture scale operations.
  758. *
  759. * \param texture the texture to query.
  760. * \param scaleMode a pointer filled in with the current scale mode.
  761. * \returns 0 on success or a negative error code on failure; call
  762. * SDL_GetError() for more information.
  763. *
  764. * \since This function is available since SDL 3.0.0.
  765. *
  766. * \sa SDL_SetTextureScaleMode
  767. */
  768. extern DECLSPEC int SDLCALL SDL_GetTextureScaleMode(SDL_Texture *texture, SDL_ScaleMode *scaleMode);
  769. /**
  770. * Update the given texture rectangle with new pixel data.
  771. *
  772. * The pixel data must be in the pixel format of the texture. Use
  773. * SDL_QueryTexture() to query the pixel format of the texture.
  774. *
  775. * This is a fairly slow function, intended for use with static textures that
  776. * do not change often.
  777. *
  778. * If the texture is intended to be updated often, it is preferred to create
  779. * the texture as streaming and use the locking functions referenced below.
  780. * While this function will work with streaming textures, for optimization
  781. * reasons you may not get the pixels back if you lock the texture afterward.
  782. *
  783. * \param texture the texture to update
  784. * \param rect an SDL_Rect structure representing the area to update, or NULL
  785. * to update the entire texture
  786. * \param pixels the raw pixel data in the format of the texture
  787. * \param pitch the number of bytes in a row of pixel data, including padding
  788. * between lines
  789. * \returns 0 on success or a negative error code on failure; call
  790. * SDL_GetError() for more information.
  791. *
  792. * \since This function is available since SDL 3.0.0.
  793. *
  794. * \sa SDL_CreateTexture
  795. * \sa SDL_LockTexture
  796. * \sa SDL_UnlockTexture
  797. */
  798. extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch);
  799. /**
  800. * Update a rectangle within a planar YV12 or IYUV texture with new pixel
  801. * data.
  802. *
  803. * You can use SDL_UpdateTexture() as long as your pixel data is a contiguous
  804. * block of Y and U/V planes in the proper order, but this function is
  805. * available if your pixel data is not contiguous.
  806. *
  807. * \param texture the texture to update
  808. * \param rect a pointer to the rectangle of pixels to update, or NULL to
  809. * update the entire texture
  810. * \param Yplane the raw pixel data for the Y plane
  811. * \param Ypitch the number of bytes between rows of pixel data for the Y
  812. * plane
  813. * \param Uplane the raw pixel data for the U plane
  814. * \param Upitch the number of bytes between rows of pixel data for the U
  815. * plane
  816. * \param Vplane the raw pixel data for the V plane
  817. * \param Vpitch the number of bytes between rows of pixel data for the V
  818. * plane
  819. * \returns 0 on success or a negative error code on failure; call
  820. * SDL_GetError() for more information.
  821. *
  822. * \since This function is available since SDL 3.0.0.
  823. *
  824. * \sa SDL_UpdateTexture
  825. */
  826. extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture,
  827. const SDL_Rect *rect,
  828. const Uint8 *Yplane, int Ypitch,
  829. const Uint8 *Uplane, int Upitch,
  830. const Uint8 *Vplane, int Vpitch);
  831. /**
  832. * Update a rectangle within a planar NV12 or NV21 texture with new pixels.
  833. *
  834. * You can use SDL_UpdateTexture() as long as your pixel data is a contiguous
  835. * block of NV12/21 planes in the proper order, but this function is available
  836. * if your pixel data is not contiguous.
  837. *
  838. * \param texture the texture to update
  839. * \param rect a pointer to the rectangle of pixels to update, or NULL to
  840. * update the entire texture.
  841. * \param Yplane the raw pixel data for the Y plane.
  842. * \param Ypitch the number of bytes between rows of pixel data for the Y
  843. * plane.
  844. * \param UVplane the raw pixel data for the UV plane.
  845. * \param UVpitch the number of bytes between rows of pixel data for the UV
  846. * plane.
  847. * \returns 0 on success or a negative error code on failure; call
  848. * SDL_GetError() for more information.
  849. *
  850. * \since This function is available since SDL 3.0.0.
  851. */
  852. extern DECLSPEC int SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture,
  853. const SDL_Rect *rect,
  854. const Uint8 *Yplane, int Ypitch,
  855. const Uint8 *UVplane, int UVpitch);
  856. /**
  857. * Lock a portion of the texture for **write-only** pixel access.
  858. *
  859. * As an optimization, the pixels made available for editing don't necessarily
  860. * contain the old texture data. This is a write-only operation, and if you
  861. * need to keep a copy of the texture data you should do that at the
  862. * application level.
  863. *
  864. * You must use SDL_UnlockTexture() to unlock the pixels and apply any
  865. * changes.
  866. *
  867. * \param texture the texture to lock for access, which was created with
  868. * `SDL_TEXTUREACCESS_STREAMING`
  869. * \param rect an SDL_Rect structure representing the area to lock for access;
  870. * NULL to lock the entire texture
  871. * \param pixels this is filled in with a pointer to the locked pixels,
  872. * appropriately offset by the locked area
  873. * \param pitch this is filled in with the pitch of the locked pixels; the
  874. * pitch is the length of one row in bytes
  875. * \returns 0 on success or a negative error code if the texture is not valid
  876. * or was not created with `SDL_TEXTUREACCESS_STREAMING`; call
  877. * SDL_GetError() for more information.
  878. *
  879. * \since This function is available since SDL 3.0.0.
  880. *
  881. * \sa SDL_UnlockTexture
  882. */
  883. extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture *texture,
  884. const SDL_Rect *rect,
  885. void **pixels, int *pitch);
  886. /**
  887. * Lock a portion of the texture for **write-only** pixel access, and expose
  888. * it as a SDL surface.
  889. *
  890. * Besides providing an SDL_Surface instead of raw pixel data, this function
  891. * operates like SDL_LockTexture.
  892. *
  893. * As an optimization, the pixels made available for editing don't necessarily
  894. * contain the old texture data. This is a write-only operation, and if you
  895. * need to keep a copy of the texture data you should do that at the
  896. * application level.
  897. *
  898. * You must use SDL_UnlockTexture() to unlock the pixels and apply any
  899. * changes.
  900. *
  901. * The returned surface is freed internally after calling SDL_UnlockTexture()
  902. * or SDL_DestroyTexture(). The caller should not free it.
  903. *
  904. * \param texture the texture to lock for access, which must be created with
  905. * `SDL_TEXTUREACCESS_STREAMING`
  906. * \param rect a pointer to the rectangle to lock for access. If the rect is
  907. * NULL, the entire texture will be locked
  908. * \param surface this is filled in with an SDL surface representing the
  909. * locked area
  910. * \returns 0 on success or a negative error code on failure; call
  911. * SDL_GetError() for more information.
  912. *
  913. * \since This function is available since SDL 3.0.0.
  914. *
  915. * \sa SDL_LockTexture
  916. * \sa SDL_UnlockTexture
  917. */
  918. extern DECLSPEC int SDLCALL SDL_LockTextureToSurface(SDL_Texture *texture,
  919. const SDL_Rect *rect,
  920. SDL_Surface **surface);
  921. /**
  922. * Unlock a texture, uploading the changes to video memory, if needed.
  923. *
  924. * **Warning**: Please note that SDL_LockTexture() is intended to be
  925. * write-only; it will not guarantee the previous contents of the texture will
  926. * be provided. You must fully initialize any area of a texture that you lock
  927. * before unlocking it, as the pixels might otherwise be uninitialized memory.
  928. *
  929. * Which is to say: locking and immediately unlocking a texture can result in
  930. * corrupted textures, depending on the renderer in use.
  931. *
  932. * \param texture a texture locked by SDL_LockTexture()
  933. *
  934. * \since This function is available since SDL 3.0.0.
  935. *
  936. * \sa SDL_LockTexture
  937. */
  938. extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture);
  939. /**
  940. * Set a texture as the current rendering target.
  941. *
  942. * The default render target is the window for which the renderer was created.
  943. * To stop rendering to a texture and render to the window again, call this
  944. * function with a NULL `texture`.
  945. *
  946. * \param renderer the rendering context
  947. * \param texture the targeted texture, which must be created with the
  948. * `SDL_TEXTUREACCESS_TARGET` flag, or NULL to render to the
  949. * window instead of a texture.
  950. * \returns 0 on success or a negative error code on failure; call
  951. * SDL_GetError() for more information.
  952. *
  953. * \since This function is available since SDL 3.0.0.
  954. *
  955. * \sa SDL_GetRenderTarget
  956. */
  957. extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture);
  958. /**
  959. * Get the current render target.
  960. *
  961. * The default render target is the window for which the renderer was created,
  962. * and is reported a NULL here.
  963. *
  964. * \param renderer the rendering context
  965. * \returns the current render target or NULL for the default render target.
  966. *
  967. * \since This function is available since SDL 3.0.0.
  968. *
  969. * \sa SDL_SetRenderTarget
  970. */
  971. extern DECLSPEC SDL_Texture *SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
  972. /**
  973. * Set a device independent resolution and presentation mode for rendering.
  974. *
  975. * This function sets the width and height of the logical rendering output. A
  976. * render target is created at the specified size and used for rendering and
  977. * then copied to the output during presentation.
  978. *
  979. * You can disable logical coordinates by setting the mode to
  980. * SDL_LOGICAL_PRESENTATION_DISABLED, and in that case you get the full pixel
  981. * resolution of the output window.
  982. *
  983. * You can convert coordinates in an event into rendering coordinates using
  984. * SDL_ConvertEventToRenderCoordinates().
  985. *
  986. * \param renderer the rendering context
  987. * \param w the width of the logical resolution
  988. * \param h the height of the logical resolution
  989. * \param mode the presentation mode used
  990. * \param scale_mode the scale mode used
  991. * \returns 0 on success or a negative error code on failure; call
  992. * SDL_GetError() for more information.
  993. *
  994. * \since This function is available since SDL 3.0.0.
  995. *
  996. * \sa SDL_ConvertEventToRenderCoordinates
  997. * \sa SDL_GetRenderLogicalPresentation
  998. */
  999. extern DECLSPEC int SDLCALL SDL_SetRenderLogicalPresentation(SDL_Renderer *renderer, int w, int h, SDL_RendererLogicalPresentation mode, SDL_ScaleMode scale_mode);
  1000. /**
  1001. * Get device independent resolution and presentation mode for rendering.
  1002. *
  1003. * This function gets the width and height of the logical rendering output, or
  1004. * the output size in pixels if a logical resolution is not enabled.
  1005. *
  1006. * \param renderer the rendering context
  1007. * \param w an int to be filled with the width
  1008. * \param h an int to be filled with the height
  1009. * \param mode a pointer filled in with the presentation mode
  1010. * \param scale_mode a pointer filled in with the scale mode
  1011. * \returns 0 on success or a negative error code on failure; call
  1012. * SDL_GetError() for more information.
  1013. *
  1014. * \since This function is available since SDL 3.0.0.
  1015. *
  1016. * \sa SDL_SetRenderLogicalPresentation
  1017. */
  1018. extern DECLSPEC int SDLCALL SDL_GetRenderLogicalPresentation(SDL_Renderer *renderer, int *w, int *h, SDL_RendererLogicalPresentation *mode, SDL_ScaleMode *scale_mode);
  1019. /**
  1020. * Get a point in render coordinates when given a point in window coordinates.
  1021. *
  1022. * \param renderer the rendering context
  1023. * \param window_x the x coordinate in window coordinates
  1024. * \param window_y the y coordinate in window coordinates
  1025. * \param x a pointer filled with the x coordinate in render coordinates
  1026. * \param y a pointer filled with the y coordinate in render coordinates
  1027. * \returns 0 on success or a negative error code on failure; call
  1028. * SDL_GetError() for more information.
  1029. *
  1030. * \since This function is available since SDL 3.0.0.
  1031. *
  1032. * \sa SDL_SetRenderLogicalPresentation
  1033. * \sa SDL_SetRenderScale
  1034. */
  1035. extern DECLSPEC int SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Renderer *renderer, float window_x, float window_y, float *x, float *y);
  1036. /**
  1037. * Get a point in window coordinates when given a point in render coordinates.
  1038. *
  1039. * \param renderer the rendering context
  1040. * \param x the x coordinate in render coordinates
  1041. * \param y the y coordinate in render coordinates
  1042. * \param window_x a pointer filled with the x coordinate in window
  1043. * coordinates
  1044. * \param window_y a pointer filled with the y coordinate in window
  1045. * coordinates
  1046. * \returns 0 on success or a negative error code on failure; call
  1047. * SDL_GetError() for more information.
  1048. *
  1049. * \since This function is available since SDL 3.0.0.
  1050. *
  1051. * \sa SDL_SetRenderLogicalPresentation
  1052. * \sa SDL_SetRenderScale
  1053. */
  1054. extern DECLSPEC int SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer *renderer, float x, float y, float *window_x, float *window_y);
  1055. /**
  1056. * Convert the coordinates in an event to render coordinates.
  1057. *
  1058. * Touch coordinates are converted from normalized coordinates in the window
  1059. * to non-normalized rendering coordinates.
  1060. *
  1061. * Once converted, the coordinates may be outside the rendering area.
  1062. *
  1063. * \param renderer the rendering context
  1064. * \param event the event to modify
  1065. * \returns 0 on success or a negative error code on failure; call
  1066. * SDL_GetError() for more information.
  1067. *
  1068. * \since This function is available since SDL 3.0.0.
  1069. *
  1070. * \sa SDL_GetRenderCoordinatesFromWindowCoordinates
  1071. */
  1072. extern DECLSPEC int SDLCALL SDL_ConvertEventToRenderCoordinates(SDL_Renderer *renderer, SDL_Event *event);
  1073. /**
  1074. * Set the drawing area for rendering on the current target.
  1075. *
  1076. * \param renderer the rendering context
  1077. * \param rect the SDL_Rect structure representing the drawing area, or NULL
  1078. * to set the viewport to the entire target
  1079. * \returns 0 on success or a negative error code on failure; call
  1080. * SDL_GetError() for more information.
  1081. *
  1082. * \since This function is available since SDL 3.0.0.
  1083. *
  1084. * \sa SDL_GetRenderViewport
  1085. */
  1086. extern DECLSPEC int SDLCALL SDL_SetRenderViewport(SDL_Renderer *renderer, const SDL_Rect *rect);
  1087. /**
  1088. * Get the drawing area for the current target.
  1089. *
  1090. * \param renderer the rendering context
  1091. * \param rect an SDL_Rect structure filled in with the current drawing area
  1092. * \returns 0 on success or a negative error code on failure; call
  1093. * SDL_GetError() for more information.
  1094. *
  1095. * \since This function is available since SDL 3.0.0.
  1096. *
  1097. * \sa SDL_SetRenderViewport
  1098. */
  1099. extern DECLSPEC int SDLCALL SDL_GetRenderViewport(SDL_Renderer *renderer, SDL_Rect *rect);
  1100. /**
  1101. * Set the clip rectangle for rendering on the specified target.
  1102. *
  1103. * \param renderer the rendering context
  1104. * \param rect an SDL_Rect structure representing the clip area, relative to
  1105. * the viewport, or NULL to disable clipping
  1106. * \returns 0 on success or a negative error code on failure; call
  1107. * SDL_GetError() for more information.
  1108. *
  1109. * \since This function is available since SDL 3.0.0.
  1110. *
  1111. * \sa SDL_GetRenderClipRect
  1112. * \sa SDL_RenderClipEnabled
  1113. */
  1114. extern DECLSPEC int SDLCALL SDL_SetRenderClipRect(SDL_Renderer *renderer, const SDL_Rect *rect);
  1115. /**
  1116. * Get the clip rectangle for the current target.
  1117. *
  1118. * \param renderer the rendering context
  1119. * \param rect an SDL_Rect structure filled in with the current clipping area
  1120. * or an empty rectangle if clipping is disabled
  1121. * \returns 0 on success or a negative error code on failure; call
  1122. * SDL_GetError() for more information.
  1123. *
  1124. * \since This function is available since SDL 3.0.0.
  1125. *
  1126. * \sa SDL_RenderClipEnabled
  1127. * \sa SDL_SetRenderClipRect
  1128. */
  1129. extern DECLSPEC int SDLCALL SDL_GetRenderClipRect(SDL_Renderer *renderer, SDL_Rect *rect);
  1130. /**
  1131. * Get whether clipping is enabled on the given renderer.
  1132. *
  1133. * \param renderer the rendering context
  1134. * \returns SDL_TRUE if clipping is enabled or SDL_FALSE if not; call
  1135. * SDL_GetError() for more information.
  1136. *
  1137. * \since This function is available since SDL 3.0.0.
  1138. *
  1139. * \sa SDL_GetRenderClipRect
  1140. * \sa SDL_SetRenderClipRect
  1141. */
  1142. extern DECLSPEC SDL_bool SDLCALL SDL_RenderClipEnabled(SDL_Renderer *renderer);
  1143. /**
  1144. * Set the drawing scale for rendering on the current target.
  1145. *
  1146. * The drawing coordinates are scaled by the x/y scaling factors before they
  1147. * are used by the renderer. This allows resolution independent drawing with a
  1148. * single coordinate system.
  1149. *
  1150. * If this results in scaling or subpixel drawing by the rendering backend, it
  1151. * will be handled using the appropriate quality hints. For best results use
  1152. * integer scaling factors.
  1153. *
  1154. * \param renderer the rendering context
  1155. * \param scaleX the horizontal scaling factor
  1156. * \param scaleY the vertical scaling factor
  1157. * \returns 0 on success or a negative error code on failure; call
  1158. * SDL_GetError() for more information.
  1159. *
  1160. * \since This function is available since SDL 3.0.0.
  1161. *
  1162. * \sa SDL_GetRenderScale
  1163. */
  1164. extern DECLSPEC int SDLCALL SDL_SetRenderScale(SDL_Renderer *renderer, float scaleX, float scaleY);
  1165. /**
  1166. * Get the drawing scale for the current target.
  1167. *
  1168. * \param renderer the rendering context
  1169. * \param scaleX a pointer filled in with the horizontal scaling factor
  1170. * \param scaleY a pointer filled in with the vertical scaling factor
  1171. * \returns 0 on success or a negative error code on failure; call
  1172. * SDL_GetError() for more information.
  1173. *
  1174. * \since This function is available since SDL 3.0.0.
  1175. *
  1176. * \sa SDL_SetRenderScale
  1177. */
  1178. extern DECLSPEC int SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, float *scaleX, float *scaleY);
  1179. /**
  1180. * Set the color used for drawing operations (Rect, Line and Clear).
  1181. *
  1182. * Set the color for drawing or filling rectangles, lines, and points, and for
  1183. * SDL_RenderClear().
  1184. *
  1185. * \param renderer the rendering context
  1186. * \param r the red value used to draw on the rendering target
  1187. * \param g the green value used to draw on the rendering target
  1188. * \param b the blue value used to draw on the rendering target
  1189. * \param a the alpha value used to draw on the rendering target; usually
  1190. * `SDL_ALPHA_OPAQUE` (255). Use SDL_SetRenderDrawBlendMode to
  1191. * specify how the alpha channel is used
  1192. * \returns 0 on success or a negative error code on failure; call
  1193. * SDL_GetError() for more information.
  1194. *
  1195. * \since This function is available since SDL 3.0.0.
  1196. *
  1197. * \sa SDL_GetRenderDrawColor
  1198. * \sa SDL_RenderClear
  1199. * \sa SDL_RenderLine
  1200. * \sa SDL_RenderLines
  1201. * \sa SDL_RenderPoint
  1202. * \sa SDL_RenderPoints
  1203. * \sa SDL_RenderRect
  1204. * \sa SDL_RenderRects
  1205. * \sa SDL_RenderFillRect
  1206. * \sa SDL_RenderFillRects
  1207. */
  1208. extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
  1209. /**
  1210. * Get the color used for drawing operations (Rect, Line and Clear).
  1211. *
  1212. * \param renderer the rendering context
  1213. * \param r a pointer filled in with the red value used to draw on the
  1214. * rendering target
  1215. * \param g a pointer filled in with the green value used to draw on the
  1216. * rendering target
  1217. * \param b a pointer filled in with the blue value used to draw on the
  1218. * rendering target
  1219. * \param a a pointer filled in with the alpha value used to draw on the
  1220. * rendering target; usually `SDL_ALPHA_OPAQUE` (255)
  1221. * \returns 0 on success or a negative error code on failure; call
  1222. * SDL_GetError() for more information.
  1223. *
  1224. * \since This function is available since SDL 3.0.0.
  1225. *
  1226. * \sa SDL_SetRenderDrawColor
  1227. */
  1228. extern DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *renderer, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
  1229. /**
  1230. * Set the blend mode used for drawing operations (Fill and Line).
  1231. *
  1232. * If the blend mode is not supported, the closest supported mode is chosen.
  1233. *
  1234. * \param renderer the rendering context
  1235. * \param blendMode the SDL_BlendMode to use for blending
  1236. * \returns 0 on success or a negative error code on failure; call
  1237. * SDL_GetError() for more information.
  1238. *
  1239. * \since This function is available since SDL 3.0.0.
  1240. *
  1241. * \sa SDL_GetRenderDrawBlendMode
  1242. * \sa SDL_RenderLine
  1243. * \sa SDL_RenderLines
  1244. * \sa SDL_RenderPoint
  1245. * \sa SDL_RenderPoints
  1246. * \sa SDL_RenderRect
  1247. * \sa SDL_RenderRects
  1248. * \sa SDL_RenderFillRect
  1249. * \sa SDL_RenderFillRects
  1250. */
  1251. extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode);
  1252. /**
  1253. * Get the blend mode used for drawing operations.
  1254. *
  1255. * \param renderer the rendering context
  1256. * \param blendMode a pointer filled in with the current SDL_BlendMode
  1257. * \returns 0 on success or a negative error code on failure; call
  1258. * SDL_GetError() for more information.
  1259. *
  1260. * \since This function is available since SDL 3.0.0.
  1261. *
  1262. * \sa SDL_SetRenderDrawBlendMode
  1263. */
  1264. extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode *blendMode);
  1265. /**
  1266. * Clear the current rendering target with the drawing color.
  1267. *
  1268. * This function clears the entire rendering target, ignoring the viewport and
  1269. * the clip rectangle.
  1270. *
  1271. * \param renderer the rendering context
  1272. * \returns 0 on success or a negative error code on failure; call
  1273. * SDL_GetError() for more information.
  1274. *
  1275. * \since This function is available since SDL 3.0.0.
  1276. *
  1277. * \sa SDL_SetRenderDrawColor
  1278. */
  1279. extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer *renderer);
  1280. /**
  1281. * Draw a point on the current rendering target at subpixel precision.
  1282. *
  1283. * \param renderer The renderer which should draw a point.
  1284. * \param x The x coordinate of the point.
  1285. * \param y The y coordinate of the point.
  1286. * \returns 0 on success, or -1 on error
  1287. *
  1288. * \since This function is available since SDL 3.0.0.
  1289. */
  1290. extern DECLSPEC int SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, float x, float y);
  1291. /**
  1292. * Draw multiple points on the current rendering target at subpixel precision.
  1293. *
  1294. * \param renderer The renderer which should draw multiple points.
  1295. * \param points The points to draw
  1296. * \param count The number of points to draw
  1297. * \returns 0 on success or a negative error code on failure; call
  1298. * SDL_GetError() for more information.
  1299. *
  1300. * \since This function is available since SDL 3.0.0.
  1301. */
  1302. extern DECLSPEC int SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, const SDL_FPoint *points, int count);
  1303. /**
  1304. * Draw a line on the current rendering target at subpixel precision.
  1305. *
  1306. * \param renderer The renderer which should draw a line.
  1307. * \param x1 The x coordinate of the start point.
  1308. * \param y1 The y coordinate of the start point.
  1309. * \param x2 The x coordinate of the end point.
  1310. * \param y2 The y coordinate of the end point.
  1311. * \returns 0 on success, or -1 on error
  1312. *
  1313. * \since This function is available since SDL 3.0.0.
  1314. */
  1315. extern DECLSPEC int SDLCALL SDL_RenderLine(SDL_Renderer *renderer, float x1, float y1, float x2, float y2);
  1316. /**
  1317. * Draw a series of connected lines on the current rendering target at
  1318. * subpixel precision.
  1319. *
  1320. * \param renderer The renderer which should draw multiple lines.
  1321. * \param points The points along the lines
  1322. * \param count The number of points, drawing count-1 lines
  1323. * \returns 0 on success or a negative error code on failure; call
  1324. * SDL_GetError() for more information.
  1325. *
  1326. * \since This function is available since SDL 3.0.0.
  1327. */
  1328. extern DECLSPEC int SDLCALL SDL_RenderLines(SDL_Renderer *renderer, const SDL_FPoint *points, int count);
  1329. /**
  1330. * Draw a rectangle on the current rendering target at subpixel precision.
  1331. *
  1332. * \param renderer The renderer which should draw a rectangle.
  1333. * \param rect A pointer to the destination rectangle, or NULL to outline the
  1334. * entire rendering target.
  1335. * \returns 0 on success, or -1 on error
  1336. *
  1337. * \since This function is available since SDL 3.0.0.
  1338. */
  1339. extern DECLSPEC int SDLCALL SDL_RenderRect(SDL_Renderer *renderer, const SDL_FRect *rect);
  1340. /**
  1341. * Draw some number of rectangles on the current rendering target at subpixel
  1342. * precision.
  1343. *
  1344. * \param renderer The renderer which should draw multiple rectangles.
  1345. * \param rects A pointer to an array of destination rectangles.
  1346. * \param count The number of rectangles.
  1347. * \returns 0 on success or a negative error code on failure; call
  1348. * SDL_GetError() for more information.
  1349. *
  1350. * \since This function is available since SDL 3.0.0.
  1351. */
  1352. extern DECLSPEC int SDLCALL SDL_RenderRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count);
  1353. /**
  1354. * Fill a rectangle on the current rendering target with the drawing color at
  1355. * subpixel precision.
  1356. *
  1357. * \param renderer The renderer which should fill a rectangle.
  1358. * \param rect A pointer to the destination rectangle, or NULL for the entire
  1359. * rendering target.
  1360. * \returns 0 on success, or -1 on error
  1361. *
  1362. * \since This function is available since SDL 3.0.0.
  1363. */
  1364. extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, const SDL_FRect *rect);
  1365. /**
  1366. * Fill some number of rectangles on the current rendering target with the
  1367. * drawing color at subpixel precision.
  1368. *
  1369. * \param renderer The renderer which should fill multiple rectangles.
  1370. * \param rects A pointer to an array of destination rectangles.
  1371. * \param count The number of rectangles.
  1372. * \returns 0 on success or a negative error code on failure; call
  1373. * SDL_GetError() for more information.
  1374. *
  1375. * \since This function is available since SDL 3.0.0.
  1376. */
  1377. extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, const SDL_FRect *rects, int count);
  1378. /**
  1379. * Copy a portion of the texture to the current rendering target at subpixel
  1380. * precision.
  1381. *
  1382. * \param renderer The renderer which should copy parts of a texture.
  1383. * \param texture The source texture.
  1384. * \param srcrect A pointer to the source rectangle, or NULL for the entire
  1385. * texture.
  1386. * \param dstrect A pointer to the destination rectangle, or NULL for the
  1387. * entire rendering target.
  1388. * \returns 0 on success, or -1 on error
  1389. *
  1390. * \since This function is available since SDL 3.0.0.
  1391. */
  1392. extern DECLSPEC int SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_FRect *srcrect, const SDL_FRect *dstrect);
  1393. /**
  1394. * Copy a portion of the source texture to the current rendering target, with
  1395. * rotation and flipping, at subpixel precision.
  1396. *
  1397. * \param renderer The renderer which should copy parts of a texture.
  1398. * \param texture The source texture.
  1399. * \param srcrect A pointer to the source rectangle, or NULL for the entire
  1400. * texture.
  1401. * \param dstrect A pointer to the destination rectangle, or NULL for the
  1402. * entire rendering target.
  1403. * \param angle An angle in degrees that indicates the rotation that will be
  1404. * applied to dstrect, rotating it in a clockwise direction
  1405. * \param center A pointer to a point indicating the point around which
  1406. * dstrect will be rotated (if NULL, rotation will be done
  1407. * around dstrect.w/2, dstrect.h/2).
  1408. * \param flip An SDL_RendererFlip value stating which flipping actions should
  1409. * be performed on the texture
  1410. * \returns 0 on success or a negative error code on failure; call
  1411. * SDL_GetError() for more information.
  1412. *
  1413. * \since This function is available since SDL 3.0.0.
  1414. */
  1415. extern DECLSPEC int SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer, SDL_Texture *texture,
  1416. const SDL_FRect *srcrect, const SDL_FRect *dstrect,
  1417. const double angle, const SDL_FPoint *center,
  1418. const SDL_RendererFlip flip);
  1419. /**
  1420. * Render a list of triangles, optionally using a texture and indices into the
  1421. * vertex array Color and alpha modulation is done per vertex
  1422. * (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
  1423. *
  1424. * \param renderer The rendering context.
  1425. * \param texture (optional) The SDL texture to use.
  1426. * \param vertices Vertices.
  1427. * \param num_vertices Number of vertices.
  1428. * \param indices (optional) An array of integer indices into the 'vertices'
  1429. * array, if NULL all vertices will be rendered in sequential
  1430. * order.
  1431. * \param num_indices Number of indices.
  1432. * \returns 0 on success, or -1 if the operation is not supported
  1433. *
  1434. * \since This function is available since SDL 3.0.0.
  1435. *
  1436. * \sa SDL_RenderGeometryRaw
  1437. * \sa SDL_Vertex
  1438. */
  1439. extern DECLSPEC int SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer,
  1440. SDL_Texture *texture,
  1441. const SDL_Vertex *vertices, int num_vertices,
  1442. const int *indices, int num_indices);
  1443. /**
  1444. * Render a list of triangles, optionally using a texture and indices into the
  1445. * vertex arrays Color and alpha modulation is done per vertex
  1446. * (SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
  1447. *
  1448. * \param renderer The rendering context.
  1449. * \param texture (optional) The SDL texture to use.
  1450. * \param xy Vertex positions
  1451. * \param xy_stride Byte size to move from one element to the next element
  1452. * \param color Vertex colors (as SDL_Color)
  1453. * \param color_stride Byte size to move from one element to the next element
  1454. * \param uv Vertex normalized texture coordinates
  1455. * \param uv_stride Byte size to move from one element to the next element
  1456. * \param num_vertices Number of vertices.
  1457. * \param indices (optional) An array of indices into the 'vertices' arrays,
  1458. * if NULL all vertices will be rendered in sequential order.
  1459. * \param num_indices Number of indices.
  1460. * \param size_indices Index size: 1 (byte), 2 (short), 4 (int)
  1461. * \returns 0 on success or a negative error code on failure; call
  1462. * SDL_GetError() for more information.
  1463. *
  1464. * \since This function is available since SDL 3.0.0.
  1465. *
  1466. * \sa SDL_RenderGeometry
  1467. * \sa SDL_Vertex
  1468. */
  1469. extern DECLSPEC int SDLCALL SDL_RenderGeometryRaw(SDL_Renderer *renderer,
  1470. SDL_Texture *texture,
  1471. const float *xy, int xy_stride,
  1472. const SDL_Color *color, int color_stride,
  1473. const float *uv, int uv_stride,
  1474. int num_vertices,
  1475. const void *indices, int num_indices, int size_indices);
  1476. /**
  1477. * Read pixels from the current rendering target to an array of pixels.
  1478. *
  1479. * **WARNING**: This is a very slow operation, and should not be used
  1480. * frequently. If you're using this on the main rendering target, it should be
  1481. * called after rendering and before SDL_RenderPresent().
  1482. *
  1483. * `pitch` specifies the number of bytes between rows in the destination
  1484. * `pixels` data. This allows you to write to a subrectangle or have padded
  1485. * rows in the destination. Generally, `pitch` should equal the number of
  1486. * pixels per row in the `pixels` data times the number of bytes per pixel,
  1487. * but it might contain additional padding (for example, 24bit RGB Windows
  1488. * Bitmap data pads all rows to multiples of 4 bytes).
  1489. *
  1490. * \param renderer the rendering context
  1491. * \param rect an SDL_Rect structure representing the area in pixels relative
  1492. * to the to current viewport, or NULL for the entire viewport
  1493. * \param format an SDL_PixelFormatEnum value of the desired format of the
  1494. * pixel data, or 0 to use the format of the rendering target
  1495. * \param pixels a pointer to the pixel data to copy into
  1496. * \param pitch the pitch of the `pixels` parameter
  1497. * \returns 0 on success or a negative error code on failure; call
  1498. * SDL_GetError() for more information.
  1499. *
  1500. * \since This function is available since SDL 3.0.0.
  1501. */
  1502. extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer,
  1503. const SDL_Rect *rect,
  1504. Uint32 format,
  1505. void *pixels, int pitch);
  1506. /**
  1507. * Update the screen with any rendering performed since the previous call.
  1508. *
  1509. * SDL's rendering functions operate on a backbuffer; that is, calling a
  1510. * rendering function such as SDL_RenderLine() does not directly put a line on
  1511. * the screen, but rather updates the backbuffer. As such, you compose your
  1512. * entire scene and *present* the composed backbuffer to the screen as a
  1513. * complete picture.
  1514. *
  1515. * Therefore, when using SDL's rendering API, one does all drawing intended
  1516. * for the frame, and then calls this function once per frame to present the
  1517. * final drawing to the user.
  1518. *
  1519. * The backbuffer should be considered invalidated after each present; do not
  1520. * assume that previous contents will exist between frames. You are strongly
  1521. * encouraged to call SDL_RenderClear() to initialize the backbuffer before
  1522. * starting each new frame's drawing, even if you plan to overwrite every
  1523. * pixel.
  1524. *
  1525. * \param renderer the rendering context
  1526. * \returns 0 on success or a negative error code on failure; call
  1527. * SDL_GetError() for more information.
  1528. *
  1529. * \threadsafety You may only call this function on the main thread.
  1530. *
  1531. * \since This function is available since SDL 3.0.0.
  1532. *
  1533. * \sa SDL_RenderClear
  1534. * \sa SDL_RenderLine
  1535. * \sa SDL_RenderLines
  1536. * \sa SDL_RenderPoint
  1537. * \sa SDL_RenderPoints
  1538. * \sa SDL_RenderRect
  1539. * \sa SDL_RenderRects
  1540. * \sa SDL_RenderFillRect
  1541. * \sa SDL_RenderFillRects
  1542. * \sa SDL_SetRenderDrawBlendMode
  1543. * \sa SDL_SetRenderDrawColor
  1544. */
  1545. extern DECLSPEC int SDLCALL SDL_RenderPresent(SDL_Renderer *renderer);
  1546. /**
  1547. * Destroy the specified texture.
  1548. *
  1549. * Passing NULL or an otherwise invalid texture will set the SDL error message
  1550. * to "Invalid texture".
  1551. *
  1552. * \param texture the texture to destroy
  1553. *
  1554. * \since This function is available since SDL 3.0.0.
  1555. *
  1556. * \sa SDL_CreateTexture
  1557. * \sa SDL_CreateTextureFromSurface
  1558. */
  1559. extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture);
  1560. /**
  1561. * Destroy the rendering context for a window and free associated textures.
  1562. *
  1563. * If `renderer` is NULL, this function will return immediately after setting
  1564. * the SDL error message to "Invalid renderer". See SDL_GetError().
  1565. *
  1566. * \param renderer the rendering context
  1567. *
  1568. * \since This function is available since SDL 3.0.0.
  1569. *
  1570. * \sa SDL_CreateRenderer
  1571. */
  1572. extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer);
  1573. /**
  1574. * Force the rendering context to flush any pending commands and state.
  1575. *
  1576. * You do not need to (and in fact, shouldn't) call this function unless you
  1577. * are planning to call into OpenGL/Direct3D/Metal/whatever directly, in
  1578. * addition to using an SDL_Renderer.
  1579. *
  1580. * This is for a very-specific case: if you are using SDL's render API, and
  1581. * you plan to make OpenGL/D3D/whatever calls in addition to SDL render API
  1582. * calls. If this applies, you should call this function between calls to
  1583. * SDL's render API and the low-level API you're using in cooperation.
  1584. *
  1585. * In all other cases, you can ignore this function.
  1586. *
  1587. * This call makes SDL flush any pending rendering work it was queueing up to
  1588. * do later in a single batch, and marks any internal cached state as invalid,
  1589. * so it'll prepare all its state again later, from scratch.
  1590. *
  1591. * This means you do not need to save state in your rendering code to protect
  1592. * the SDL renderer. However, there lots of arbitrary pieces of Direct3D and
  1593. * OpenGL state that can confuse things; you should use your best judgement
  1594. * and be prepared to make changes if specific state needs to be protected.
  1595. *
  1596. * \param renderer the rendering context
  1597. * \returns 0 on success or a negative error code on failure; call
  1598. * SDL_GetError() for more information.
  1599. *
  1600. * \since This function is available since SDL 3.0.0.
  1601. */
  1602. extern DECLSPEC int SDLCALL SDL_FlushRenderer(SDL_Renderer *renderer);
  1603. /**
  1604. * Get the CAMetalLayer associated with the given Metal renderer.
  1605. *
  1606. * This function returns `void *`, so SDL doesn't have to include Metal's
  1607. * headers, but it can be safely cast to a `CAMetalLayer *`.
  1608. *
  1609. * \param renderer The renderer to query
  1610. * \returns a `CAMetalLayer *` on success, or NULL if the renderer isn't a
  1611. * Metal renderer
  1612. *
  1613. * \since This function is available since SDL 3.0.0.
  1614. *
  1615. * \sa SDL_GetRenderMetalCommandEncoder
  1616. */
  1617. extern DECLSPEC void *SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *renderer);
  1618. /**
  1619. * Get the Metal command encoder for the current frame
  1620. *
  1621. * This function returns `void *`, so SDL doesn't have to include Metal's
  1622. * headers, but it can be safely cast to an `id<MTLRenderCommandEncoder>`.
  1623. *
  1624. * Note that as of SDL 2.0.18, this will return NULL if Metal refuses to give
  1625. * SDL a drawable to render to, which might happen if the window is
  1626. * hidden/minimized/offscreen. This doesn't apply to command encoders for
  1627. * render targets, just the window's backbuffer. Check your return values!
  1628. *
  1629. * \param renderer The renderer to query
  1630. * \returns an `id<MTLRenderCommandEncoder>` on success, or NULL if the
  1631. * renderer isn't a Metal renderer or there was an error.
  1632. *
  1633. * \since This function is available since SDL 3.0.0.
  1634. *
  1635. * \sa SDL_GetRenderMetalLayer
  1636. */
  1637. extern DECLSPEC void *SDLCALL SDL_GetRenderMetalCommandEncoder(SDL_Renderer *renderer);
  1638. /**
  1639. * Toggle VSync of the given renderer.
  1640. *
  1641. * \param renderer The renderer to toggle
  1642. * \param vsync 1 for on, 0 for off. All other values are reserved
  1643. * \returns 0 on success or a negative error code on failure; call
  1644. * SDL_GetError() for more information.
  1645. *
  1646. * \since This function is available since SDL 3.0.0.
  1647. */
  1648. extern DECLSPEC int SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync);
  1649. /**
  1650. * Get VSync of the given renderer.
  1651. *
  1652. * \param renderer The renderer to toggle
  1653. * \param vsync an int filled with 1 for on, 0 for off. All other values are
  1654. * reserved
  1655. * \returns 0 on success or a negative error code on failure; call
  1656. * SDL_GetError() for more information.
  1657. *
  1658. * \since This function is available since SDL 3.0.0.
  1659. */
  1660. extern DECLSPEC int SDLCALL SDL_GetRenderVSync(SDL_Renderer *renderer, int *vsync);
  1661. /* Ends C function definitions when using C++ */
  1662. #ifdef __cplusplus
  1663. }
  1664. #endif
  1665. #include <SDL3/SDL_close_code.h>
  1666. #endif /* SDL_render_h_ */