sdl-ios-xcode: include/SDL_render.h annotate

annotate include/SDL_render.h @ 5160:657543cc92f9

Making the API simpler, removed the writepixels interface

author	Sam Lantinga <slouken@libsdl.org>
date	Thu, 03 Feb 2011 00:22:18 -0800
parents	307ccc9c135e
children	b3ccd1947786

rev	line source
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 /*
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2 SDL - Simple DirectMedia Layer
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 Copyright (C) 1997-2010 Sam Lantinga
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 This library is free software; you can redistribute it and/or
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 License as published by the Free Software Foundation; either
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 Lesser General Public License for more details.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16 License along with this library; if not, write to the Free Software
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	18
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19 Sam Lantinga
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 slouken@libsdl.org
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 * \file SDL_render.h
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	26 * Header file for SDL 2D rendering functions.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	27 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	28
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	29 #ifndef _SDL_render_h
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	30 #define _SDL_render_h
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	31
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	32 #include "SDL_stdinc.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	33 //#include "SDL_pixels.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	34 #include "SDL_rect.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	35 #include "SDL_video.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 #include "begin_code.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39 #ifdef __cplusplus
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	40 /* INDENT-OFF */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41 extern "C" {
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 /* INDENT-ON */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43 #endif
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46 * \brief Flags used when creating a rendering context
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	48 typedef enum
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	49 {
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	50 SDL_RENDERER_ACCELERATED = 0x00000001, /**< The renderer uses hardware
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	51 acceleration */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	52 SDL_RENDERER_PRESENTVSYNC = 0x00000002 /**< Present is synchronized
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	53 with the refresh rate */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	54 } SDL_RendererFlags;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	55
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	56 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	57 * \brief Information on the capabilities of a render driver or context.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	59 typedef struct SDL_RendererInfo
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	60 {
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	61 const char name; /< The name of the renderer /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 Uint32 flags; /*< Supported ::SDL_RendererFlags /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63 Uint32 num_texture_formats; /*< The number of available texture formats /
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	64 Uint32 texture_formats[16]; /*< The available texture formats /
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65 int max_texture_width; /*< The maximimum texture width /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 int max_texture_height; /*< The maximimum texture height /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	67 } SDL_RendererInfo;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	69 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	70 * \brief The access pattern allowed for a texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	72 typedef enum
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 {
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	74 SDL_TEXTUREACCESS_STATIC, /*< Changes rarely, not lockable /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	75 SDL_TEXTUREACCESS_STREAMING /*< Changes frequently, lockable /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	76 } SDL_TextureAccess;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 * \brief The texture channel modulation used in SDL_RenderCopy().
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81 typedef enum
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82 {
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 SDL_TEXTUREMODULATE_NONE = 0x00000000, /*< No modulation /
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84 SDL_TEXTUREMODULATE_COLOR = 0x00000001, /*< srcC = srcC color */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85 SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /*< srcA = srcA alpha */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 } SDL_TextureModulate;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88 /**
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	89 * \brief A structure representing rendering state
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	90 */
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	91 struct SDL_Renderer;
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	92 typedef struct SDL_Renderer SDL_Renderer;
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	93
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	94 /**
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95 * \brief An efficient driver-specific representation of pixel data
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97 struct SDL_Texture;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98 typedef struct SDL_Texture SDL_Texture;
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 /* Function prototypes */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104 * \brief Get the number of 2D rendering drivers available for the current
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105 * display.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 * A render driver is a set of code that handles rendering and texture
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108 * management on a particular display. Normally there is only one, but
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 * some drivers may have several available with different capabilities.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111 * \sa SDL_GetRenderDriverInfo()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	112 * \sa SDL_CreateRenderer()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	117 * \brief Get information about a specific 2D rendering driver for the current
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	118 * display.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 * \param index The index of the driver to query information about.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 * \param info A pointer to an SDL_RendererInfo struct to be filled with
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 * information on the rendering driver.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 * \return 0 on success, -1 if the index was out of range.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 * \sa SDL_CreateRenderer()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 SDL_RendererInfo * info);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	130
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	131 /**
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	132 * \brief Create a 2D rendering context for a window.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	133 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	134 * \param window The window where rendering is displayed.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	135 * \param index The index of the rendering driver to initialize, or -1 to
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	136 * initialize the first one supporting the requested flags.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 * \param flags ::SDL_RendererFlags.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	138 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	139 * \return A valid rendering context or NULL if there was an error.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	140 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	141 * \sa SDL_GetRendererInfo()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	142 * \sa SDL_DestroyRenderer()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	143 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	144 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	145 int index, Uint32 flags);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	146
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	147 /**
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	148 * \brief Get information about a rendering context.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	149 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	150 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	151 SDL_RendererInfo * info);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	152
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	153 /**
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	154 * \brief Create a texture for a rendering context.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	155 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	156 * \param format The format of the texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157 * \param access One of the enumerated values in ::SDL_TextureAccess.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 * \param w The width of the texture in pixels.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	159 * \param h The height of the texture in pixels.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	161 * \return The created texture is returned, or 0 if no rendering context was
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	162 * active, the format was unsupported, or the width or height were out
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	163 * of range.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	164 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	165 * \sa SDL_QueryTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	166 * \sa SDL_DestroyTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	167 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	168 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer, Uint32 format,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	169 int access, int w,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	170 int h);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	171
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	172 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	173 * \brief Create a texture from an existing surface.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	174 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	175 * \param format The format of the texture, or 0 to pick an appropriate format.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	176 * \param surface The surface containing pixel data used to fill the texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	177 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	178 * \return The created texture is returned, or 0 if no rendering context was
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	179 * active, the format was unsupported, or the surface width or height
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	180 * were out of range.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	181 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	182 * \note The surface is not modified or freed by this function.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	183 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	184 * \sa SDL_QueryTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	185 * \sa SDL_DestroyTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	186 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	187 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * renderer, Uint32 format, SDL_Surface * surface);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	188
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	189 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	190 * \brief Query the attributes of a texture
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	191 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	192 * \param texture A texture to be queried.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	193 * \param format A pointer filled in with the raw format of the texture. The
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	194 * actual format may differ, but pixel transfers will use this
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	195 * format.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	196 * \param access A pointer filled in with the actual access to the texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	197 * \param w A pointer filled in with the width of the texture in pixels.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	198 * \param h A pointer filled in with the height of the texture in pixels.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	199 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	200 * \return 0 on success, or -1 if the texture is not valid.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	201 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	202 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	203 Uint32 * format, int *access,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	204 int w, int h);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	205
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	206 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	207 * \brief Set an additional color value used in render copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	208 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	209 * \param texture The texture to update.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	210 * \param r The red color value multiplied into copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	211 * \param g The green color value multiplied into copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	212 * \param b The blue color value multiplied into copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	213 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	214 * \return 0 on success, or -1 if the texture is not valid or color modulation
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	215 * is not supported.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	216 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	217 * \sa SDL_GetTextureColorMod()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	218 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	219 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	220 Uint8 r, Uint8 g, Uint8 b);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	221
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	222
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	223 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	224 * \brief Get the additional color value used in render copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	225 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	226 * \param texture The texture to query.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	227 * \param r A pointer filled in with the current red color value.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	228 * \param g A pointer filled in with the current green color value.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	229 * \param b A pointer filled in with the current blue color value.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	230 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	231 * \return 0 on success, or -1 if the texture is not valid.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	232 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	233 * \sa SDL_SetTextureColorMod()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	234 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	235 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	236 Uint8 * r, Uint8 * g,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	237 Uint8 * b);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	238
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	239 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	240 * \brief Set an additional alpha value used in render copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	241 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	242 * \param texture The texture to update.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	243 * \param alpha The alpha value multiplied into copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	244 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	245 * \return 0 on success, or -1 if the texture is not valid or alpha modulation
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	246 * is not supported.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	247 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	248 * \sa SDL_GetTextureAlphaMod()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	249 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	250 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	251 Uint8 alpha);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	252
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	253 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	254 * \brief Get the additional alpha value used in render copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	255 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	256 * \param texture The texture to query.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	257 * \param alpha A pointer filled in with the current alpha value.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	258 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	259 * \return 0 on success, or -1 if the texture is not valid.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	260 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	261 * \sa SDL_SetTextureAlphaMod()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	262 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	263 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	264 Uint8 * alpha);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	265
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	266 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	267 * \brief Set the blend mode used for texture copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	268 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	269 * \param texture The texture to update.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	270 * \param blendMode ::SDL_BlendMode to use for texture blending.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	271 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	272 * \return 0 on success, or -1 if the texture is not valid or the blend mode is
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	273 * not supported.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	274 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	275 * \note If the blend mode is not supported, the closest supported mode is
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	276 * chosen.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	277 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	278 * \sa SDL_GetTextureBlendMode()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	279 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	280 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	281 SDL_BlendMode blendMode);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	282
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	283 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	284 * \brief Get the blend mode used for texture copy operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	285 *
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	286 * \param texture The texture to query.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	287 * \param blendMode A pointer filled in with the current blend mode.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	288 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	289 * \return 0 on success, or -1 if the texture is not valid.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	290 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	291 * \sa SDL_SetTextureBlendMode()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	292 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	293 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	294 SDL_BlendMode *blendMode);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	295
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	296 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	297 * \brief Update the given texture rectangle with new pixel data.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	298 *
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	299 * \param texture The texture to update
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	300 * \param rect A pointer to the rectangle of pixels to update, or NULL to
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	301 * update the entire texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	302 * \param pixels The raw pixel data.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	303 * \param pitch The number of bytes between rows of pixel data.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	304 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	305 * \return 0 on success, or -1 if the texture is not valid.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	306 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	307 * \note This is a fairly slow function.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	308 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	309 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	310 const SDL_Rect * rect,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	311 const void *pixels, int pitch);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	312
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	313 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	314 * \brief Lock a portion of the texture for pixel access.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	315 *
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	316 * \param texture The texture to lock for access, which was created with
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	317 * ::SDL_TEXTUREACCESS_STREAMING.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	318 * \param rect A pointer to the rectangle to lock for access. If the rect
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	319 * is NULL, the entire texture will be locked.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	320 * \param pixels This is filled in with a pointer to the locked pixels,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	321 * appropriately offset by the locked area.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	322 * \param pitch This is filled in with the pitch of the locked pixels.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	323 *
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	324 * \return 0 on success, or -1 if the texture is not valid or was not created with ::SDL_TEXTUREACCESS_STREAMING.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	325 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	326 * \sa SDL_UnlockTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	327 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	328 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	329 const SDL_Rect * rect,
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	330 void *pixels, int pitch);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	331
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	332 /**
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	333 * \brief Unlock a texture, uploading the changes to video memory, if needed.
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	334 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	335 * \sa SDL_LockTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	336 */
5159 307ccc9c135e Made it possible to create a texture of any format, even if not supported by the renderer. Sam Lantinga <slouken@libsdl.org> parents: 5152 diff changeset	337 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	338
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	339 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	340 * \brief Set the color used for drawing operations (Fill and Line).
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	341 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	342 * \param r The red value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	343 * \param g The green value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	344 * \param b The blue value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	345 * \param a The alpha value used to draw on the rendering target, usually
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	346 * ::SDL_ALPHA_OPAQUE (255).
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	347 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	348 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	349 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	350 extern DECLSPEC int SDL_SetRenderDrawColor(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	351 Uint8 r, Uint8 g, Uint8 b,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	352 Uint8 a);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	353
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	354 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	355 * \brief Get the color used for drawing operations (Fill and Line).
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	356 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	357 * \param r A pointer to the red value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	358 * \param g A pointer to the green value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	359 * \param b A pointer to the blue value used to draw on the rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	360 * \param a A pointer to the alpha value used to draw on the rendering target,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	361 * usually ::SDL_ALPHA_OPAQUE (255).
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	362 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	363 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	364 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	365 extern DECLSPEC int SDL_GetRenderDrawColor(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	366 Uint8 * r, Uint8 * g, Uint8 * b,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	367 Uint8 * a);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	368
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	369 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	370 * \brief Set the blend mode used for drawing operations (Fill and Line).
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	371 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	372 * \param blendMode ::SDL_BlendMode to use for blending.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	373 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	374 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	375 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	376 * \note If the blend mode is not supported, the closest supported mode is
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	377 * chosen.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	378 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	379 * \sa SDL_GetRenderDrawBlendMode()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	380 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	381 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	382 SDL_BlendMode blendMode);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	383
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	384 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	385 * \brief Get the blend mode used for drawing operations.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	386 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	387 * \param blendMode A pointer filled in with the current blend mode.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	388 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	389 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	390 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	391 * \sa SDL_SetRenderDrawBlendMode()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	392 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	393 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	394 SDL_BlendMode *blendMode);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	395
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	396 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	397 * \brief Clear the current rendering target with the drawing color
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	398 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	399 extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	400
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	401 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	402 * \brief Draw a point on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	403 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	404 * \param x The x coordinate of the point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	405 * \param y The y coordinate of the point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	406 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	407 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	408 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	409 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	410 int x, int y);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	411
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	412 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	413 * \brief Draw multiple points on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	414 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	415 * \param points The points to draw
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	416 * \param count The number of points to draw
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	417 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	418 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	419 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	420 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	421 const SDL_Point * points,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	422 int count);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	423
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	424 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	425 * \brief Draw a line on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	426 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	427 * \param x1 The x coordinate of the start point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	428 * \param y1 The y coordinate of the start point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	429 * \param x2 The x coordinate of the end point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	430 * \param y2 The y coordinate of the end point.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	431 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	432 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	433 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	434 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	435 int x1, int y1, int x2, int y2);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	436
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	437 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	438 * \brief Draw a series of connected lines on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	439 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	440 * \param points The points along the lines
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	441 * \param count The number of points, drawing count-1 lines
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	442 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	443 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	444 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	445 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	446 const SDL_Point * points,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	447 int count);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	448
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	449 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	450 * \brief Draw a rectangle on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	451 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	452 * \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	453 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	454 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	455 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	456 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	457 const SDL_Rect * rect);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	458
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	459 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	460 * \brief Draw some number of rectangles on the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	461 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	462 * \param rects A pointer to an array of destination rectangles.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	463 * \param count The number of rectangles.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	464 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	465 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	466 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	467 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	468 const SDL_Rect ** rects,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	469 int count);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	470
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	471 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	472 * \brief Fill a rectangle on the current rendering target with the drawing color.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	473 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	474 * \param rect A pointer to the destination rectangle, or NULL for the entire
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	475 * rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	476 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	477 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	478 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	479 extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	480 const SDL_Rect * rect);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	481
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	482 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	483 * \brief Fill some number of rectangles on the current rendering target with the drawing color.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	484 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	485 * \param rects A pointer to an array of destination rectangles.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	486 * \param count The number of rectangles.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	487 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	488 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	489 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	490 extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	491 const SDL_Rect ** rect,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	492 int count);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	493
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	494 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	495 * \brief Copy a portion of the texture to the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	496 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	497 * \param texture The source texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	498 * \param srcrect A pointer to the source rectangle, or NULL for the entire
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	499 * texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	500 * \param dstrect A pointer to the destination rectangle, or NULL for the
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	501 * entire rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	502 *
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	503 * \return 0 on success, or -1 on error
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	504 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	505 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	506 SDL_Texture * texture,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	507 const SDL_Rect * srcrect,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	508 const SDL_Rect * dstrect);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	509
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	510 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	511 * \brief Read pixels from the current rendering target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	512 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	513 * \param rect A pointer to the rectangle to read, or NULL for the entire
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	514 * render target.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	515 * \param format The desired format of the pixel data, or 0 to use the format
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	516 * of the rendering target
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	517 * \param pixels A pointer to be filled in with the pixel data
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	518 * \param pitch The pitch of the pixels parameter.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	519 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	520 * \return 0 on success, or -1 if pixel reading is not supported.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	521 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	522 * \warning This is a very slow operation, and should not be used frequently.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	523 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	524 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	525 const SDL_Rect * rect,
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	526 Uint32 format,
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	527 void *pixels, int pitch);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	528
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	529 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	530 * \brief Update the screen with rendering performed.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	531 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	532 extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	533
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	534 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	535 * \brief Destroy the specified texture.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	536 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	537 * \sa SDL_CreateTexture()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	538 * \sa SDL_CreateTextureFromSurface()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	539 */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	540 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	541
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	542 /**
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	543 * \brief Destroy the rendering context for a window and free associated
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	544 * textures.
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	545 *
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	546 * \sa SDL_CreateRenderer()
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	547 */
5150 ad50b3db78bd The rendering functions take a context so it's clear what window they're drawing to. This also potentially opens to the door to multi-threaded rendering in the future. Sam Lantinga <slouken@libsdl.org> parents: 5148 diff changeset	548 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
5148 2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	549
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	550
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	551 /* Ends C function definitions when using C++ */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	552 #ifdef __cplusplus
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	553 /* INDENT-OFF */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	554 }
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	555 /* INDENT-ON */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	556 #endif
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	557 #include "close_code.h"
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	558
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	559 #endif /* _SDL_render_h */
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	560
2f44e6969a59 Split the rendering API out into a separate header file. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	561 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_render.h @ 5160:657543cc92f9