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