include/SDL_render.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 14:17:52 -0700
changeset 7191 75360622e65f
parent 7188 20bd120bf7e4
child 7239 04dda95ba22c
permissions -rw-r--r--
File style cleanup for the SDL 2.0 release
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 rotation 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 
    45 #ifndef _SDL_render_h
    46 #define _SDL_render_h
    47 
    48 #include "SDL_stdinc.h"
    49 #include "SDL_rect.h"
    50 #include "SDL_video.h"
    51 
    52 #include "begin_code.h"
    53 /* Set up for C function definitions, even when using C++ */
    54 #ifdef __cplusplus
    55 extern "C" {
    56 #endif
    57 
    58 /**
    59  *  \brief Flags used when creating a rendering context
    60  */
    61 typedef enum
    62 {
    63     SDL_RENDERER_SOFTWARE = 0x00000001,         /**< The renderer is a software fallback */
    64     SDL_RENDERER_ACCELERATED = 0x00000002,      /**< The renderer uses hardware
    65                                                      acceleration */
    66     SDL_RENDERER_PRESENTVSYNC = 0x00000004,     /**< Present is synchronized
    67                                                      with the refresh rate */
    68     SDL_RENDERER_TARGETTEXTURE = 0x00000008     /**< The renderer supports
    69                                                      rendering to texture */
    70 } SDL_RendererFlags;
    71 
    72 /**
    73  *  \brief Information on the capabilities of a render driver or context.
    74  */
    75 typedef struct SDL_RendererInfo
    76 {
    77     const char *name;           /**< The name of the renderer */
    78     Uint32 flags;               /**< Supported ::SDL_RendererFlags */
    79     Uint32 num_texture_formats; /**< The number of available texture formats */
    80     Uint32 texture_formats[16]; /**< The available texture formats */
    81     int max_texture_width;      /**< The maximimum texture width */
    82     int max_texture_height;     /**< The maximimum texture height */
    83 } SDL_RendererInfo;
    84 
    85 /**
    86  *  \brief The access pattern allowed for a texture.
    87  */
    88 typedef enum
    89 {
    90     SDL_TEXTUREACCESS_STATIC,    /**< Changes rarely, not lockable */
    91     SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
    92     SDL_TEXTUREACCESS_TARGET     /**< Texture can be used as a render target */
    93 } SDL_TextureAccess;
    94 
    95 /**
    96  *  \brief The texture channel modulation used in SDL_RenderCopy().
    97  */
    98 typedef enum
    99 {
   100     SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */
   101     SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */
   102     SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */
   103 } SDL_TextureModulate;
   104 
   105 /**
   106  *  \brief Flip constants for SDL_RenderCopyEx
   107  */
   108 typedef enum
   109 {
   110     SDL_FLIP_NONE = 0x00000000,     /**< Do not flip */
   111     SDL_FLIP_HORIZONTAL = 0x00000001,    /**< flip horizontally */
   112     SDL_FLIP_VERTICAL = 0x00000002     /**< flip vertically */
   113 } SDL_RendererFlip;
   114 
   115 /**
   116  *  \brief A structure representing rendering state
   117  */
   118 struct SDL_Renderer;
   119 typedef struct SDL_Renderer SDL_Renderer;
   120 
   121 /**
   122  *  \brief An efficient driver-specific representation of pixel data
   123  */
   124 struct SDL_Texture;
   125 typedef struct SDL_Texture SDL_Texture;
   126 
   127 
   128 /* Function prototypes */
   129 
   130 /**
   131  *  \brief Get the number of 2D rendering drivers available for the current
   132  *         display.
   133  *
   134  *  A render driver is a set of code that handles rendering and texture
   135  *  management on a particular display.  Normally there is only one, but
   136  *  some drivers may have several available with different capabilities.
   137  *
   138  *  \sa SDL_GetRenderDriverInfo()
   139  *  \sa SDL_CreateRenderer()
   140  */
   141 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
   142 
   143 /**
   144  *  \brief Get information about a specific 2D rendering driver for the current
   145  *         display.
   146  *
   147  *  \param index The index of the driver to query information about.
   148  *  \param info  A pointer to an SDL_RendererInfo struct to be filled with
   149  *               information on the rendering driver.
   150  *
   151  *  \return 0 on success, -1 if the index was out of range.
   152  *
   153  *  \sa SDL_CreateRenderer()
   154  */
   155 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
   156                                                     SDL_RendererInfo * info);
   157 
   158 /**
   159  *  \brief Create a window and default renderer
   160  *
   161  *  \param width    The width of the window
   162  *  \param height   The height of the window
   163  *  \param window_flags The flags used to create the window
   164  *  \param window   A pointer filled with the window, or NULL on error
   165  *  \param renderer A pointer filled with the renderer, or NULL on error
   166  *
   167  *  \return 0 on success, or -1 on error
   168  */
   169 extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(
   170                                 int width, int height, Uint32 window_flags,
   171                                 SDL_Window **window, SDL_Renderer **renderer);
   172 
   173 
   174 /**
   175  *  \brief Create a 2D rendering context for a window.
   176  *
   177  *  \param window The window where rendering is displayed.
   178  *  \param index    The index of the rendering driver to initialize, or -1 to
   179  *                  initialize the first one supporting the requested flags.
   180  *  \param flags    ::SDL_RendererFlags.
   181  *
   182  *  \return A valid rendering context or NULL if there was an error.
   183  *
   184  *  \sa SDL_CreateSoftwareRenderer()
   185  *  \sa SDL_GetRendererInfo()
   186  *  \sa SDL_DestroyRenderer()
   187  */
   188 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
   189                                                int index, Uint32 flags);
   190 
   191 /**
   192  *  \brief Create a 2D software rendering context for a surface.
   193  *
   194  *  \param surface The surface where rendering is done.
   195  *
   196  *  \return A valid rendering context or NULL if there was an error.
   197  *
   198  *  \sa SDL_CreateRenderer()
   199  *  \sa SDL_DestroyRenderer()
   200  */
   201 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * surface);
   202 
   203 /**
   204  *  \brief Get the renderer associated with a window.
   205  */
   206 extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window);
   207 
   208 /**
   209  *  \brief Get information about a rendering context.
   210  */
   211 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
   212                                                 SDL_RendererInfo * info);
   213 
   214 /**
   215  *  \brief Create a texture for a rendering context.
   216  *
   217  *  \param renderer The renderer.
   218  *  \param format The format of the texture.
   219  *  \param access One of the enumerated values in ::SDL_TextureAccess.
   220  *  \param w      The width of the texture in pixels.
   221  *  \param h      The height of the texture in pixels.
   222  *
   223  *  \return The created texture is returned, or 0 if no rendering context was
   224  *          active,  the format was unsupported, or the width or height were out
   225  *          of range.
   226  *
   227  *  \sa SDL_QueryTexture()
   228  *  \sa SDL_UpdateTexture()
   229  *  \sa SDL_DestroyTexture()
   230  */
   231 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer,
   232                                                         Uint32 format,
   233                                                         int access, int w,
   234                                                         int h);
   235 
   236 /**
   237  *  \brief Create a texture from an existing surface.
   238  *
   239  *  \param renderer The renderer.
   240  *  \param surface The surface containing pixel data used to fill the texture.
   241  *
   242  *  \return The created texture is returned, or 0 on error.
   243  *
   244  *  \note The surface is not modified or freed by this function.
   245  *
   246  *  \sa SDL_QueryTexture()
   247  *  \sa SDL_DestroyTexture()
   248  */
   249 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * renderer, SDL_Surface * surface);
   250 
   251 /**
   252  *  \brief Query the attributes of a texture
   253  *
   254  *  \param texture A texture to be queried.
   255  *  \param format  A pointer filled in with the raw format of the texture.  The
   256  *                 actual format may differ, but pixel transfers will use this
   257  *                 format.
   258  *  \param access  A pointer filled in with the actual access to the texture.
   259  *  \param w       A pointer filled in with the width of the texture in pixels.
   260  *  \param h       A pointer filled in with the height of the texture in pixels.
   261  *
   262  *  \return 0 on success, or -1 if the texture is not valid.
   263  */
   264 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
   265                                              Uint32 * format, int *access,
   266                                              int *w, int *h);
   267 
   268 /**
   269  *  \brief Set an additional color value used in render copy operations.
   270  *
   271  *  \param texture The texture to update.
   272  *  \param r       The red color value multiplied into copy operations.
   273  *  \param g       The green color value multiplied into copy operations.
   274  *  \param b       The blue color value multiplied into copy operations.
   275  *
   276  *  \return 0 on success, or -1 if the texture is not valid or color modulation
   277  *          is not supported.
   278  *
   279  *  \sa SDL_GetTextureColorMod()
   280  */
   281 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
   282                                                    Uint8 r, Uint8 g, Uint8 b);
   283 
   284 
   285 /**
   286  *  \brief Get the additional color value used in render copy operations.
   287  *
   288  *  \param texture The texture to query.
   289  *  \param r         A pointer filled in with the current red color value.
   290  *  \param g         A pointer filled in with the current green color value.
   291  *  \param b         A pointer filled in with the current blue color value.
   292  *
   293  *  \return 0 on success, or -1 if the texture is not valid.
   294  *
   295  *  \sa SDL_SetTextureColorMod()
   296  */
   297 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
   298                                                    Uint8 * r, Uint8 * g,
   299                                                    Uint8 * b);
   300 
   301 /**
   302  *  \brief Set an additional alpha value used in render copy operations.
   303  *
   304  *  \param texture The texture to update.
   305  *  \param alpha     The alpha value multiplied into copy operations.
   306  *
   307  *  \return 0 on success, or -1 if the texture is not valid or alpha modulation
   308  *          is not supported.
   309  *
   310  *  \sa SDL_GetTextureAlphaMod()
   311  */
   312 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
   313                                                    Uint8 alpha);
   314 
   315 /**
   316  *  \brief Get the additional alpha value used in render copy operations.
   317  *
   318  *  \param texture The texture to query.
   319  *  \param alpha     A pointer filled in with the current alpha value.
   320  *
   321  *  \return 0 on success, or -1 if the texture is not valid.
   322  *
   323  *  \sa SDL_SetTextureAlphaMod()
   324  */
   325 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
   326                                                    Uint8 * alpha);
   327 
   328 /**
   329  *  \brief Set the blend mode used for texture copy operations.
   330  *
   331  *  \param texture The texture to update.
   332  *  \param blendMode ::SDL_BlendMode to use for texture blending.
   333  *
   334  *  \return 0 on success, or -1 if the texture is not valid or the blend mode is
   335  *          not supported.
   336  *
   337  *  \note If the blend mode is not supported, the closest supported mode is
   338  *        chosen.
   339  *
   340  *  \sa SDL_GetTextureBlendMode()
   341  */
   342 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
   343                                                     SDL_BlendMode blendMode);
   344 
   345 /**
   346  *  \brief Get the blend mode used for texture copy operations.
   347  *
   348  *  \param texture   The texture to query.
   349  *  \param blendMode A pointer filled in with the current blend mode.
   350  *
   351  *  \return 0 on success, or -1 if the texture is not valid.
   352  *
   353  *  \sa SDL_SetTextureBlendMode()
   354  */
   355 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
   356                                                     SDL_BlendMode *blendMode);
   357 
   358 /**
   359  *  \brief Update the given texture rectangle with new pixel data.
   360  *
   361  *  \param texture   The texture to update
   362  *  \param rect      A pointer to the rectangle of pixels to update, or NULL to
   363  *                   update the entire texture.
   364  *  \param pixels    The raw pixel data.
   365  *  \param pitch     The number of bytes between rows of pixel data.
   366  *
   367  *  \return 0 on success, or -1 if the texture is not valid.
   368  *
   369  *  \note This is a fairly slow function.
   370  */
   371 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
   372                                               const SDL_Rect * rect,
   373                                               const void *pixels, int pitch);
   374 
   375 /**
   376  *  \brief Lock a portion of the texture for write-only pixel access.
   377  *
   378  *  \param texture   The texture to lock for access, which was created with
   379  *                   ::SDL_TEXTUREACCESS_STREAMING.
   380  *  \param rect      A pointer to the rectangle to lock for access. If the rect
   381  *                   is NULL, the entire texture will be locked.
   382  *  \param pixels    This is filled in with a pointer to the locked pixels,
   383  *                   appropriately offset by the locked area.
   384  *  \param pitch     This is filled in with the pitch of the locked pixels.
   385  *
   386  *  \return 0 on success, or -1 if the texture is not valid or was not created with ::SDL_TEXTUREACCESS_STREAMING.
   387  *
   388  *  \sa SDL_UnlockTexture()
   389  */
   390 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
   391                                             const SDL_Rect * rect,
   392                                             void **pixels, int *pitch);
   393 
   394 /**
   395  *  \brief Unlock a texture, uploading the changes to video memory, if needed.
   396  *
   397  *  \sa SDL_LockTexture()
   398  */
   399 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
   400 
   401 /**
   402  * \brief Determines whether a window supports the use of render targets
   403  *
   404  * \param renderer The renderer that will be checked
   405  *
   406  * \return SDL_TRUE if supported, SDL_FALSE if not.
   407  */
   408 extern DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *renderer);
   409 
   410 /**
   411  * \brief Set a texture as the current rendering target.
   412  *
   413  * \param renderer The renderer.
   414  * \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
   415  *
   416  * \return 0 on success, or -1 on error
   417  *
   418  *  \sa SDL_GetRenderTarget()
   419  */
   420 extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer,
   421                                                 SDL_Texture *texture);
   422 
   423 /**
   424  * \brief Get the current render target or NULL for the default render target.
   425  *
   426  * \return The current render target
   427  *
   428  *  \sa SDL_SetRenderTarget()
   429  */
   430 extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
   431 
   432 /**
   433  *  \brief Set device independent resolution for rendering
   434  *
   435  *  \param renderer The renderer for which resolution should be set.
   436  *  \param w      The width of the logical resolution
   437  *  \param h      The height of the logical resolution
   438  *
   439  *  This function uses the viewport and scaling functionality to allow a fixed logical
   440  *  resolution for rendering, regardless of the actual output resolution.  If the actual
   441  *  output resolution doesn't have the same aspect ratio the output rendering will be
   442  *  centered within the output display.
   443  *
   444  *  If the output display is a window, mouse events in the window will be filtered
   445  *  and scaled so they seem to arrive within the logical resolution.
   446  *
   447  *  \note If this function results in scaling or subpixel drawing by the
   448  *        rendering backend, it will be handled using the appropriate
   449  *        quality hints.
   450  *
   451  *  \sa SDL_RenderGetLogicalSize()
   452  *  \sa SDL_RenderSetScale()
   453  *  \sa SDL_RenderSetViewport()
   454  */
   455 extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, int w, int h);
   456 
   457 /**
   458  *  \brief Get device independent resolution for rendering
   459  *
   460  *  \param renderer The renderer from which resolution should be queried.
   461  *  \param w      A pointer filled with the width of the logical resolution
   462  *  \param h      A pointer filled with the height of the logical resolution
   463  *
   464  *  \sa SDL_RenderSetLogicalSize()
   465  */
   466 extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, int *w, int *h);
   467 
   468 /**
   469  *  \brief Set the drawing area for rendering on the current target.
   470  *
   471  *  \param renderer The renderer for which the drawing area should be set.
   472  *  \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
   473  *
   474  *  The x,y of the viewport rect represents the origin for rendering.
   475  *
   476  *  \return 0 on success, or -1 on error
   477  *
   478  *  \note When the window is resized, the current viewport is automatically
   479  *        centered within the new window size.
   480  *
   481  *  \sa SDL_RenderGetViewport()
   482  *  \sa SDL_RenderSetLogicalSize()
   483  */
   484 extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer,
   485                                                   const SDL_Rect * rect);
   486 
   487 /**
   488  *  \brief Get the drawing area for the current target.
   489  *
   490  *  \sa SDL_RenderSetViewport()
   491  */
   492 extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer,
   493                                                    SDL_Rect * rect);
   494 
   495 /**
   496  *  \brief Set the clip rectangle for the current target.
   497  *
   498  *  \param renderer The renderer for which clip rectangle should be set.
   499  *  \param rect   A pointer to the rectangle to set as the clip rectangle, or
   500  *                NULL to disable clipping.
   501  *
   502  *  \return 0 on success, or -1 on error
   503  *
   504  *  \sa SDL_RenderGetClipRect()
   505  */
   506 extern DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer * renderer,
   507                                                   const SDL_Rect * rect);
   508 
   509 /**
   510  *  \brief Get the clip rectangle for the current target.
   511  *
   512  *  \param renderer The renderer from which clip rectangle should be queried.
   513  *  \param rect   A pointer filled in with the current clip rectangle, or
   514  *                an empty rectangle if clipping is disabled.
   515  *
   516  *  \sa SDL_RenderSetClipRect()
   517  */
   518 extern DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer * renderer,
   519                                                    SDL_Rect * rect);
   520 
   521 /**
   522  *  \brief Set the drawing scale for rendering on the current target.
   523  *
   524  *  \param renderer The renderer for which the drawing scale should be set.
   525  *  \param scaleX The horizontal scaling factor
   526  *  \param scaleY The vertical scaling factor
   527  *
   528  *  The drawing coordinates are scaled by the x/y scaling factors
   529  *  before they are used by the renderer.  This allows resolution
   530  *  independent drawing with a single coordinate system.
   531  *
   532  *  \note If this results in scaling or subpixel drawing by the
   533  *        rendering backend, it will be handled using the appropriate
   534  *        quality hints.  For best results use integer scaling factors.
   535  *
   536  *  \sa SDL_RenderGetScale()
   537  *  \sa SDL_RenderSetLogicalSize()
   538  */
   539 extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer,
   540                                                float scaleX, float scaleY);
   541 
   542 /**
   543  *  \brief Get the drawing scale for the current target.
   544  *
   545  *  \param renderer The renderer from which drawing scale should be queried.
   546  *  \param scaleX A pointer filled in with the horizontal scaling factor
   547  *  \param scaleY A pointer filled in with the vertical scaling factor
   548  *
   549  *  \sa SDL_RenderSetScale()
   550  */
   551 extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer,
   552                                                float *scaleX, float *scaleY);
   553 
   554 /**
   555  *  \brief Set the color used for drawing operations (Rect, Line and Clear).
   556  *
   557  *  \param renderer The renderer for which drawing color should be set.
   558  *  \param r The red value used to draw on the rendering target.
   559  *  \param g The green value used to draw on the rendering target.
   560  *  \param b The blue value used to draw on the rendering target.
   561  *  \param a The alpha value used to draw on the rendering target, usually
   562  *           ::SDL_ALPHA_OPAQUE (255).
   563  *
   564  *  \return 0 on success, or -1 on error
   565  */
   566 extern DECLSPEC int SDL_SetRenderDrawColor(SDL_Renderer * renderer,
   567                                            Uint8 r, Uint8 g, Uint8 b,
   568                                            Uint8 a);
   569 
   570 /**
   571  *  \brief Get the color used for drawing operations (Rect, Line and Clear).
   572  *
   573  *  \param renderer The renderer from which drawing color should be queried.
   574  *  \param r A pointer to the red value used to draw on the rendering target.
   575  *  \param g A pointer to the green value used to draw on the rendering target.
   576  *  \param b A pointer to the blue value used to draw on the rendering target.
   577  *  \param a A pointer to the alpha value used to draw on the rendering target,
   578  *           usually ::SDL_ALPHA_OPAQUE (255).
   579  *
   580  *  \return 0 on success, or -1 on error
   581  */
   582 extern DECLSPEC int SDL_GetRenderDrawColor(SDL_Renderer * renderer,
   583                                            Uint8 * r, Uint8 * g, Uint8 * b,
   584                                            Uint8 * a);
   585 
   586 /**
   587  *  \brief Set the blend mode used for drawing operations (Fill and Line).
   588  *
   589  *  \param renderer The renderer for which blend mode should be set.
   590  *  \param blendMode ::SDL_BlendMode to use for blending.
   591  *
   592  *  \return 0 on success, or -1 on error
   593  *
   594  *  \note If the blend mode is not supported, the closest supported mode is
   595  *        chosen.
   596  *
   597  *  \sa SDL_GetRenderDrawBlendMode()
   598  */
   599 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
   600                                                        SDL_BlendMode blendMode);
   601 
   602 /**
   603  *  \brief Get the blend mode used for drawing operations.
   604  *
   605  *  \param renderer The renderer from which blend mode should be queried.
   606  *  \param blendMode A pointer filled in with the current blend mode.
   607  *
   608  *  \return 0 on success, or -1 on error
   609  *
   610  *  \sa SDL_SetRenderDrawBlendMode()
   611  */
   612 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
   613                                                        SDL_BlendMode *blendMode);
   614 
   615 /**
   616  *  \brief Clear the current rendering target with the drawing color
   617  *
   618  *  This function clears the entire rendering target, ignoring the viewport.
   619  *
   620  *  \return 0 on success, or -1 on error
   621  */
   622 extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
   623 
   624 /**
   625  *  \brief Draw a point on the current rendering target.
   626  *
   627  *  \param renderer The renderer which should draw a point.
   628  *  \param x The x coordinate of the point.
   629  *  \param y The y coordinate of the point.
   630  *
   631  *  \return 0 on success, or -1 on error
   632  */
   633 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
   634                                                 int x, int y);
   635 
   636 /**
   637  *  \brief Draw multiple points on the current rendering target.
   638  *
   639  *  \param renderer The renderer which should draw multiple points.
   640  *  \param points The points to draw
   641  *  \param count The number of points to draw
   642  *
   643  *  \return 0 on success, or -1 on error
   644  */
   645 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
   646                                                  const SDL_Point * points,
   647                                                  int count);
   648 
   649 /**
   650  *  \brief Draw a line on the current rendering target.
   651  *
   652  *  \param renderer The renderer which should draw a line.
   653  *  \param x1 The x coordinate of the start point.
   654  *  \param y1 The y coordinate of the start point.
   655  *  \param x2 The x coordinate of the end point.
   656  *  \param y2 The y coordinate of the end point.
   657  *
   658  *  \return 0 on success, or -1 on error
   659  */
   660 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
   661                                                int x1, int y1, int x2, int y2);
   662 
   663 /**
   664  *  \brief Draw a series of connected lines on the current rendering target.
   665  *
   666  *  \param renderer The renderer which should draw multiple lines.
   667  *  \param points The points along the lines
   668  *  \param count The number of points, drawing count-1 lines
   669  *
   670  *  \return 0 on success, or -1 on error
   671  */
   672 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
   673                                                 const SDL_Point * points,
   674                                                 int count);
   675 
   676 /**
   677  *  \brief Draw a rectangle on the current rendering target.
   678  *
   679  *  \param renderer The renderer which should draw a rectangle.
   680  *  \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
   681  *
   682  *  \return 0 on success, or -1 on error
   683  */
   684 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
   685                                                const SDL_Rect * rect);
   686 
   687 /**
   688  *  \brief Draw some number of rectangles on the current rendering target.
   689  *
   690  *  \param renderer The renderer which should draw multiple rectangles.
   691  *  \param rects A pointer to an array of destination rectangles.
   692  *  \param count The number of rectangles.
   693  *
   694  *  \return 0 on success, or -1 on error
   695  */
   696 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
   697                                                 const SDL_Rect * rects,
   698                                                 int count);
   699 
   700 /**
   701  *  \brief Fill a rectangle on the current rendering target with the drawing color.
   702  *
   703  *  \param renderer The renderer which should fill a rectangle.
   704  *  \param rect A pointer to the destination rectangle, or NULL for the entire
   705  *              rendering target.
   706  *
   707  *  \return 0 on success, or -1 on error
   708  */
   709 extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
   710                                                const SDL_Rect * rect);
   711 
   712 /**
   713  *  \brief Fill some number of rectangles on the current rendering target with the drawing color.
   714  *
   715  *  \param renderer The renderer which should fill multiple rectangles.
   716  *  \param rects A pointer to an array of destination rectangles.
   717  *  \param count The number of rectangles.
   718  *
   719  *  \return 0 on success, or -1 on error
   720  */
   721 extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
   722                                                 const SDL_Rect * rects,
   723                                                 int count);
   724 
   725 /**
   726  *  \brief Copy a portion of the texture to the current rendering target.
   727  *
   728  *  \param renderer The renderer which should copy parts of a texture.
   729  *  \param texture The source texture.
   730  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
   731  *                   texture.
   732  *  \param dstrect   A pointer to the destination rectangle, or NULL for the
   733  *                   entire rendering target.
   734  *
   735  *  \return 0 on success, or -1 on error
   736  */
   737 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
   738                                            SDL_Texture * texture,
   739                                            const SDL_Rect * srcrect,
   740                                            const SDL_Rect * dstrect);
   741 
   742 /**
   743  *  \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center
   744  *
   745  *  \param renderer The renderer which should copy parts of a texture.
   746  *  \param texture The source texture.
   747  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
   748  *                   texture.
   749  *  \param dstrect   A pointer to the destination rectangle, or NULL for the
   750  *                   entire rendering target.
   751  *  \param angle    An angle in degrees that indicates the rotation that will be applied to dstrect
   752  *  \param center   A pointer to a point indicating the point around which dstrect will be rotated (if NULL, rotation will be done aroud dstrect.w/2, dstrect.h/2)
   753  *  \param flip     An SDL_RendererFlip value stating which flipping actions should be performed on the texture
   754  *
   755  *  \return 0 on success, or -1 on error
   756  */
   757 extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer,
   758                                            SDL_Texture * texture,
   759                                            const SDL_Rect * srcrect,
   760                                            const SDL_Rect * dstrect,
   761                                            const double angle,
   762                                            const SDL_Point *center,
   763                                            const SDL_RendererFlip flip);
   764 
   765 /**
   766  *  \brief Read pixels from the current rendering target.
   767  *
   768  *  \param renderer The renderer from which pixels should be read.
   769  *  \param rect   A pointer to the rectangle to read, or NULL for the entire
   770  *                render target.
   771  *  \param format The desired format of the pixel data, or 0 to use the format
   772  *                of the rendering target
   773  *  \param pixels A pointer to be filled in with the pixel data
   774  *  \param pitch  The pitch of the pixels parameter.
   775  *
   776  *  \return 0 on success, or -1 if pixel reading is not supported.
   777  *
   778  *  \warning This is a very slow operation, and should not be used frequently.
   779  */
   780 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
   781                                                  const SDL_Rect * rect,
   782                                                  Uint32 format,
   783                                                  void *pixels, int pitch);
   784 
   785 /**
   786  *  \brief Update the screen with rendering performed.
   787  */
   788 extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
   789 
   790 /**
   791  *  \brief Destroy the specified texture.
   792  *
   793  *  \sa SDL_CreateTexture()
   794  *  \sa SDL_CreateTextureFromSurface()
   795  */
   796 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
   797 
   798 /**
   799  *  \brief Destroy the rendering context for a window and free associated
   800  *         textures.
   801  *
   802  *  \sa SDL_CreateRenderer()
   803  */
   804 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
   805 
   806 
   807 /**
   808  *  \brief Bind the texture to the current OpenGL/ES/ES2 context for use with
   809  *         OpenGL instructions.
   810  *
   811  *  \param texture  The SDL texture to bind
   812  *  \param texw     A pointer to a float that will be filled with the texture width
   813  *  \param texh     A pointer to a float that will be filled with the texture height
   814  *
   815  *  \return 0 on success, or -1 if the operation is not supported
   816  */
   817 extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh);
   818 
   819 /**
   820  *  \brief Unbind a texture from the current OpenGL/ES/ES2 context.
   821  *
   822  *  \param texture  The SDL texture to unbind
   823  *
   824  *  \return 0 on success, or -1 if the operation is not supported
   825  */
   826 extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture);
   827 
   828 
   829 /* Ends C function definitions when using C++ */
   830 #ifdef __cplusplus
   831 }
   832 #endif
   833 #include "close_code.h"
   834 
   835 #endif /* _SDL_render_h */
   836 
   837 /* vi: set ts=4 sw=4 expandtab: */