SDL  2.0
SDL_sysrender.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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 #include "../SDL_internal.h"
22 
23 #ifndef SDL_sysrender_h_
24 #define SDL_sysrender_h_
25 
26 #include "SDL_render.h"
27 #include "SDL_events.h"
28 #include "SDL_yuv_sw_c.h"
29 
30 /* The SDL 2D rendering system */
31 
32 typedef struct SDL_RenderDriver SDL_RenderDriver;
33 
34 typedef struct
35 {
36  float x;
37  float y;
38 } SDL_FPoint;
39 
40 typedef struct
41 {
42  float x;
43  float y;
44  float w;
45  float h;
46 } SDL_FRect;
47 
48 /* Define the SDL texture structure */
50 {
51  const void *magic;
52  Uint32 format; /**< The pixel format of the texture */
53  int access; /**< SDL_TextureAccess */
54  int w; /**< The width of the texture */
55  int h; /**< The height of the texture */
56  int modMode; /**< The texture modulation mode */
57  SDL_BlendMode blendMode; /**< The texture blend mode */
58  Uint8 r, g, b, a; /**< Texture modulation values */
59 
61 
62  /* Support for formats not supported directly by the renderer */
65  void *pixels;
66  int pitch;
68 
69  void *driverdata; /**< Driver specific texture representation */
70 
73 };
74 
75 /* Define the SDL renderer structure */
77 {
78  const void *magic;
79 
80  void (*WindowEvent) (SDL_Renderer * renderer, const SDL_WindowEvent *event);
81  int (*GetOutputSize) (SDL_Renderer * renderer, int *w, int *h);
83  int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
84  int (*SetTextureColorMod) (SDL_Renderer * renderer,
86  int (*SetTextureAlphaMod) (SDL_Renderer * renderer,
88  int (*SetTextureBlendMode) (SDL_Renderer * renderer,
91  const SDL_Rect * rect, const void *pixels,
92  int pitch);
93  int (*UpdateTextureYUV) (SDL_Renderer * renderer, SDL_Texture * texture,
94  const SDL_Rect * rect,
95  const Uint8 *Yplane, int Ypitch,
96  const Uint8 *Uplane, int Upitch,
97  const Uint8 *Vplane, int Vpitch);
98  int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
99  const SDL_Rect * rect, void **pixels, int *pitch);
100  void (*UnlockTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
101  int (*SetRenderTarget) (SDL_Renderer * renderer, SDL_Texture * texture);
102  int (*UpdateViewport) (SDL_Renderer * renderer);
103  int (*UpdateClipRect) (SDL_Renderer * renderer);
104  int (*RenderClear) (SDL_Renderer * renderer);
105  int (*RenderDrawPoints) (SDL_Renderer * renderer, const SDL_FPoint * points,
106  int count);
107  int (*RenderDrawLines) (SDL_Renderer * renderer, const SDL_FPoint * points,
108  int count);
109  int (*RenderFillRects) (SDL_Renderer * renderer, const SDL_FRect * rects,
110  int count);
111  int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
112  const SDL_Rect * srcrect, const SDL_FRect * dstrect);
113  int (*RenderCopyEx) (SDL_Renderer * renderer, SDL_Texture * texture,
114  const SDL_Rect * srcquad, const SDL_FRect * dstrect,
115  const double angle, const SDL_FPoint *center, const SDL_RendererFlip flip);
116  int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
117  Uint32 format, void * pixels, int pitch);
118  void (*RenderPresent) (SDL_Renderer * renderer);
119  void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
120 
121  void (*DestroyRenderer) (SDL_Renderer * renderer);
122 
123  int (*GL_BindTexture) (SDL_Renderer * renderer, SDL_Texture *texture, float *texw, float *texh);
124  int (*GL_UnbindTexture) (SDL_Renderer * renderer, SDL_Texture *texture);
125 
126  void *(*GetMetalLayer) (SDL_Renderer * renderer);
127  void *(*GetMetalCommandEncoder) (SDL_Renderer * renderer);
128 
129  /* The current renderer info */
131 
132  /* The window associated with the renderer */
135 
136  /* The logical resolution for rendering */
141 
142  /* Whether or not to force the viewport to even integer intervals */
144 
145  /* The drawable area within the window */
148 
149  /* The clip rectangle within the window */
152 
153  /* Wether or not the clipping rectangle is used. */
156 
157  /* The render output coordinate scale */
160 
161  /* The pixel to point coordinate scale */
163 
164  /* The list of textures */
167 
168  Uint8 r, g, b, a; /**< Color for drawing operations values */
169  SDL_BlendMode blendMode; /**< The drawing blend mode */
170 
171  void *driverdata;
172 };
173 
174 /* Define the SDL render driver structure */
176 {
177  SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
178 
179  /* Info about the renderer capabilities */
181 };
182 
183 /* Not all of these are available in a given build. Use #ifdefs, etc. */
193 
194 /* Blend mode functions */
201 
202 #endif /* SDL_sysrender_h_ */
203 
204 /* vi: set ts=4 sw=4 expandtab: */
SDL_BlendFactor
The normalized factor used to multiply pixel components.
Definition: SDL_blendmode.h:75
void * pixels
Definition: SDL_sysrender.h:65
SDL_BlendMode blendMode
Definition: SDL_sysrender.h:57
SDL_BlendFactor SDL_GetBlendModeSrcColorFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2193
SDL_RendererInfo info
SDL_Rect clip_rect_backup
SDL_RenderDriver GLES_RenderDriver
SDL_BlendMode
The blend mode used in SDL_RenderCopy() and drawing operations.
Definition: SDL_blendmode.h:40
SDL_RenderDriver DirectFB_RenderDriver
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
SDL_Rect rect
Definition: testrelative.c:27
SDL_BlendFactor SDL_GetBlendModeSrcAlphaFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2214
SDL_RenderDriver D3D11_RenderDriver
SDL_bool hidden
void * driverdata
SDL_RenderDriver PSP_RenderDriver
SDL_FPoint scale
SDL_Rect locked_rect
Definition: SDL_sysrender.h:67
SDL_RenderDriver GL_RenderDriver
SDL_Rect clip_rect
uint32_t Uint32
Definition: SDL_stdinc.h:181
SDL_Texture * textures
SDL_BlendOperation
The blend operation used when combining source and destination pixel components.
Definition: SDL_blendmode.h:62
SDL_Window * window
SDL_RendererInfo info
GLfixed GLfixed GLint GLint GLfixed points
SDL_FPoint scale_backup
SDL_RenderDriver METAL_RenderDriver
SDL_RenderDriver GLES2_RenderDriver
SDL_Texture * next
Definition: SDL_sysrender.h:72
GLenum GLenum GLuint texture
SDL_Texture * prev
Definition: SDL_sysrender.h:71
SDL_RenderDriver SW_RenderDriver
Definition: SDL_render_sw.c:78
SDL_Texture * target
uint8_t Uint8
Definition: SDL_stdinc.h:157
struct _cl_event * event
SDL_SW_YUVTexture * yuv
Definition: SDL_sysrender.h:64
SDL_BlendMode blendMode
SDL_RenderDriver D3D_RenderDriver
SDL_RendererFlip
Flip constants for SDL_RenderCopyEx.
Definition: SDL_render.h:111
Window state change event data (event.window.*)
Definition: SDL_events.h:174
SDL_bool
Definition: SDL_stdinc.h:139
SDL_BlendFactor SDL_GetBlendModeDstAlphaFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2221
SDL_BlendOperation SDL_GetBlendModeAlphaOperation(SDL_BlendMode blendMode)
Definition: SDL_render.c:2228
Information on the capabilities of a render driver or context.
Definition: SDL_render.h:78
GLbitfield flags
SDL_Renderer * renderer
Definition: SDL_sysrender.h:60
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_Rect viewport
SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
The type used to identify a window.
Definition: SDL_sysvideo.h:73
SDL_BlendFactor SDL_GetBlendModeDstColorFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2200
GLfloat angle
const void * magic
Definition: SDL_sysrender.h:78
Uint32 format
Definition: SDL_sysrender.h:52
void * driverdata
Definition: SDL_sysrender.h:69
SDL_Texture * native
Definition: SDL_sysrender.h:63
EGLSurface EGLint * rects
Definition: eglext.h:282
SDL_Rect viewport_backup
const void * magic
Definition: SDL_sysrender.h:51
SDL_bool clipping_enabled_backup
void UpdateTexture(SDL_Texture *texture, int frame)
Definition: teststreaming.c:70
SDL_FPoint dpi_scale
SDL_BlendOperation SDL_GetBlendModeColorOperation(SDL_BlendMode blendMode)
Definition: SDL_render.c:2207
SDL_bool integer_scale
SDL_bool clipping_enabled
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64