My Project
SDL_render.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
48 #ifndef _SDL_render_h
49 #define _SDL_render_h
50 
51 #include "SDL_stdinc.h"
52 #include "SDL_rect.h"
53 #include "SDL_video.h"
54 
55 #include "begin_code.h"
56 /* Set up for C function definitions, even when using C++ */
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
64 typedef enum
65 {
66  SDL_RENDERER_SOFTWARE = 0x00000001,
67  SDL_RENDERER_ACCELERATED = 0x00000002,
74 
78 typedef struct SDL_RendererInfo
79 {
80  const char *name;
87 
91 typedef enum
92 {
97 
101 typedef enum
102 {
107 
111 typedef enum
112 {
113  SDL_FLIP_NONE = 0x00000000,
114  SDL_FLIP_HORIZONTAL = 0x00000001,
115  SDL_FLIP_VERTICAL = 0x00000002
117 
121 struct SDL_Renderer;
122 typedef struct SDL_Renderer SDL_Renderer;
123 
127 struct SDL_Texture;
128 typedef struct SDL_Texture SDL_Texture;
129 
130 
131 /* Function prototypes */
132 
144 extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
145 
158 extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
159  SDL_RendererInfo * info);
160 
172 extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(
173  int width, int height, Uint32 window_flags,
174  SDL_Window **window, SDL_Renderer **renderer);
175 
176 
191 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
192  int index, Uint32 flags);
193 
204 extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * surface);
205 
209 extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window);
210 
214 extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
215  SDL_RendererInfo * info);
216 
220 extern DECLSPEC int SDLCALL SDL_GetRendererOutputSize(SDL_Renderer * renderer,
221  int *w, int *h);
222 
240 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer,
241  Uint32 format,
242  int access, int w,
243  int h);
244 
258 extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * renderer, SDL_Surface * surface);
259 
273 extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
274  Uint32 * format, int *access,
275  int *w, int *h);
276 
290 extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
291  Uint8 r, Uint8 g, Uint8 b);
292 
293 
306 extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
307  Uint8 * r, Uint8 * g,
308  Uint8 * b);
309 
321 extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
322  Uint8 alpha);
323 
334 extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
335  Uint8 * alpha);
336 
351 extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
352  SDL_BlendMode blendMode);
353 
364 extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
365  SDL_BlendMode *blendMode);
366 
380 extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
381  const SDL_Rect * rect,
382  const void *pixels, int pitch);
383 
403 extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture * texture,
404  const SDL_Rect * rect,
405  const Uint8 *Yplane, int Ypitch,
406  const Uint8 *Uplane, int Upitch,
407  const Uint8 *Vplane, int Vpitch);
408 
424 extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
425  const SDL_Rect * rect,
426  void **pixels, int *pitch);
427 
433 extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
434 
442 extern DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *renderer);
443 
454 extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer,
455  SDL_Texture *texture);
456 
464 extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
465 
489 extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, int w, int h);
490 
500 extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, int *w, int *h);
501 
514 extern DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer * renderer,
515  SDL_bool enable);
516 
524 extern DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer * renderer);
525 
541 extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer,
542  const SDL_Rect * rect);
543 
549 extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer,
550  SDL_Rect * rect);
551 
563 extern DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer * renderer,
564  const SDL_Rect * rect);
565 
575 extern DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer * renderer,
576  SDL_Rect * rect);
577 
585 extern DECLSPEC SDL_bool SDLCALL SDL_RenderIsClipEnabled(SDL_Renderer * renderer);
586 
587 
606 extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer,
607  float scaleX, float scaleY);
608 
618 extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer,
619  float *scaleX, float *scaleY);
620 
633 extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer * renderer,
634  Uint8 r, Uint8 g, Uint8 b,
635  Uint8 a);
636 
649 extern DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer * renderer,
650  Uint8 * r, Uint8 * g, Uint8 * b,
651  Uint8 * a);
652 
666 extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
667  SDL_BlendMode blendMode);
668 
679 extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
680  SDL_BlendMode *blendMode);
681 
690 extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
691 
701 extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
702  int x, int y);
703 
713 extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
714  const SDL_Point * points,
715  int count);
716 
728 extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
729  int x1, int y1, int x2, int y2);
730 
740 extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
741  const SDL_Point * points,
742  int count);
743 
752 extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
753  const SDL_Rect * rect);
754 
764 extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
765  const SDL_Rect * rects,
766  int count);
767 
777 extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
778  const SDL_Rect * rect);
779 
789 extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
790  const SDL_Rect * rects,
791  int count);
792 
805 extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
806  SDL_Texture * texture,
807  const SDL_Rect * srcrect,
808  const SDL_Rect * dstrect);
809 
825 extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer,
826  SDL_Texture * texture,
827  const SDL_Rect * srcrect,
828  const SDL_Rect * dstrect,
829  const double angle,
830  const SDL_Point *center,
831  const SDL_RendererFlip flip);
832 
848 extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
849  const SDL_Rect * rect,
850  Uint32 format,
851  void *pixels, int pitch);
852 
856 extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
857 
864 extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
865 
872 extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
873 
874 
885 extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh);
886 
894 extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture);
895 
896 
897 /* Ends C function definitions when using C++ */
898 #ifdef __cplusplus
899 }
900 #endif
901 #include "close_code.h"
902 
903 #endif /* _SDL_render_h */
904 
905 /* vi: set ts=4 sw=4 expandtab: */
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:143
Definition: SDL_render.h:95
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:90
SDL_RendererFlip
Flip constants for SDL_RenderCopyEx.
Definition: SDL_render.h:111
DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_RendererInfo *info)
Get information about a rendering context.
DECLSPEC SDL_Renderer *SDLCALL SDL_CreateRenderer(SDL_Window *window, int index, Uint32 flags)
Create a 2D rendering context for a window.
Uint32 flags
Definition: SDL_render.h:81
DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer *renderer, float *scaleX, float *scaleY)
Get the drawing scale for the current target.
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:159
DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer *renderer, SDL_Rect *rect)
Get the clip rectangle for the current target.
DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture *texture, const SDL_Rect *rect, void **pixels, int *pitch)
Lock a portion of the texture for write-only pixel access.
DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh)
Bind the texture to the current OpenGL/ES/ES2 context for use with OpenGL instructions.
DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer *renderer, const SDL_Rect *rect)
Draw a rectangle on the current rendering target.
DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode)
Set the blend mode used for drawing operations (Fill and Line).
DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer *renderer, SDL_Rect *rect)
Get the drawing area for the current target.
Definition: SDL_render.h:113
DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
Update the given texture rectangle with new pixel data.
DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture)
Unbind a texture from the current OpenGL/ES/ES2 context.
DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture, const SDL_Rect *rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch)
Update a rectangle within a planar YV12 or IYUV texture with new pixel data.
DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer *renderer, float scaleX, float scaleY)
Set the drawing scale for rendering on the current target.
DECLSPEC SDL_Renderer *SDLCALL SDL_GetRenderer(SDL_Window *window)
Get the renderer associated with a window.
DECLSPEC int SDLCALL SDL_GetRendererOutputSize(SDL_Renderer *renderer, int *w, int *h)
Get the output size in pixels of a rendering context.
DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture)
Unlock a texture, uploading the changes to video memory, if needed.
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64
DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer *renderer, int x1, int y1, int x2, int y2)
Draw a line on the current rendering target.
DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer *renderer, const SDL_Point *points, int count)
Draw a series of connected lines on the current rendering target.
Definition: SDL_render.h:103
DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer *renderer, const SDL_Rect *rect)
Set the drawing area for rendering on the current target.
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
Definition: SDL_render.h:104
DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture)
Set a texture as the current rendering target.
struct SDL_RendererInfo SDL_RendererInfo
Information on the capabilities of a render driver or context.
DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture, Uint8 alpha)
Set an additional alpha value used in render copy operations.
DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *srcrect, const SDL_Rect *dstrect)
Copy a portion of the texture to the current rendering target.
DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer *renderer)
Get whether integer scales are forced for resolution-independent rendering.
DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer *renderer, const SDL_Point *points, int count)
Draw multiple points on the current rendering target.
DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, const SDL_Rect *rect)
Fill a rectangle on the current rendering target with the drawing color.
int max_texture_width
Definition: SDL_render.h:84
DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture, Uint8 *r, Uint8 *g, Uint8 *b)
Get the additional color value used in render copy operations.
DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode)
Set the blend mode used for texture copy operations.
DECLSPEC SDL_bool SDLCALL SDL_RenderIsClipEnabled(SDL_Renderer *renderer)
Get whether clipping is enabled on the given renderer.
DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *renderer, SDL_BlendMode *blendMode)
Get the blend mode used for drawing operations.
DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer *renderer, const SDL_Rect *rects, int count)
Draw some number of rectangles on the current rendering target.
DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer *renderer, int *w, int *h)
Get device independent resolution for rendering.
DECLSPEC SDL_Texture *SDLCALL SDL_CreateTexture(SDL_Renderer *renderer, Uint32 format, int access, int w, int h)
Create a texture for a rendering context.
Definition: SDL_render.h:67
Definition: SDL_render.h:93
DECLSPEC SDL_Texture *SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer *renderer, SDL_Surface *surface)
Create a texture from an existing surface.
DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer *renderer)
Update the screen with rendering performed.
DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer *renderer, int x, int y)
Draw a point on the current rendering target.
DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode *blendMode)
Get the blend mode used for texture copy operations.
DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *renderer)
Determines whether a window supports the use of render targets.
Definition: SDL_render.h:71
DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer *renderer)
Clear the current rendering target with the drawing color.
SDL_TextureAccess
The access pattern allowed for a texture.
Definition: SDL_render.h:91
Definition: SDL_render.h:105
The structure that defines a point.
Definition: SDL_rect.h:48
Definition: SDL_render.h:69
DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
Set the color used for drawing operations (Rect, Line and Clear).
Definition: SDL_render.h:114
Uint32 num_texture_formats
Definition: SDL_render.h:82
DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void)
Get the number of 2D rendering drivers available for the current display.
DECLSPEC SDL_Renderer *SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface *surface)
Create a 2D software rendering context for a surface.
Information on the capabilities of a render driver or context.
Definition: SDL_render.h:78
Definition: SDL_render.h:115
DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *renderer, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
Get the color used for drawing operations (Rect, Line and Clear).
DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer *renderer, SDL_bool enable)
Set whether to force integer scales for resolution-independent rendering.
DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture *texture, Uint32 *format, int *access, int *w, int *h)
Query the attributes of a texture.
SDL_RendererFlags
Flags used when creating a rendering context.
Definition: SDL_render.h:64
SDL_BlendMode
The blend mode used in SDL_RenderCopy() and drawing operations.
Definition: SDL_blendmode.h:40
DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture *texture)
Destroy the specified texture.
DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, const SDL_Rect *rects, int count)
Fill some number of rectangles on the current rendering target with the drawing color.
int max_texture_height
Definition: SDL_render.h:85
DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(int width, int height, Uint32 window_flags, SDL_Window **window, SDL_Renderer **renderer)
Create a window and default renderer.
DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index, SDL_RendererInfo *info)
Get information about a specific 2D rendering driver for the current display.
DECLSPEC SDL_Texture *SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer)
Get the current render target or NULL for the default render target.
DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer *renderer, const SDL_Rect *rect)
Set the clip rectangle for the current target.
const char * name
Definition: SDL_render.h:80
DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer *renderer, int w, int h)
Set device independent resolution for rendering.
DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer)
Destroy the rendering context for a window and free associated textures.
Definition: SDL_render.h:94
SDL_TextureModulate
The texture channel modulation used in SDL_RenderCopy().
Definition: SDL_render.h:101
DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *srcrect, const SDL_Rect *dstrect, const double angle, const SDL_Point *center, const SDL_RendererFlip flip)
Copy a portion of the source texture to the current rendering target, rotating it by angle around the...
Uint32 texture_formats[16]
Definition: SDL_render.h:83
DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer *renderer, const SDL_Rect *rect, Uint32 format, void *pixels, int pitch)
Read pixels from the current rendering target.
DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b)
Set an additional color value used in render copy operations.
DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture, Uint8 *alpha)
Get the additional alpha value used in render copy operations.
Definition: SDL_render.h:66