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_mutex.h"
29 #include "SDL_yuv_sw_c.h"
30 
31 /* The SDL 2D rendering system */
32 
33 typedef struct SDL_RenderDriver SDL_RenderDriver;
34 
35 typedef enum
36 {
41 
42 typedef struct
43 {
44  float x;
45  float y;
46 } SDL_FPoint;
47 
48 typedef struct
49 {
50  float x;
51  float y;
52  float w;
53  float h;
54 } SDL_FRect;
55 
56 /* Define the SDL texture structure */
58 {
59  const void *magic;
60  Uint32 format; /**< The pixel format of the texture */
61  int access; /**< SDL_TextureAccess */
62  int w; /**< The width of the texture */
63  int h; /**< The height of the texture */
64  int modMode; /**< The texture modulation mode */
65  SDL_BlendMode blendMode; /**< The texture blend mode */
66  SDL_ScaleMode scaleMode; /**< The texture scale mode */
67  Uint8 r, g, b, a; /**< Texture modulation values */
68 
70 
71  /* Support for formats not supported directly by the renderer */
74  void *pixels;
75  int pitch;
77 
78  void *driverdata; /**< Driver specific texture representation */
79 
82 };
83 
84 /* Define the SDL renderer structure */
86 {
87  const void *magic;
88 
89  void (*WindowEvent) (SDL_Renderer * renderer, const SDL_WindowEvent *event);
90  int (*GetOutputSize) (SDL_Renderer * renderer, int *w, int *h);
92  int (*CreateTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
93  int (*SetTextureColorMod) (SDL_Renderer * renderer,
95  int (*SetTextureAlphaMod) (SDL_Renderer * renderer,
97  int (*SetTextureBlendMode) (SDL_Renderer * renderer,
100  const SDL_Rect * rect, const void *pixels,
101  int pitch);
102  int (*UpdateTextureYUV) (SDL_Renderer * renderer, SDL_Texture * texture,
103  const SDL_Rect * rect,
104  const Uint8 *Yplane, int Ypitch,
105  const Uint8 *Uplane, int Upitch,
106  const Uint8 *Vplane, int Vpitch);
107  int (*LockTexture) (SDL_Renderer * renderer, SDL_Texture * texture,
108  const SDL_Rect * rect, void **pixels, int *pitch);
109  void (*UnlockTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
110  int (*SetRenderTarget) (SDL_Renderer * renderer, SDL_Texture * texture);
111  int (*UpdateViewport) (SDL_Renderer * renderer);
112  int (*UpdateClipRect) (SDL_Renderer * renderer);
113  int (*RenderClear) (SDL_Renderer * renderer);
114  int (*RenderDrawPoints) (SDL_Renderer * renderer, const SDL_FPoint * points,
115  int count);
116  int (*RenderDrawLines) (SDL_Renderer * renderer, const SDL_FPoint * points,
117  int count);
118  int (*RenderFillRects) (SDL_Renderer * renderer, const SDL_FRect * rects,
119  int count);
120  int (*RenderCopy) (SDL_Renderer * renderer, SDL_Texture * texture,
121  const SDL_Rect * srcrect, const SDL_FRect * dstrect);
122  int (*RenderCopyEx) (SDL_Renderer * renderer, SDL_Texture * texture,
123  const SDL_Rect * srcquad, const SDL_FRect * dstrect,
124  const double angle, const SDL_FPoint *center, const SDL_RendererFlip flip);
125  int (*RenderReadPixels) (SDL_Renderer * renderer, const SDL_Rect * rect,
126  Uint32 format, void * pixels, int pitch);
127  void (*RenderPresent) (SDL_Renderer * renderer);
128  void (*DestroyTexture) (SDL_Renderer * renderer, SDL_Texture * texture);
129 
130  void (*DestroyRenderer) (SDL_Renderer * renderer);
131 
132  int (*GL_BindTexture) (SDL_Renderer * renderer, SDL_Texture *texture, float *texw, float *texh);
133  int (*GL_UnbindTexture) (SDL_Renderer * renderer, SDL_Texture *texture);
134 
135  void *(*GetMetalLayer) (SDL_Renderer * renderer);
136  void *(*GetMetalCommandEncoder) (SDL_Renderer * renderer);
137 
138  /* The current renderer info */
140 
141  /* The window associated with the renderer */
144 
145  /* The logical resolution for rendering */
150 
151  /* Whether or not to force the viewport to even integer intervals */
153 
154  /* The drawable area within the window */
157 
158  /* The clip rectangle within the window */
161 
162  /* Wether or not the clipping rectangle is used. */
165 
166  /* The render output coordinate scale */
169 
170  /* The pixel to point coordinate scale */
172 
173  /* The list of textures */
177 
178  Uint8 r, g, b, a; /**< Color for drawing operations values */
179  SDL_BlendMode blendMode; /**< The drawing blend mode */
180 
181  void *driverdata;
182 };
183 
184 /* Define the SDL render driver structure */
186 {
187  SDL_Renderer *(*CreateRenderer) (SDL_Window * window, Uint32 flags);
188 
189  /* Info about the renderer capabilities */
191 };
192 
193 /* Not all of these are available in a given build. Use #ifdefs, etc. */
203 
204 /* Blend mode functions */
211 
212 #endif /* SDL_sysrender_h_ */
213 
214 /* vi: set ts=4 sw=4 expandtab: */
void * pixels
Definition: SDL_sysrender.h:74
SDL_BlendMode blendMode
Definition: SDL_sysrender.h:65
SDL_BlendFactor SDL_GetBlendModeSrcColorFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2252
SDL_BlendOperation
The blend operation used when combining source and destination pixel components.
Definition: SDL_blendmode.h:62
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:2273
SDL_RenderDriver D3D11_RenderDriver
SDL_bool hidden
void * driverdata
SDL_RenderDriver PSP_RenderDriver
SDL_FPoint scale
uint8_t Uint8
Definition: SDL_stdinc.h:179
SDL_Rect locked_rect
Definition: SDL_sysrender.h:76
SDL_RenderDriver GL_RenderDriver
SDL_mutex * target_mutex
SDL_Rect clip_rect
SDL_Texture * textures
uint32_t Uint32
Definition: SDL_stdinc.h:203
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:81
GLenum GLenum GLuint texture
SDL_Texture * prev
Definition: SDL_sysrender.h:80
SDL_RenderDriver SW_RenderDriver
Definition: SDL_render_sw.c:78
SDL_Texture * target
struct _cl_event * event
SDL_SW_YUVTexture * yuv
Definition: SDL_sysrender.h:73
SDL_BlendMode blendMode
SDL_BlendFactor
The normalized factor used to multiply pixel components.
Definition: SDL_blendmode.h:75
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:195
SDL_bool
Definition: SDL_stdinc.h:161
SDL_BlendFactor SDL_GetBlendModeDstAlphaFactor(SDL_BlendMode blendMode)
Definition: SDL_render.c:2280
SDL_BlendOperation SDL_GetBlendModeAlphaOperation(SDL_BlendMode blendMode)
Definition: SDL_render.c:2287
Information on the capabilities of a render driver or context.
Definition: SDL_render.h:78
GLbitfield flags
SDL_Renderer * renderer
Definition: SDL_sysrender.h:69
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:2259
GLfloat angle
const void * magic
Definition: SDL_sysrender.h:87
Uint32 format
Definition: SDL_sysrender.h:60
void * driverdata
Definition: SDL_sysrender.h:78
SDL_Texture * native
Definition: SDL_sysrender.h:72
EGLSurface EGLint * rects
Definition: eglext.h:282
SDL_ScaleMode scaleMode
Definition: SDL_sysrender.h:66
SDL_Rect viewport_backup
const void * magic
Definition: SDL_sysrender.h:59
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:2266
SDL_bool integer_scale
SDL_bool clipping_enabled
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64
SDL_ScaleMode
Definition: SDL_sysrender.h:35