include/SDL_render.h
author Ryan C. Gordon <icculus@icculus.org>
Wed, 21 Nov 2012 23:00:06 -0500
changeset 6680 9d3df1f5c542
parent 6578 77d70ec131bc
child 6826 7fd31621ce9c
permissions -rw-r--r--
Removed some tab chars.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 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 /* *INDENT-OFF* */
    56 extern "C" {
    57 /* *INDENT-ON* */
    58 #endif
    59 
    60 /**
    61  *  \brief Flags used when creating a rendering context
    62  */
    63 typedef enum
    64 {
    65     SDL_RENDERER_SOFTWARE = 0x00000001,         /**< The renderer is a software fallback */ 
    66     SDL_RENDERER_ACCELERATED = 0x00000002,      /**< The renderer uses hardware 
    67                                                      acceleration */
    68     SDL_RENDERER_PRESENTVSYNC = 0x00000004,     /**< Present is synchronized 
    69                                                      with the refresh rate */
    70     SDL_RENDERER_TARGETTEXTURE = 0x00000008     /**< The renderer supports
    71                                                      rendering to texture */
    72 } SDL_RendererFlags;
    73 
    74 /**
    75  *  \brief Information on the capabilities of a render driver or context.
    76  */
    77 typedef struct SDL_RendererInfo
    78 {
    79     const char *name;           /**< The name of the renderer */
    80     Uint32 flags;               /**< Supported ::SDL_RendererFlags */
    81     Uint32 num_texture_formats; /**< The number of available texture formats */
    82     Uint32 texture_formats[16]; /**< The available texture formats */
    83     int max_texture_width;      /**< The maximimum texture width */
    84     int max_texture_height;     /**< The maximimum texture height */
    85 } SDL_RendererInfo;
    86 
    87 /**
    88  *  \brief 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 /**
    98  *  \brief The texture channel modulation used in SDL_RenderCopy().
    99  */
   100 typedef enum
   101 {
   102     SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */
   103     SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */
   104     SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */
   105 } SDL_TextureModulate;
   106 
   107 /**
   108  *  \brief Flip constants for SDL_RenderCopyEx
   109  */
   110 typedef enum
   111 {
   112     SDL_FLIP_NONE = 0x00000000,     /**< Do not flip */
   113     SDL_FLIP_HORIZONTAL = 0x00000001,    /**< flip horizontally */
   114     SDL_FLIP_VERTICAL = 0x00000002     /**< flip vertically */
   115 } SDL_RendererFlip;
   116 
   117 /**
   118  *  \brief A structure representing rendering state
   119  */
   120 struct SDL_Renderer;
   121 typedef struct SDL_Renderer SDL_Renderer;
   122 
   123 /**
   124  *  \brief An efficient driver-specific representation of pixel data
   125  */
   126 struct SDL_Texture;
   127 typedef struct SDL_Texture SDL_Texture;
   128 
   129 
   130 /* Function prototypes */
   131 
   132 /**
   133  *  \brief Get the number of 2D rendering drivers available for the current 
   134  *         display.
   135  *  
   136  *  A render driver is a set of code that handles rendering and texture
   137  *  management on a particular display.  Normally there is only one, but
   138  *  some drivers may have several available with different capabilities.
   139  *  
   140  *  \sa SDL_GetRenderDriverInfo()
   141  *  \sa SDL_CreateRenderer()
   142  */
   143 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
   144 
   145 /**
   146  *  \brief Get information about a specific 2D rendering driver for the current 
   147  *         display.
   148  *  
   149  *  \param index The index of the driver to query information about.
   150  *  \param info  A pointer to an SDL_RendererInfo struct to be filled with 
   151  *               information on the rendering driver.
   152  *  
   153  *  \return 0 on success, -1 if the index was out of range.
   154  *  
   155  *  \sa SDL_CreateRenderer()
   156  */
   157 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
   158                                                     SDL_RendererInfo * info);
   159 
   160 /**
   161  *  \brief Create a window and default renderer
   162  *
   163  *  \param width    The width of the window
   164  *  \param height   The height of the window
   165  *  \param window_flags The flags used to create the window
   166  *  \param window   A pointer filled with the window, or NULL on error
   167  *  \param renderer A pointer filled with the renderer, or NULL on error
   168  *
   169  *  \return 0 on success, or -1 on error
   170  */
   171 extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(
   172                                 int width, int height, Uint32 window_flags,
   173                                 SDL_Window **window, SDL_Renderer **renderer);
   174 
   175 
   176 /**
   177  *  \brief Create a 2D rendering context for a window.
   178  *  
   179  *  \param window The window where rendering is displayed.
   180  *  \param index    The index of the rendering driver to initialize, or -1 to 
   181  *                  initialize the first one supporting the requested flags.
   182  *  \param flags    ::SDL_RendererFlags.
   183  *  
   184  *  \return A valid rendering context or NULL if there was an error.
   185  *  
   186  *  \sa SDL_CreateSoftwareRenderer()
   187  *  \sa SDL_GetRendererInfo()
   188  *  \sa SDL_DestroyRenderer()
   189  */
   190 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
   191                                                int index, Uint32 flags);
   192 
   193 /**
   194  *  \brief Create a 2D software rendering context for a surface.
   195  *  
   196  *  \param surface The surface where rendering is done.
   197  *  
   198  *  \return A valid rendering context or NULL if there was an error.
   199  *  
   200  *  \sa SDL_CreateRenderer()
   201  *  \sa SDL_DestroyRenderer()
   202  */
   203 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * surface);
   204 
   205 /**
   206  *  \brief Get the renderer associated with a window.
   207  */
   208 extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window);
   209 
   210 /**
   211  *  \brief Get information about a rendering context.
   212  */
   213 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
   214                                                 SDL_RendererInfo * info);
   215 
   216 /**
   217  *  \brief Create a texture for a rendering context.
   218  *  
   219  *  \param format The format of the texture.
   220  *  \param access One of the enumerated values in ::SDL_TextureAccess.
   221  *  \param w      The width of the texture in pixels.
   222  *  \param h      The height of the texture in pixels.
   223  *  
   224  *  \return The created texture is returned, or 0 if no rendering context was 
   225  *          active,  the format was unsupported, or the width or height were out
   226  *          of range.
   227  *  
   228  *  \sa SDL_QueryTexture()
   229  *  \sa SDL_UpdateTexture()
   230  *  \sa SDL_DestroyTexture()
   231  */
   232 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer,
   233                                                         Uint32 format,
   234                                                         int access, int w,
   235                                                         int h);
   236 
   237 /**
   238  *  \brief Create a texture from an existing surface.
   239  *  
   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 texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
   414  *
   415  * \return 0 on success, or -1 on error
   416  *
   417  *  \sa SDL_GetRenderTarget()
   418  */
   419 extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer,
   420                                                 SDL_Texture *texture);
   421 
   422 /**
   423  * \brief Get the current render target or NULL for the default render target.
   424  *
   425  * \return The current render target
   426  *
   427  *  \sa SDL_SetRenderTarget()
   428  */
   429 extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
   430 
   431 /**
   432  *  \brief Set device independent resolution for rendering
   433  *
   434  *  \param w      The width of the logical resolution
   435  *  \param h      The height of the logical resolution
   436  *
   437  *  This function uses the viewport and scaling functionality to allow a fixed logical
   438  *  resolution for rendering, regardless of the actual output resolution.  If the actual
   439  *  output resolution doesn't have the same aspect ratio the output rendering will be
   440  *  centered within the output display.
   441  *
   442  *  If the output display is a window, mouse events in the window will be filtered
   443  *  and scaled so they seem to arrive within the logical resolution.
   444  *
   445  *  \note If this function results in scaling or subpixel drawing by the 
   446  *        rendering backend, it will be handled using the appropriate
   447  *        quality hints.
   448  *
   449  *  \sa SDL_RenderGetLogicalSize()
   450  *  \sa SDL_RenderSetScale()
   451  *  \sa SDL_RenderSetViewport()
   452  */
   453 extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, int w, int h);
   454 
   455 /**
   456  *  \brief Get device independent resolution for rendering
   457  *
   458  *  \param w      A pointer filled with the width of the logical resolution
   459  *  \param h      A pointer filled with the height of the logical resolution
   460  *
   461  *  \sa SDL_RenderSetLogicalSize()
   462  */
   463 extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, int *w, int *y);
   464 
   465 /**
   466  *  \brief Set the drawing area for rendering on the current target.
   467  *
   468  *  \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
   469  *
   470  *  The x,y of the viewport rect represents the origin for rendering.
   471  *
   472  *  \note When the window is resized, the current viewport is automatically
   473  *        centered within the new window size.
   474  *
   475  *  \sa SDL_RenderGetViewport()
   476  *  \sa SDL_RenderSetLogicalSize()
   477  */
   478 extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer,
   479                                                   const SDL_Rect * rect);
   480 
   481 /**
   482  *  \brief Get the drawing area for the current target.
   483  *
   484  *  \sa SDL_RenderSetViewport()
   485  */
   486 extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer,
   487                                                    SDL_Rect * rect);
   488 
   489 /**
   490  *  \brief Set the drawing scale for rendering on the current target.
   491  *
   492  *  \param scaleX The horizontal scaling factor
   493  *  \param scaleY The vertical scaling factor
   494  *
   495  *  The drawing coordinates are scaled by the x/y scaling factors
   496  *  before they are used by the renderer.  This allows resolution
   497  *  independent drawing with a single coordinate system.
   498  *
   499  *  \note If this results in scaling or subpixel drawing by the 
   500  *        rendering backend, it will be handled using the appropriate
   501  *        quality hints.  For best results use integer scaling factors.
   502  *
   503  *  \sa SDL_RenderGetScale()
   504  *  \sa SDL_RenderSetLogicalSize()
   505  */
   506 extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer,
   507                                                float scaleX, float scaleY);
   508 
   509 /**
   510  *  \brief Get the drawing scale for the current target.
   511  *
   512  *  \param scaleX A pointer filled in with the horizontal scaling factor
   513  *  \param scaleY A pointer filled in with the vertical scaling factor
   514  *
   515  *  \sa SDL_RenderSetScale()
   516  */
   517 extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer,
   518                                                float *scaleX, float *scaleY);
   519 
   520 /**
   521  *  \brief Set the color used for drawing operations (Rect, Line and Clear).
   522  *  
   523  *  \param r The red value used to draw on the rendering target.
   524  *  \param g The green value used to draw on the rendering target.
   525  *  \param b The blue value used to draw on the rendering target.
   526  *  \param a The alpha value used to draw on the rendering target, usually 
   527  *           ::SDL_ALPHA_OPAQUE (255).
   528  *  
   529  *  \return 0 on success, or -1 on error
   530  */
   531 extern DECLSPEC int SDL_SetRenderDrawColor(SDL_Renderer * renderer,
   532                                            Uint8 r, Uint8 g, Uint8 b,
   533                                            Uint8 a);
   534 
   535 /**
   536  *  \brief Get the color used for drawing operations (Rect, Line and Clear).
   537  *  
   538  *  \param r A pointer to the red value used to draw on the rendering target.
   539  *  \param g A pointer to the green value used to draw on the rendering target.
   540  *  \param b A pointer to the blue value used to draw on the rendering target.
   541  *  \param a A pointer to the alpha value used to draw on the rendering target, 
   542  *           usually ::SDL_ALPHA_OPAQUE (255).
   543  *  
   544  *  \return 0 on success, or -1 on error
   545  */
   546 extern DECLSPEC int SDL_GetRenderDrawColor(SDL_Renderer * renderer,
   547                                            Uint8 * r, Uint8 * g, Uint8 * b,
   548                                            Uint8 * a);
   549 
   550 /**
   551  *  \brief Set the blend mode used for drawing operations (Fill and Line).
   552  *  
   553  *  \param blendMode ::SDL_BlendMode to use for blending.
   554  *  
   555  *  \return 0 on success, or -1 on error
   556  *  
   557  *  \note If the blend mode is not supported, the closest supported mode is 
   558  *        chosen.
   559  *  
   560  *  \sa SDL_GetRenderDrawBlendMode()
   561  */
   562 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
   563                                                        SDL_BlendMode blendMode);
   564 
   565 /**
   566  *  \brief Get the blend mode used for drawing operations.
   567  *  
   568  *  \param blendMode A pointer filled in with the current blend mode.
   569  *  
   570  *  \return 0 on success, or -1 on error
   571  *  
   572  *  \sa SDL_SetRenderDrawBlendMode()
   573  */
   574 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
   575                                                        SDL_BlendMode *blendMode);
   576 
   577 /**
   578  *  \brief Clear the current rendering target with the drawing color
   579  *
   580  *  This function clears the entire rendering target, ignoring the viewport.
   581  */
   582 extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
   583 
   584 /**
   585  *  \brief Draw a point on the current rendering target.
   586  *  
   587  *  \param x The x coordinate of the point.
   588  *  \param y The y coordinate of the point.
   589  *  
   590  *  \return 0 on success, or -1 on error
   591  */
   592 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
   593                                                 int x, int y);
   594 
   595 /**
   596  *  \brief Draw multiple points on the current rendering target.
   597  *  
   598  *  \param points The points to draw
   599  *  \param count The number of points to draw
   600  *  
   601  *  \return 0 on success, or -1 on error
   602  */
   603 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
   604                                                  const SDL_Point * points,
   605                                                  int count);
   606 
   607 /**
   608  *  \brief Draw a line on the current rendering target.
   609  *  
   610  *  \param x1 The x coordinate of the start point.
   611  *  \param y1 The y coordinate of the start point.
   612  *  \param x2 The x coordinate of the end point.
   613  *  \param y2 The y coordinate of the end point.
   614  *  
   615  *  \return 0 on success, or -1 on error
   616  */
   617 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
   618                                                int x1, int y1, int x2, int y2);
   619 
   620 /**
   621  *  \brief Draw a series of connected lines on the current rendering target.
   622  *  
   623  *  \param points The points along the lines
   624  *  \param count The number of points, drawing count-1 lines
   625  *  
   626  *  \return 0 on success, or -1 on error
   627  */
   628 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
   629                                                 const SDL_Point * points,
   630                                                 int count);
   631 
   632 /**
   633  *  \brief Draw a rectangle on the current rendering target.
   634  *  
   635  *  \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
   636  *  
   637  *  \return 0 on success, or -1 on error
   638  */
   639 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
   640                                                const SDL_Rect * rect);
   641 
   642 /**
   643  *  \brief Draw some number of rectangles on the current rendering target.
   644  *  
   645  *  \param rects A pointer to an array of destination rectangles.
   646  *  \param count The number of rectangles.
   647  *  
   648  *  \return 0 on success, or -1 on error
   649  */
   650 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
   651                                                 const SDL_Rect * rects,
   652                                                 int count);
   653 
   654 /**
   655  *  \brief Fill a rectangle on the current rendering target with the drawing color.
   656  *  
   657  *  \param rect A pointer to the destination rectangle, or NULL for the entire 
   658  *              rendering target.
   659  *  
   660  *  \return 0 on success, or -1 on error
   661  */
   662 extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
   663                                                const SDL_Rect * rect);
   664 
   665 /**
   666  *  \brief Fill some number of rectangles on the current rendering target with the drawing color.
   667  *  
   668  *  \param rects A pointer to an array of destination rectangles.
   669  *  \param count The number of rectangles.
   670  *  
   671  *  \return 0 on success, or -1 on error
   672  */
   673 extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
   674                                                 const SDL_Rect * rects,
   675                                                 int count);
   676 
   677 /**
   678  *  \brief Copy a portion of the texture to the current rendering target.
   679  *  
   680  *  \param texture The source texture.
   681  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire 
   682  *                   texture.
   683  *  \param dstrect   A pointer to the destination rectangle, or NULL for the 
   684  *                   entire rendering target.
   685  *  
   686  *  \return 0 on success, or -1 on error
   687  */
   688 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
   689                                            SDL_Texture * texture,
   690                                            const SDL_Rect * srcrect,
   691                                            const SDL_Rect * dstrect);
   692 
   693 /**
   694  *  \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center 
   695  *
   696  *  \param texture The source texture.
   697  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
   698  *                   texture.
   699  *  \param dstrect   A pointer to the destination rectangle, or NULL for the
   700  *                   entire rendering target.
   701  *  \param angle    An angle in degrees that indicates the rotation that will be applied to dstrect
   702  *  \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)
   703  *  \param flip     A SFL_Flip value stating which flipping actions should be performed on the texture
   704  * 
   705  *  \return 0 on success, or -1 on error
   706  */
   707 extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer,
   708                                            SDL_Texture * texture,
   709                                            const SDL_Rect * srcrect,
   710                                            const SDL_Rect * dstrect,
   711                                            const double angle,
   712                                            const SDL_Point *center,
   713                                            const SDL_RendererFlip flip);
   714 
   715 /**
   716  *  \brief Read pixels from the current rendering target.
   717  *  
   718  *  \param rect   A pointer to the rectangle to read, or NULL for the entire 
   719  *                render target.
   720  *  \param format The desired format of the pixel data, or 0 to use the format
   721  *                of the rendering target
   722  *  \param pixels A pointer to be filled in with the pixel data
   723  *  \param pitch  The pitch of the pixels parameter.
   724  *  
   725  *  \return 0 on success, or -1 if pixel reading is not supported.
   726  *  
   727  *  \warning This is a very slow operation, and should not be used frequently.
   728  */
   729 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
   730                                                  const SDL_Rect * rect,
   731                                                  Uint32 format,
   732                                                  void *pixels, int pitch);
   733 
   734 /**
   735  *  \brief Update the screen with rendering performed.
   736  */
   737 extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
   738 
   739 /**
   740  *  \brief Destroy the specified texture.
   741  *  
   742  *  \sa SDL_CreateTexture()
   743  *  \sa SDL_CreateTextureFromSurface()
   744  */
   745 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
   746 
   747 /**
   748  *  \brief Destroy the rendering context for a window and free associated
   749  *         textures.
   750  *  
   751  *  \sa SDL_CreateRenderer()
   752  */
   753 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
   754 
   755 
   756 /**
   757  *  \brief Bind the texture to the current OpenGL/ES/ES2 context for use with
   758  *         OpenGL instructions.
   759  *
   760  *  \param texture  The SDL texture to bind
   761  *  \param texw     A pointer to a float that will be filled with the texture width
   762  *  \param texh     A pointer to a float that will be filled with the texture height
   763  *
   764  *  \return 0 on success, or -1 if the operation is not supported
   765  */
   766 extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh);
   767 
   768 /**
   769  *  \brief Unbind a texture from the current OpenGL/ES/ES2 context.
   770  *
   771  *  \param texture  The SDL texture to unbind
   772  *
   773  *  \return 0 on success, or -1 if the operation is not supported
   774  */
   775 extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture);
   776 
   777 
   778 /* Ends C function definitions when using C++ */
   779 #ifdef __cplusplus
   780 /* *INDENT-OFF* */
   781 }
   782 /* *INDENT-ON* */
   783 #endif
   784 #include "close_code.h"
   785 
   786 #endif /* _SDL_render_h */
   787 
   788 /* vi: set ts=4 sw=4 expandtab: */