include/SDL_render.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
   4
   5   This software is provided 'as-is', without any express or implied
   6   warranty.  In no event will the authors be held liable for any damages
   7   arising from the use of this software.
   8
   9   Permission is granted to anyone to use this software for any purpose,
  10   including commercial applications, and to alter it and redistribute it
  11   freely, subject to the following restrictions:
  12
  13   1. The origin of this software must not be misrepresented; you must not
  14      claim that you wrote the original software. If you use this software
  15      in a product, an acknowledgment in the product documentation would be
  16      appreciated but is not required.
  17   2. Altered source versions must be plainly marked as such, and must not be
  18      misrepresented as being the original software.
  19   3. This notice may not be removed or altered from any source distribution.
  20 */
  21
  22 /**
  23  *  \file SDL_render.h
  24  *
  25  *  Header file for SDL 2D rendering functions.
  26  *
  27  *  This API supports the following features:
  28  *      * single pixel points
  29  *      * single pixel lines
  30  *      * filled rectangles
  31  *      * texture images
  32  *
  33  *  The primitives may be drawn in opaque, blended, or additive modes.
  34  *
  35  *  The texture images may be drawn in opaque, blended, or additive modes.
  36  *  They can have an additional color tint or alpha modulation applied to
  37  *  them, and may also be stretched with linear interpolation.
  38  *
  39  *  This API is designed to accelerate simple 2D operations. You may
  40  *  want more functionality such as polygons and particle effects and
  41  *  in that case you should use SDL's OpenGL/Direct3D support or one
  42  *  of the many good 3D engines.
  43  *
  44  *  These functions must be called from the main thread.
  45  *  See this bug for details: http://bugzilla.libsdl.org/show_bug.cgi?id=1995
  46  */
  47
  48 #ifndef SDL_render_h_
  49 #define SDL_render_h_
  50
  51 #include "SDL_stdinc.h"
  52 #include "SDL_rect.h"
  53 #include "SDL_video.h"
  54
  55 #include "begin_code.h"
  56 /* Set up for C function definitions, even when using C++ */
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61 /**
  62  *  \brief Flags used when creating a rendering context
  63  */
  64 typedef enum
  65 {
  66     SDL_RENDERER_SOFTWARE = 0x00000001,         /**< The renderer is a software fallback */
  67     SDL_RENDERER_ACCELERATED = 0x00000002,      /**< The renderer uses hardware
  68                                                      acceleration */
  69     SDL_RENDERER_PRESENTVSYNC = 0x00000004,     /**< Present is synchronized
  70                                                      with the refresh rate */
  71     SDL_RENDERER_TARGETTEXTURE = 0x00000008     /**< The renderer supports
  72                                                      rendering to texture */
  73 } SDL_RendererFlags;
  74
  75 /**
  76  *  \brief Information on the capabilities of a render driver or context.
  77  */
  78 typedef struct SDL_RendererInfo
  79 {
  80     const char *name;           /**< The name of the renderer */
  81     Uint32 flags;               /**< Supported ::SDL_RendererFlags */
  82     Uint32 num_texture_formats; /**< The number of available texture formats */
  83     Uint32 texture_formats[16]; /**< The available texture formats */
  84     int max_texture_width;      /**< The maximum texture width */
  85     int max_texture_height;     /**< The maximum texture height */
  86 } SDL_RendererInfo;
  87
  88 /**
  89  *  \brief The access pattern allowed for a texture.
  90  */
  91 typedef enum
  92 {
  93     SDL_TEXTUREACCESS_STATIC,    /**< Changes rarely, not lockable */
  94     SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
  95     SDL_TEXTUREACCESS_TARGET     /**< Texture can be used as a render target */
  96 } SDL_TextureAccess;
  97
  98 /**
  99  *  \brief The texture channel modulation used in SDL_RenderCopy().
 100  */
 101 typedef enum
 102 {
 103     SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */
 104     SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */
 105     SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */
 106 } SDL_TextureModulate;
 107
 108 /**
 109  *  \brief Flip constants for SDL_RenderCopyEx
 110  */
 111 typedef enum
 112 {
 113     SDL_FLIP_NONE = 0x00000000,     /**< Do not flip */
 114     SDL_FLIP_HORIZONTAL = 0x00000001,    /**< flip horizontally */
 115     SDL_FLIP_VERTICAL = 0x00000002     /**< flip vertically */
 116 } SDL_RendererFlip;
 117
 118 /**
 119  *  \brief A structure representing rendering state
 120  */
 121 struct SDL_Renderer;
 122 typedef struct SDL_Renderer SDL_Renderer;
 123
 124 /**
 125  *  \brief An efficient driver-specific representation of pixel data
 126  */
 127 struct SDL_Texture;
 128 typedef struct SDL_Texture SDL_Texture;
 129
 130
 131 /* Function prototypes */
 132
 133 /**
 134  *  \brief Get the number of 2D rendering drivers available for the current
 135  *         display.
 136  *
 137  *  A render driver is a set of code that handles rendering and texture
 138  *  management on a particular display.  Normally there is only one, but
 139  *  some drivers may have several available with different capabilities.
 140  *
 141  *  \sa SDL_GetRenderDriverInfo()
 142  *  \sa SDL_CreateRenderer()
 143  */
 144 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
 145
 146 /**
 147  *  \brief Get information about a specific 2D rendering driver for the current
 148  *         display.
 149  *
 150  *  \param index The index of the driver to query information about.
 151  *  \param info  A pointer to an SDL_RendererInfo struct to be filled with
 152  *               information on the rendering driver.
 153  *
 154  *  \return 0 on success, -1 if the index was out of range.
 155  *
 156  *  \sa SDL_CreateRenderer()
 157  */
 158 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
 159                                                     SDL_RendererInfo * info);
 160
 161 /**
 162  *  \brief Create a window and default renderer
 163  *
 164  *  \param width    The width of the window
 165  *  \param height   The height of the window
 166  *  \param window_flags The flags used to create the window
 167  *  \param window   A pointer filled with the window, or NULL on error
 168  *  \param renderer A pointer filled with the renderer, or NULL on error
 169  *
 170  *  \return 0 on success, or -1 on error
 171  */
 172 extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(
 173                                 int width, int height, Uint32 window_flags,
 174                                 SDL_Window **window, SDL_Renderer **renderer);
 175
 176
 177 /**
 178  *  \brief Create a 2D rendering context for a window.
 179  *
 180  *  \param window The window where rendering is displayed.
 181  *  \param index    The index of the rendering driver to initialize, or -1 to
 182  *                  initialize the first one supporting the requested flags.
 183  *  \param flags    ::SDL_RendererFlags.
 184  *
 185  *  \return A valid rendering context or NULL if there was an error.
 186  *
 187  *  \sa SDL_CreateSoftwareRenderer()
 188  *  \sa SDL_GetRendererInfo()
 189  *  \sa SDL_DestroyRenderer()
 190  */
 191 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
 192                                                int index, Uint32 flags);
 193
 194 /**
 195  *  \brief Create a 2D software rendering context for a surface.
 196  *
 197  *  \param surface The surface where rendering is done.
 198  *
 199  *  \return A valid rendering context or NULL if there was an error.
 200  *
 201  *  \sa SDL_CreateRenderer()
 202  *  \sa SDL_DestroyRenderer()
 203  */
 204 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * surface);
 205
 206 /**
 207  *  \brief Get the renderer associated with a window.
 208  */
 209 extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window);
 210
 211 /**
 212  *  \brief Get information about a rendering context.
 213  */
 214 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
 215                                                 SDL_RendererInfo * info);
 216
 217 /**
 218  *  \brief Get the output size in pixels of a rendering context.
 219  */
 220 extern DECLSPEC int SDLCALL SDL_GetRendererOutputSize(SDL_Renderer * renderer,
 221                                                       int *w, int *h);
 222
 223 /**
 224  *  \brief Create a texture for a rendering context.
 225  *
 226  *  \param renderer The renderer.
 227  *  \param format The format of the texture.
 228  *  \param access One of the enumerated values in ::SDL_TextureAccess.
 229  *  \param w      The width of the texture in pixels.
 230  *  \param h      The height of the texture in pixels.
 231  *
 232  *  \return The created texture is returned, or NULL if no rendering context was
 233  *          active,  the format was unsupported, or the width or height were out
 234  *          of range.
 235  *
 236  *  \note The contents of the texture are not defined at creation.
 237  *
 238  *  \sa SDL_QueryTexture()
 239  *  \sa SDL_UpdateTexture()
 240  *  \sa SDL_DestroyTexture()
 241  */
 242 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer,
 243                                                         Uint32 format,
 244                                                         int access, int w,
 245                                                         int h);
 246
 247 /**
 248  *  \brief Create a texture from an existing surface.
 249  *
 250  *  \param renderer The renderer.
 251  *  \param surface The surface containing pixel data used to fill the texture.
 252  *
 253  *  \return The created texture is returned, or NULL on error.
 254  *
 255  *  \note The surface is not modified or freed by this function.
 256  *
 257  *  \sa SDL_QueryTexture()
 258  *  \sa SDL_DestroyTexture()
 259  */
 260 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * renderer, SDL_Surface * surface);
 261
 262 /**
 263  *  \brief Query the attributes of a texture
 264  *
 265  *  \param texture A texture to be queried.
 266  *  \param format  A pointer filled in with the raw format of the texture.  The
 267  *                 actual format may differ, but pixel transfers will use this
 268  *                 format.
 269  *  \param access  A pointer filled in with the actual access to the texture.
 270  *  \param w       A pointer filled in with the width of the texture in pixels.
 271  *  \param h       A pointer filled in with the height of the texture in pixels.
 272  *
 273  *  \return 0 on success, or -1 if the texture is not valid.
 274  */
 275 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
 276                                              Uint32 * format, int *access,
 277                                              int *w, int *h);
 278
 279 /**
 280  *  \brief Set an additional color value used in render copy operations.
 281  *
 282  *  \param texture The texture to update.
 283  *  \param r       The red color value multiplied into copy operations.
 284  *  \param g       The green color value multiplied into copy operations.
 285  *  \param b       The blue color value multiplied into copy operations.
 286  *
 287  *  \return 0 on success, or -1 if the texture is not valid or color modulation
 288  *          is not supported.
 289  *
 290  *  \sa SDL_GetTextureColorMod()
 291  */
 292 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
 293                                                    Uint8 r, Uint8 g, Uint8 b);
 294
 295
 296 /**
 297  *  \brief Get the additional color value used in render copy operations.
 298  *
 299  *  \param texture The texture to query.
 300  *  \param r         A pointer filled in with the current red color value.
 301  *  \param g         A pointer filled in with the current green color value.
 302  *  \param b         A pointer filled in with the current blue color value.
 303  *
 304  *  \return 0 on success, or -1 if the texture is not valid.
 305  *
 306  *  \sa SDL_SetTextureColorMod()
 307  */
 308 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
 309                                                    Uint8 * r, Uint8 * g,
 310                                                    Uint8 * b);
 311
 312 /**
 313  *  \brief Set an additional alpha value used in render copy operations.
 314  *
 315  *  \param texture The texture to update.
 316  *  \param alpha     The alpha value multiplied into copy operations.
 317  *
 318  *  \return 0 on success, or -1 if the texture is not valid or alpha modulation
 319  *          is not supported.
 320  *
 321  *  \sa SDL_GetTextureAlphaMod()
 322  */
 323 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
 324                                                    Uint8 alpha);
 325
 326 /**
 327  *  \brief Get the additional alpha value used in render copy operations.
 328  *
 329  *  \param texture The texture to query.
 330  *  \param alpha     A pointer filled in with the current alpha value.
 331  *
 332  *  \return 0 on success, or -1 if the texture is not valid.
 333  *
 334  *  \sa SDL_SetTextureAlphaMod()
 335  */
 336 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
 337                                                    Uint8 * alpha);
 338
 339 /**
 340  *  \brief Set the blend mode used for texture copy operations.
 341  *
 342  *  \param texture The texture to update.
 343  *  \param blendMode ::SDL_BlendMode to use for texture blending.
 344  *
 345  *  \return 0 on success, or -1 if the texture is not valid or the blend mode is
 346  *          not supported.
 347  *
 348  *  \note If the blend mode is not supported, the closest supported mode is
 349  *        chosen.
 350  *
 351  *  \sa SDL_GetTextureBlendMode()
 352  */
 353 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
 354                                                     SDL_BlendMode blendMode);
 355
 356 /**
 357  *  \brief Get the blend mode used for texture copy operations.
 358  *
 359  *  \param texture   The texture to query.
 360  *  \param blendMode A pointer filled in with the current blend mode.
 361  *
 362  *  \return 0 on success, or -1 if the texture is not valid.
 363  *
 364  *  \sa SDL_SetTextureBlendMode()
 365  */
 366 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
 367                                                     SDL_BlendMode *blendMode);
 368
 369 /**
 370  *  \brief Update the given texture rectangle with new pixel data.
 371  *
 372  *  \param texture   The texture to update
 373  *  \param rect      A pointer to the rectangle of pixels to update, or NULL to
 374  *                   update the entire texture.
 375  *  \param pixels    The raw pixel data in the format of the texture.
 376  *  \param pitch     The number of bytes in a row of pixel data, including padding between lines.
 377  *
 378  *  The pixel data must be in the format of the texture. The pixel format can be
 379  *  queried with SDL_QueryTexture.
 380  *
 381  *  \return 0 on success, or -1 if the texture is not valid.
 382  *
 383  *  \note This is a fairly slow function.
 384  */
 385 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
 386                                               const SDL_Rect * rect,
 387                                               const void *pixels, int pitch);
 388
 389 /**
 390  *  \brief Update a rectangle within a planar YV12 or IYUV texture with new pixel data.
 391  *
 392  *  \param texture   The texture to update
 393  *  \param rect      A pointer to the rectangle of pixels to update, or NULL to
 394  *                   update the entire texture.
 395  *  \param Yplane    The raw pixel data for the Y plane.
 396  *  \param Ypitch    The number of bytes between rows of pixel data for the Y plane.
 397  *  \param Uplane    The raw pixel data for the U plane.
 398  *  \param Upitch    The number of bytes between rows of pixel data for the U plane.
 399  *  \param Vplane    The raw pixel data for the V plane.
 400  *  \param Vpitch    The number of bytes between rows of pixel data for the V plane.
 401  *
 402  *  \return 0 on success, or -1 if the texture is not valid.
 403  *
 404  *  \note You can use SDL_UpdateTexture() as long as your pixel data is
 405  *        a contiguous block of Y and U/V planes in the proper order, but
 406  *        this function is available if your pixel data is not contiguous.
 407  */
 408 extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture * texture,
 409                                                  const SDL_Rect * rect,
 410                                                  const Uint8 *Yplane, int Ypitch,
 411                                                  const Uint8 *Uplane, int Upitch,
 412                                                  const Uint8 *Vplane, int Vpitch);
 413
 414 /**
 415  *  \brief Lock a portion of the texture for write-only pixel access.
 416  *
 417  *  \param texture   The texture to lock for access, which was created with
 418  *                   ::SDL_TEXTUREACCESS_STREAMING.
 419  *  \param rect      A pointer to the rectangle to lock for access. If the rect
 420  *                   is NULL, the entire texture will be locked.
 421  *  \param pixels    This is filled in with a pointer to the locked pixels,
 422  *                   appropriately offset by the locked area.
 423  *  \param pitch     This is filled in with the pitch of the locked pixels.
 424  *
 425  *  \return 0 on success, or -1 if the texture is not valid or was not created with ::SDL_TEXTUREACCESS_STREAMING.
 426  *
 427  *  \sa SDL_UnlockTexture()
 428  */
 429 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
 430                                             const SDL_Rect * rect,
 431                                             void **pixels, int *pitch);
 432
 433 /**
 434  *  \brief Unlock a texture, uploading the changes to video memory, if needed.
 435  *
 436  *  \sa SDL_LockTexture()
 437  */
 438 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
 439
 440 /**
 441  * \brief Determines whether a window supports the use of render targets
 442  *
 443  * \param renderer The renderer that will be checked
 444  *
 445  * \return SDL_TRUE if supported, SDL_FALSE if not.
 446  */
 447 extern DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *renderer);
 448
 449 /**
 450  * \brief Set a texture as the current rendering target.
 451  *
 452  * \param renderer The renderer.
 453  * \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
 454  *
 455  * \return 0 on success, or -1 on error
 456  *
 457  *  \sa SDL_GetRenderTarget()
 458  */
 459 extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer,
 460                                                 SDL_Texture *texture);
 461
 462 /**
 463  * \brief Get the current render target or NULL for the default render target.
 464  *
 465  * \return The current render target
 466  *
 467  *  \sa SDL_SetRenderTarget()
 468  */
 469 extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
 470
 471 /**
 472  *  \brief Set device independent resolution for rendering
 473  *
 474  *  \param renderer The renderer for which resolution should be set.
 475  *  \param w      The width of the logical resolution
 476  *  \param h      The height of the logical resolution
 477  *
 478  *  This function uses the viewport and scaling functionality to allow a fixed logical
 479  *  resolution for rendering, regardless of the actual output resolution.  If the actual
 480  *  output resolution doesn't have the same aspect ratio the output rendering will be
 481  *  centered within the output display.
 482  *
 483  *  If the output display is a window, mouse events in the window will be filtered
 484  *  and scaled so they seem to arrive within the logical resolution.
 485  *
 486  *  \note If this function results in scaling or subpixel drawing by the
 487  *        rendering backend, it will be handled using the appropriate
 488  *        quality hints.
 489  *
 490  *  \sa SDL_RenderGetLogicalSize()
 491  *  \sa SDL_RenderSetScale()
 492  *  \sa SDL_RenderSetViewport()
 493  */
 494 extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, int w, int h);
 495
 496 /**
 497  *  \brief Get device independent resolution for rendering
 498  *
 499  *  \param renderer The renderer from which resolution should be queried.
 500  *  \param w      A pointer filled with the width of the logical resolution
 501  *  \param h      A pointer filled with the height of the logical resolution
 502  *
 503  *  \sa SDL_RenderSetLogicalSize()
 504  */
 505 extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, int *w, int *h);
 506
 507 /**
 508  *  \brief Set whether to force integer scales for resolution-independent rendering
 509  *
 510  *  \param renderer The renderer for which integer scaling should be set.
 511  *  \param enable   Enable or disable integer scaling
 512  *
 513  *  This function restricts the logical viewport to integer values - that is, when
 514  *  a resolution is between two multiples of a logical size, the viewport size is
 515  *  rounded down to the lower multiple.
 516  *
 517  *  \sa SDL_RenderSetLogicalSize()
 518  */
 519 extern DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer * renderer,
 520                                                       SDL_bool enable);
 521
 522 /**
 523  *  \brief Get whether integer scales are forced for resolution-independent rendering
 524  *
 525  *  \param renderer The renderer from which integer scaling should be queried.
 526  *
 527  *  \sa SDL_RenderSetIntegerScale()
 528  */
 529 extern DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer * renderer);
 530
 531 /**
 532  *  \brief Set whether to force integer scales for resolution-independent rendering
 533  *
 534  *  \param renderer The renderer for which integer scaling should be set.
 535  *  \param enable   Enable or disable integer scaling
 536  *
 537  *  This function restricts the logical viewport to integer values - that is, when
 538  *  a resolution is between two multiples of a logical size, the viewport size is
 539  *  rounded down to the lower multiple.
 540  *
 541  *  \sa SDL_RenderSetLogicalSize()
 542  */
 543 extern DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer * renderer,
 544                                                       SDL_bool enable);
 545
 546 /**
 547  *  \brief Get whether integer scales are forced for resolution-independent rendering
 548  *
 549  *  \param renderer The renderer from which integer scaling should be queried.
 550  *
 551  *  \sa SDL_RenderSetIntegerScale()
 552  */
 553 extern DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer * renderer);
 554
 555 /**
 556  *  \brief Set the drawing area for rendering on the current target.
 557  *
 558  *  \param renderer The renderer for which the drawing area should be set.
 559  *  \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
 560  *
 561  *  The x,y of the viewport rect represents the origin for rendering.
 562  *
 563  *  \return 0 on success, or -1 on error
 564  *
 565  *  \note If the window associated with the renderer is resized, the viewport is automatically reset.
 566  *
 567  *  \sa SDL_RenderGetViewport()
 568  *  \sa SDL_RenderSetLogicalSize()
 569  */
 570 extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer,
 571                                                   const SDL_Rect * rect);
 572
 573 /**
 574  *  \brief Get the drawing area for the current target.
 575  *
 576  *  \sa SDL_RenderSetViewport()
 577  */
 578 extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer,
 579                                                    SDL_Rect * rect);
 580
 581 /**
 582  *  \brief Set the clip rectangle for the current target.
 583  *
 584  *  \param renderer The renderer for which clip rectangle should be set.
 585  *  \param rect   A pointer to the rectangle to set as the clip rectangle, or
 586  *                NULL to disable clipping.
 587  *
 588  *  \return 0 on success, or -1 on error
 589  *
 590  *  \sa SDL_RenderGetClipRect()
 591  */
 592 extern DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer * renderer,
 593                                                   const SDL_Rect * rect);
 594
 595 /**
 596  *  \brief Get the clip rectangle for the current target.
 597  *
 598  *  \param renderer The renderer from which clip rectangle should be queried.
 599  *  \param rect   A pointer filled in with the current clip rectangle, or
 600  *                an empty rectangle if clipping is disabled.
 601  *
 602  *  \sa SDL_RenderSetClipRect()
 603  */
 604 extern DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer * renderer,
 605                                                    SDL_Rect * rect);
 606
 607 /**
 608  *  \brief Get whether clipping is enabled on the given renderer.
 609  *
 610  *  \param renderer The renderer from which clip state should be queried.
 611  *
 612  *  \sa SDL_RenderGetClipRect()
 613  */
 614 extern DECLSPEC SDL_bool SDLCALL SDL_RenderIsClipEnabled(SDL_Renderer * renderer);
 615
 616
 617 /**
 618  *  \brief Set the drawing scale for rendering on the current target.
 619  *
 620  *  \param renderer The renderer for which the drawing scale should be set.
 621  *  \param scaleX The horizontal scaling factor
 622  *  \param scaleY The vertical scaling factor
 623  *
 624  *  The drawing coordinates are scaled by the x/y scaling factors
 625  *  before they are used by the renderer.  This allows resolution
 626  *  independent drawing with a single coordinate system.
 627  *
 628  *  \note If this results in scaling or subpixel drawing by the
 629  *        rendering backend, it will be handled using the appropriate
 630  *        quality hints.  For best results use integer scaling factors.
 631  *
 632  *  \sa SDL_RenderGetScale()
 633  *  \sa SDL_RenderSetLogicalSize()
 634  */
 635 extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer,
 636                                                float scaleX, float scaleY);
 637
 638 /**
 639  *  \brief Get the drawing scale for the current target.
 640  *
 641  *  \param renderer The renderer from which drawing scale should be queried.
 642  *  \param scaleX A pointer filled in with the horizontal scaling factor
 643  *  \param scaleY A pointer filled in with the vertical scaling factor
 644  *
 645  *  \sa SDL_RenderSetScale()
 646  */
 647 extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer,
 648                                                float *scaleX, float *scaleY);
 649
 650 /**
 651  *  \brief Set the color used for drawing operations (Rect, Line and Clear).
 652  *
 653  *  \param renderer The renderer for which drawing color should be set.
 654  *  \param r The red value used to draw on the rendering target.
 655  *  \param g The green value used to draw on the rendering target.
 656  *  \param b The blue value used to draw on the rendering target.
 657  *  \param a The alpha value used to draw on the rendering target, usually
 658  *           ::SDL_ALPHA_OPAQUE (255).
 659  *
 660  *  \return 0 on success, or -1 on error
 661  */
 662 extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer * renderer,
 663                                            Uint8 r, Uint8 g, Uint8 b,
 664                                            Uint8 a);
 665
 666 /**
 667  *  \brief Get the color used for drawing operations (Rect, Line and Clear).
 668  *
 669  *  \param renderer The renderer from which drawing color should be queried.
 670  *  \param r A pointer to the red value used to draw on the rendering target.
 671  *  \param g A pointer to the green value used to draw on the rendering target.
 672  *  \param b A pointer to the blue value used to draw on the rendering target.
 673  *  \param a A pointer to the alpha value used to draw on the rendering target,
 674  *           usually ::SDL_ALPHA_OPAQUE (255).
 675  *
 676  *  \return 0 on success, or -1 on error
 677  */
 678 extern DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer * renderer,
 679                                            Uint8 * r, Uint8 * g, Uint8 * b,
 680                                            Uint8 * a);
 681
 682 /**
 683  *  \brief Set the blend mode used for drawing operations (Fill and Line).
 684  *
 685  *  \param renderer The renderer for which blend mode should be set.
 686  *  \param blendMode ::SDL_BlendMode to use for blending.
 687  *
 688  *  \return 0 on success, or -1 on error
 689  *
 690  *  \note If the blend mode is not supported, the closest supported mode is
 691  *        chosen.
 692  *
 693  *  \sa SDL_GetRenderDrawBlendMode()
 694  */
 695 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
 696                                                        SDL_BlendMode blendMode);
 697
 698 /**
 699  *  \brief Get the blend mode used for drawing operations.
 700  *
 701  *  \param renderer The renderer from which blend mode should be queried.
 702  *  \param blendMode A pointer filled in with the current blend mode.
 703  *
 704  *  \return 0 on success, or -1 on error
 705  *
 706  *  \sa SDL_SetRenderDrawBlendMode()
 707  */
 708 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
 709                                                        SDL_BlendMode *blendMode);
 710
 711 /**
 712  *  \brief Clear the current rendering target with the drawing color
 713  *
 714  *  This function clears the entire rendering target, ignoring the viewport and
 715  *  the clip rectangle.
 716  *
 717  *  \return 0 on success, or -1 on error
 718  */
 719 extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
 720
 721 /**
 722  *  \brief Draw a point on the current rendering target.
 723  *
 724  *  \param renderer The renderer which should draw a point.
 725  *  \param x The x coordinate of the point.
 726  *  \param y The y coordinate of the point.
 727  *
 728  *  \return 0 on success, or -1 on error
 729  */
 730 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
 731                                                 int x, int y);
 732
 733 /**
 734  *  \brief Draw multiple points on the current rendering target.
 735  *
 736  *  \param renderer The renderer which should draw multiple points.
 737  *  \param points The points to draw
 738  *  \param count The number of points to draw
 739  *
 740  *  \return 0 on success, or -1 on error
 741  */
 742 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
 743                                                  const SDL_Point * points,
 744                                                  int count);
 745
 746 /**
 747  *  \brief Draw a line on the current rendering target.
 748  *
 749  *  \param renderer The renderer which should draw a line.
 750  *  \param x1 The x coordinate of the start point.
 751  *  \param y1 The y coordinate of the start point.
 752  *  \param x2 The x coordinate of the end point.
 753  *  \param y2 The y coordinate of the end point.
 754  *
 755  *  \return 0 on success, or -1 on error
 756  */
 757 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
 758                                                int x1, int y1, int x2, int y2);
 759
 760 /**
 761  *  \brief Draw a series of connected lines on the current rendering target.
 762  *
 763  *  \param renderer The renderer which should draw multiple lines.
 764  *  \param points The points along the lines
 765  *  \param count The number of points, drawing count-1 lines
 766  *
 767  *  \return 0 on success, or -1 on error
 768  */
 769 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
 770                                                 const SDL_Point * points,
 771                                                 int count);
 772
 773 /**
 774  *  \brief Draw a rectangle on the current rendering target.
 775  *
 776  *  \param renderer The renderer which should draw a rectangle.
 777  *  \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
 778  *
 779  *  \return 0 on success, or -1 on error
 780  */
 781 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
 782                                                const SDL_Rect * rect);
 783
 784 /**
 785  *  \brief Draw some number of rectangles on the current rendering target.
 786  *
 787  *  \param renderer The renderer which should draw multiple rectangles.
 788  *  \param rects A pointer to an array of destination rectangles.
 789  *  \param count The number of rectangles.
 790  *
 791  *  \return 0 on success, or -1 on error
 792  */
 793 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
 794                                                 const SDL_Rect * rects,
 795                                                 int count);
 796
 797 /**
 798  *  \brief Fill a rectangle on the current rendering target with the drawing color.
 799  *
 800  *  \param renderer The renderer which should fill a rectangle.
 801  *  \param rect A pointer to the destination rectangle, or NULL for the entire
 802  *              rendering target.
 803  *
 804  *  \return 0 on success, or -1 on error
 805  */
 806 extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
 807                                                const SDL_Rect * rect);
 808
 809 /**
 810  *  \brief Fill some number of rectangles on the current rendering target with the drawing color.
 811  *
 812  *  \param renderer The renderer which should fill multiple rectangles.
 813  *  \param rects A pointer to an array of destination rectangles.
 814  *  \param count The number of rectangles.
 815  *
 816  *  \return 0 on success, or -1 on error
 817  */
 818 extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
 819                                                 const SDL_Rect * rects,
 820                                                 int count);
 821
 822 /**
 823  *  \brief Copy a portion of the texture to the current rendering target.
 824  *
 825  *  \param renderer The renderer which should copy parts of a texture.
 826  *  \param texture The source texture.
 827  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
 828  *                   texture.
 829  *  \param dstrect   A pointer to the destination rectangle, or NULL for the
 830  *                   entire rendering target.
 831  *
 832  *  \return 0 on success, or -1 on error
 833  */
 834 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
 835                                            SDL_Texture * texture,
 836                                            const SDL_Rect * srcrect,
 837                                            const SDL_Rect * dstrect);
 838
 839 /**
 840  *  \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center
 841  *
 842  *  \param renderer The renderer which should copy parts of a texture.
 843  *  \param texture The source texture.
 844  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
 845  *                   texture.
 846  *  \param dstrect   A pointer to the destination rectangle, or NULL for the
 847  *                   entire rendering target.
 848  *  \param angle    An angle in degrees that indicates the rotation that will be applied to dstrect, rotating it in a clockwise direction
 849  *  \param center   A pointer to a point indicating the point around which dstrect will be rotated (if NULL, rotation will be done around dstrect.w/2, dstrect.h/2).
 850  *  \param flip     An SDL_RendererFlip value stating which flipping actions should be performed on the texture
 851  *
 852  *  \return 0 on success, or -1 on error
 853  */
 854 extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer,
 855                                            SDL_Texture * texture,
 856                                            const SDL_Rect * srcrect,
 857                                            const SDL_Rect * dstrect,
 858                                            const double angle,
 859                                            const SDL_Point *center,
 860                                            const SDL_RendererFlip flip);
 861
 862 /**
 863  *  \brief Read pixels from the current rendering target.
 864  *
 865  *  \param renderer The renderer from which pixels should be read.
 866  *  \param rect   A pointer to the rectangle to read, or NULL for the entire
 867  *                render target.
 868  *  \param format The desired format of the pixel data, or 0 to use the format
 869  *                of the rendering target
 870  *  \param pixels A pointer to be filled in with the pixel data
 871  *  \param pitch  The pitch of the pixels parameter.
 872  *
 873  *  \return 0 on success, or -1 if pixel reading is not supported.
 874  *
 875  *  \warning This is a very slow operation, and should not be used frequently.
 876  */
 877 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
 878                                                  const SDL_Rect * rect,
 879                                                  Uint32 format,
 880                                                  void *pixels, int pitch);
 881
 882 /**
 883  *  \brief Update the screen with rendering performed.
 884  */
 885 extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
 886
 887 /**
 888  *  \brief Destroy the specified texture.
 889  *
 890  *  \sa SDL_CreateTexture()
 891  *  \sa SDL_CreateTextureFromSurface()
 892  */
 893 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
 894
 895 /**
 896  *  \brief Destroy the rendering context for a window and free associated
 897  *         textures.
 898  *
 899  *  \sa SDL_CreateRenderer()
 900  */
 901 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
 902
 903
 904 /**
 905  *  \brief Bind the texture to the current OpenGL/ES/ES2 context for use with
 906  *         OpenGL instructions.
 907  *
 908  *  \param texture  The SDL texture to bind
 909  *  \param texw     A pointer to a float that will be filled with the texture width
 910  *  \param texh     A pointer to a float that will be filled with the texture height
 911  *
 912  *  \return 0 on success, or -1 if the operation is not supported
 913  */
 914 extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh);
 915
 916 /**
 917  *  \brief Unbind a texture from the current OpenGL/ES/ES2 context.
 918  *
 919  *  \param texture  The SDL texture to unbind
 920  *
 921  *  \return 0 on success, or -1 if the operation is not supported
 922  */
 923 extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture);
 924
 925 /**
 926  *  \brief Get the CAMetalLayer associated with the given Metal renderer
 927  *
 928  *  \param renderer The renderer to query
 929  *
 930  *  \return CAMetalLayer* on success, or NULL if the renderer isn't a Metal renderer
 931  *
 932  *  \sa SDL_RenderGetMetalCommandEncoder()
 933  */
 934 extern DECLSPEC void *SDLCALL SDL_RenderGetMetalLayer(SDL_Renderer * renderer);
 935
 936 /**
 937  *  \brief Get the Metal command encoder for the current frame
 938  *
 939  *  \param renderer The renderer to query
 940  *
 941  *  \return id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer
 942  *
 943  *  \sa SDL_RenderGetMetalLayer()
 944  */
 945 extern DECLSPEC void *SDLCALL SDL_RenderGetMetalCommandEncoder(SDL_Renderer * renderer);
 946
 947 /* Ends C function definitions when using C++ */
 948 #ifdef __cplusplus
 949 }
 950 #endif
 951 #include "close_code.h"
 952
 953 #endif /* SDL_render_h_ */
 954
 955 /* vi: set ts=4 sw=4 expandtab: */