SDL  2.0
SDL_render.h File Reference
#include "SDL_stdinc.h"
#include "SDL_rect.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_render.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_RendererInfo
 Information on the capabilities of a render driver or context. More...
 

Enumerations

enum  SDL_RendererFlags {
  SDL_RENDERER_SOFTWARE = 0x00000001,
  SDL_RENDERER_ACCELERATED = 0x00000002,
  SDL_RENDERER_PRESENTVSYNC = 0x00000004,
  SDL_RENDERER_TARGETTEXTURE = 0x00000008
}
 Flags used when creating a rendering context. More...
 
enum  SDL_TextureAccess {
  SDL_TEXTUREACCESS_STATIC,
  SDL_TEXTUREACCESS_STREAMING,
  SDL_TEXTUREACCESS_TARGET
}
 The access pattern allowed for a texture. More...
 
enum  SDL_TextureModulate {
  SDL_TEXTUREMODULATE_NONE = 0x00000000,
  SDL_TEXTUREMODULATE_COLOR = 0x00000001,
  SDL_TEXTUREMODULATE_ALPHA = 0x00000002
}
 The texture channel modulation used in SDL_RenderCopy(). More...
 
enum  SDL_RendererFlip {
  SDL_FLIP_NONE = 0x00000000,
  SDL_FLIP_HORIZONTAL = 0x00000001,
  SDL_FLIP_VERTICAL = 0x00000002
}
 Flip constants for SDL_RenderCopyEx. More...
 

Functions

int SDL_GetNumRenderDrivers (void)
 Get the number of 2D rendering drivers available for the current display. More...
 
int SDL_GetRenderDriverInfo (int index, SDL_RendererInfo *info)
 Get information about a specific 2D rendering driver for the current display. More...
 
int SDL_CreateWindowAndRenderer (int width, int height, Uint32 window_flags, SDL_Window **window, SDL_Renderer **renderer)
 Create a window and default renderer. More...
 
SDL_RendererSDL_CreateRenderer (SDL_Window *window, int index, Uint32 flags)
 Create a 2D rendering context for a window. More...
 
SDL_RendererSDL_CreateSoftwareRenderer (SDL_Surface *surface)
 Create a 2D software rendering context for a surface. More...
 
SDL_RendererSDL_GetRenderer (SDL_Window *window)
 Get the renderer associated with a window. More...
 
int SDL_GetRendererInfo (SDL_Renderer *renderer, SDL_RendererInfo *info)
 Get information about a rendering context. More...
 
int SDL_GetRendererOutputSize (SDL_Renderer *renderer, int *w, int *h)
 Get the output size in pixels of a rendering context. More...
 
SDL_TextureSDL_CreateTexture (SDL_Renderer *renderer, Uint32 format, int access, int w, int h)
 Create a texture for a rendering context. More...
 
SDL_TextureSDL_CreateTextureFromSurface (SDL_Renderer *renderer, SDL_Surface *surface)
 Create a texture from an existing surface. More...
 
int SDL_QueryTexture (SDL_Texture *texture, Uint32 *format, int *access, int *w, int *h)
 Query the attributes of a texture. More...
 
int SDL_SetTextureColorMod (SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b)
 Set an additional color value used in render copy operations. More...
 
int SDL_GetTextureColorMod (SDL_Texture *texture, Uint8 *r, Uint8 *g, Uint8 *b)
 Get the additional color value used in render copy operations. More...
 
int SDL_SetTextureAlphaMod (SDL_Texture *texture, Uint8 alpha)
 Set an additional alpha value used in render copy operations. More...
 
int SDL_GetTextureAlphaMod (SDL_Texture *texture, Uint8 *alpha)
 Get the additional alpha value used in render copy operations. More...
 
int SDL_SetTextureBlendMode (SDL_Texture *texture, SDL_BlendMode blendMode)
 Set the blend mode used for texture copy operations. More...
 
int SDL_GetTextureBlendMode (SDL_Texture *texture, SDL_BlendMode *blendMode)
 Get the blend mode used for texture copy operations. More...
 
int SDL_UpdateTexture (SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
 Update the given texture rectangle with new pixel data. More...
 
int 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. More...
 
int SDL_LockTexture (SDL_Texture *texture, const SDL_Rect *rect, void **pixels, int *pitch)
 Lock a portion of the texture for write-only pixel access. More...
 
void SDL_UnlockTexture (SDL_Texture *texture)
 Unlock a texture, uploading the changes to video memory, if needed. More...
 
SDL_bool SDL_RenderTargetSupported (SDL_Renderer *renderer)
 Determines whether a window supports the use of render targets. More...
 
int SDL_SetRenderTarget (SDL_Renderer *renderer, SDL_Texture *texture)
 Set a texture as the current rendering target. More...
 
SDL_TextureSDL_GetRenderTarget (SDL_Renderer *renderer)
 Get the current render target or NULL for the default render target. More...
 
int SDL_RenderSetLogicalSize (SDL_Renderer *renderer, int w, int h)
 Set device independent resolution for rendering. More...
 
void SDL_RenderGetLogicalSize (SDL_Renderer *renderer, int *w, int *h)
 Get device independent resolution for rendering. More...
 
int SDL_RenderSetIntegerScale (SDL_Renderer *renderer, SDL_bool enable)
 Set whether to force integer scales for resolution-independent rendering. More...
 
SDL_bool SDL_RenderGetIntegerScale (SDL_Renderer *renderer)
 Get whether integer scales are forced for resolution-independent rendering. More...
 
int SDL_RenderSetViewport (SDL_Renderer *renderer, const SDL_Rect *rect)
 Set the drawing area for rendering on the current target. More...
 
void SDL_RenderGetViewport (SDL_Renderer *renderer, SDL_Rect *rect)
 Get the drawing area for the current target. More...
 
int SDL_RenderSetClipRect (SDL_Renderer *renderer, const SDL_Rect *rect)
 Set the clip rectangle for the current target. More...
 
void SDL_RenderGetClipRect (SDL_Renderer *renderer, SDL_Rect *rect)
 Get the clip rectangle for the current target. More...
 
SDL_bool SDL_RenderIsClipEnabled (SDL_Renderer *renderer)
 Get whether clipping is enabled on the given renderer. More...
 
int SDL_RenderSetScale (SDL_Renderer *renderer, float scaleX, float scaleY)
 Set the drawing scale for rendering on the current target. More...
 
void SDL_RenderGetScale (SDL_Renderer *renderer, float *scaleX, float *scaleY)
 Get the drawing scale for the current target. More...
 
int SDL_SetRenderDrawColor (SDL_Renderer *renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
 Set the color used for drawing operations (Rect, Line and Clear). More...
 
int SDL_GetRenderDrawColor (SDL_Renderer *renderer, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
 Get the color used for drawing operations (Rect, Line and Clear). More...
 
int SDL_SetRenderDrawBlendMode (SDL_Renderer *renderer, SDL_BlendMode blendMode)
 Set the blend mode used for drawing operations (Fill and Line). More...
 
int SDL_GetRenderDrawBlendMode (SDL_Renderer *renderer, SDL_BlendMode *blendMode)
 Get the blend mode used for drawing operations. More...
 
int SDL_RenderClear (SDL_Renderer *renderer)
 Clear the current rendering target with the drawing color. More...
 
int SDL_RenderDrawPoint (SDL_Renderer *renderer, int x, int y)
 Draw a point on the current rendering target. More...
 
int SDL_RenderDrawPoints (SDL_Renderer *renderer, const SDL_Point *points, int count)
 Draw multiple points on the current rendering target. More...
 
int SDL_RenderDrawLine (SDL_Renderer *renderer, int x1, int y1, int x2, int y2)
 Draw a line on the current rendering target. More...
 
int SDL_RenderDrawLines (SDL_Renderer *renderer, const SDL_Point *points, int count)
 Draw a series of connected lines on the current rendering target. More...
 
int SDL_RenderDrawRect (SDL_Renderer *renderer, const SDL_Rect *rect)
 Draw a rectangle on the current rendering target. More...
 
int SDL_RenderDrawRects (SDL_Renderer *renderer, const SDL_Rect *rects, int count)
 Draw some number of rectangles on the current rendering target. More...
 
int SDL_RenderFillRect (SDL_Renderer *renderer, const SDL_Rect *rect)
 Fill a rectangle on the current rendering target with the drawing color. More...
 
int 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. More...
 
int 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. More...
 
int 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 given center. More...
 
int SDL_RenderReadPixels (SDL_Renderer *renderer, const SDL_Rect *rect, Uint32 format, void *pixels, int pitch)
 Read pixels from the current rendering target. More...
 
void SDL_RenderPresent (SDL_Renderer *renderer)
 Update the screen with rendering performed. More...
 
void SDL_DestroyTexture (SDL_Texture *texture)
 Destroy the specified texture. More...
 
void SDL_DestroyRenderer (SDL_Renderer *renderer)
 Destroy the rendering context for a window and free associated textures. More...
 
int 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. More...
 
int SDL_GL_UnbindTexture (SDL_Texture *texture)
 Unbind a texture from the current OpenGL/ES/ES2 context. More...
 
voidSDL_RenderGetMetalLayer (SDL_Renderer *renderer)
 Get the CAMetalLayer associated with the given Metal renderer. More...
 
voidSDL_RenderGetMetalCommandEncoder (SDL_Renderer *renderer)
 Get the Metal command encoder for the current frame. More...
 

Detailed Description

Header file for SDL 2D rendering functions.

This API supports the following features:

  • single pixel points
  • single pixel lines
  • filled rectangles
  • texture images

The primitives may be drawn in opaque, blended, or additive modes.

The texture images may be drawn in opaque, blended, or additive modes. They can have an additional color tint or alpha modulation applied to them, and may also be stretched with linear interpolation.

This API is designed to accelerate simple 2D operations. You may want more functionality such as polygons and particle effects and in that case you should use SDL's OpenGL/Direct3D support or one of the many good 3D engines.

These functions must be called from the main thread. See this bug for details: http://bugzilla.libsdl.org/show_bug.cgi?id=1995

Definition in file SDL_render.h.

Enumeration Type Documentation

◆ SDL_RendererFlags

Flags used when creating a rendering context.

Enumerator
SDL_RENDERER_SOFTWARE 

The renderer is a software fallback

SDL_RENDERER_ACCELERATED 

The renderer uses hardware acceleration

SDL_RENDERER_PRESENTVSYNC 

Present is synchronized with the refresh rate

SDL_RENDERER_TARGETTEXTURE 

The renderer supports rendering to texture

Definition at line 64 of file SDL_render.h.

65 {
66  SDL_RENDERER_SOFTWARE = 0x00000001, /**< The renderer is a software fallback */
67  SDL_RENDERER_ACCELERATED = 0x00000002, /**< The renderer uses hardware
68  acceleration */
69  SDL_RENDERER_PRESENTVSYNC = 0x00000004, /**< Present is synchronized
70  with the refresh rate */
71  SDL_RENDERER_TARGETTEXTURE = 0x00000008 /**< The renderer supports
72  rendering to texture */

◆ SDL_RendererFlip

Flip constants for SDL_RenderCopyEx.

Enumerator
SDL_FLIP_NONE 

Do not flip

SDL_FLIP_HORIZONTAL 

flip horizontally

SDL_FLIP_VERTICAL 

flip vertically

Definition at line 111 of file SDL_render.h.

112 {
113  SDL_FLIP_NONE = 0x00000000, /**< Do not flip */
114  SDL_FLIP_HORIZONTAL = 0x00000001, /**< flip horizontally */
115  SDL_FLIP_VERTICAL = 0x00000002 /**< flip vertically */

◆ SDL_TextureAccess

The access pattern allowed for a texture.

Enumerator
SDL_TEXTUREACCESS_STATIC 

Changes rarely, not lockable

SDL_TEXTUREACCESS_STREAMING 

Changes frequently, lockable

SDL_TEXTUREACCESS_TARGET 

Texture can be used as a render target

Definition at line 91 of file SDL_render.h.

92 {
93  SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
94  SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
95  SDL_TEXTUREACCESS_TARGET /**< Texture can be used as a render target */

◆ SDL_TextureModulate

The texture channel modulation used in SDL_RenderCopy().

Enumerator
SDL_TEXTUREMODULATE_NONE 

No modulation

SDL_TEXTUREMODULATE_COLOR 

srcC = srcC * color

SDL_TEXTUREMODULATE_ALPHA 

srcA = srcA * alpha

Definition at line 101 of file SDL_render.h.

102 {
103  SDL_TEXTUREMODULATE_NONE = 0x00000000, /**< No modulation */
104  SDL_TEXTUREMODULATE_COLOR = 0x00000001, /**< srcC = srcC * color */
105  SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /**< srcA = srcA * alpha */

Function Documentation

◆ SDL_CreateRenderer()

SDL_Renderer* SDL_CreateRenderer ( SDL_Window window,
int  index,
Uint32  flags 
)

Create a 2D rendering context for a window.

Parameters
windowThe window where rendering is displayed.
indexThe index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested flags.
flagsSDL_RendererFlags.
Returns
A valid rendering context or NULL if there was an error.
See also
SDL_CreateSoftwareRenderer()
SDL_GetRendererInfo()
SDL_DestroyRenderer()

Definition at line 304 of file SDL_render.c.

305 {
306 #if !SDL_RENDER_DISABLED
308  int n = SDL_GetNumRenderDrivers();
309  const char *hint;
310 
311  if (!window) {
312  SDL_SetError("Invalid window");
313  return NULL;
314  }
315 
316  if (SDL_GetRenderer(window)) {
317  SDL_SetError("Renderer already associated with window");
318  return NULL;
319  }
320 
324  } else {
326  }
327  }
328 
329  if (index < 0) {
331  if (hint) {
332  for (index = 0; index < n; ++index) {
333  const SDL_RenderDriver *driver = render_drivers[index];
334 
335  if (SDL_strcasecmp(hint, driver->info.name) == 0) {
336  /* Create a new renderer instance */
337  renderer = driver->CreateRenderer(window, flags);
338  break;
339  }
340  }
341  }
342 
343  if (!renderer) {
344  for (index = 0; index < n; ++index) {
345  const SDL_RenderDriver *driver = render_drivers[index];
346 
347  if ((driver->info.flags & flags) == flags) {
348  /* Create a new renderer instance */
349  renderer = driver->CreateRenderer(window, flags);
350  if (renderer) {
351  /* Yay, we got one! */
352  break;
353  }
354  }
355  }
356  }
357  if (index == n) {
358  SDL_SetError("Couldn't find matching render driver");
359  return NULL;
360  }
361  } else {
362  if (index >= SDL_GetNumRenderDrivers()) {
363  SDL_SetError("index must be -1 or in the range of 0 - %d",
365  return NULL;
366  }
367  /* Create a new renderer instance */
369  }
370 
371  if (renderer) {
375  renderer->scale.x = 1.0f;
376  renderer->scale.y = 1.0f;
377  renderer->dpi_scale.x = 1.0f;
378  renderer->dpi_scale.y = 1.0f;
379 
380  if (window && renderer->GetOutputSize) {
381  int window_w, window_h;
382  int output_w, output_h;
383  if (renderer->GetOutputSize(renderer, &output_w, &output_h) == 0) {
385  renderer->dpi_scale.x = (float)window_w / output_w;
386  renderer->dpi_scale.y = (float)window_h / output_h;
387  }
388  }
389 
392  } else {
394  }
395 
397 
399 
401 
403  "Created renderer: %s", renderer->info.name);
404  }
405  return renderer;
406 #else
407  SDL_SetError("SDL not built with rendering support");
408  return NULL;
409 #endif
410 }

References SDL_RenderDriver::CreateRenderer, SDL_Renderer::dpi_scale, SDL_RendererInfo::flags, SDL_Renderer::GetOutputSize, SDL_Renderer::hidden, SDL_Renderer::info, SDL_RenderDriver::info, SDL_Renderer::magic, SDL_RendererInfo::name, NULL, render_drivers, renderer, renderer_magic, SDL_Renderer::scale, SDL_AddEventWatch, SDL_CreateMutex, SDL_FALSE, SDL_GetHint, SDL_GetHintBoolean, SDL_GetNumRenderDrivers(), SDL_GetRenderer(), SDL_GetWindowFlags, SDL_GetWindowSize, SDL_HINT_RENDER_DRIVER, SDL_HINT_RENDER_VSYNC, SDL_LOG_CATEGORY_RENDER, SDL_LogInfo, SDL_RENDERER_PRESENTVSYNC, SDL_RendererEventWatch(), SDL_RenderSetViewport(), SDL_SetError, SDL_SetWindowData, SDL_strcasecmp, SDL_TRUE, SDL_WINDOW_HIDDEN, SDL_WINDOW_MINIMIZED, SDL_WINDOWRENDERDATA, SDL_Renderer::target_mutex, SDL_Renderer::window, window_h, window_w, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_CreateWindowAndRenderer().

◆ SDL_CreateSoftwareRenderer()

SDL_Renderer* SDL_CreateSoftwareRenderer ( SDL_Surface surface)

Create a 2D software rendering context for a surface.

Parameters
surfaceThe surface where rendering is done.
Returns
A valid rendering context or NULL if there was an error.
See also
SDL_CreateRenderer()
SDL_DestroyRenderer()

Definition at line 413 of file SDL_render.c.

414 {
415 #if !SDL_RENDER_DISABLED
417 
419 
420  if (renderer) {
423  renderer->scale.x = 1.0f;
424  renderer->scale.y = 1.0f;
425 
427  }
428  return renderer;
429 #else
430  SDL_SetError("SDL not built with rendering support");
431  return NULL;
432 #endif /* !SDL_RENDER_DISABLED */
433 }

References SDL_Renderer::magic, NULL, renderer, renderer_magic, SDL_Renderer::scale, SDL_CreateMutex, SDL_RenderSetViewport(), SDL_SetError, SW_CreateRendererForSurface(), SDL_Renderer::target_mutex, SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_CreateTexture()

SDL_Texture* SDL_CreateTexture ( SDL_Renderer renderer,
Uint32  format,
int  access,
int  w,
int  h 
)

Create a texture for a rendering context.

Parameters
rendererThe renderer.
formatThe format of the texture.
accessOne of the enumerated values in SDL_TextureAccess.
wThe width of the texture in pixels.
hThe height of the texture in pixels.
Returns
The created texture is returned, or NULL if no rendering context was active, the format was unsupported, or the width or height were out of range.
Note
The contents of the texture are not defined at creation.
See also
SDL_QueryTexture()
SDL_UpdateTexture()
SDL_DestroyTexture()

Definition at line 541 of file SDL_render.c.

542 {
544 
546 
547  if (!format) {
549  }
550  if (SDL_BYTESPERPIXEL(format) == 0) {
551  SDL_SetError("Invalid texture format");
552  return NULL;
553  }
555  SDL_SetError("Palettized textures are not supported");
556  return NULL;
557  }
558  if (w <= 0 || h <= 0) {
559  SDL_SetError("Texture dimensions can't be 0");
560  return NULL;
561  }
564  SDL_SetError("Texture dimensions are limited to %dx%d", renderer->info.max_texture_width, renderer->info.max_texture_height);
565  return NULL;
566  }
567  texture = (SDL_Texture *) SDL_calloc(1, sizeof(*texture));
568  if (!texture) {
569  SDL_OutOfMemory();
570  return NULL;
571  }
572  texture->magic = &texture_magic;
573  texture->format = format;
574  texture->access = access;
575  texture->w = w;
576  texture->h = h;
577  texture->r = 255;
578  texture->g = 255;
579  texture->b = 255;
580  texture->a = 255;
581  texture->scaleMode = SDL_GetScaleMode();
582  texture->renderer = renderer;
583  texture->next = renderer->textures;
584  if (renderer->textures) {
586  }
588 
590  if (renderer->CreateTexture(renderer, texture) < 0) {
592  return NULL;
593  }
594  } else {
597  access, w, h);
598  if (!texture->native) {
600  return NULL;
601  }
602 
603  /* Swap textures to have texture before texture->native in the list */
604  texture->native->next = texture->next;
605  if (texture->native->next) {
606  texture->native->next->prev = texture->native;
607  }
608  texture->prev = texture->native->prev;
609  if (texture->prev) {
610  texture->prev->next = texture;
611  }
612  texture->native->prev = texture;
613  texture->next = texture->native;
615 
616  if (SDL_ISPIXELFORMAT_FOURCC(texture->format)) {
618  if (!texture->yuv) {
620  return NULL;
621  }
622  } else if (access == SDL_TEXTUREACCESS_STREAMING) {
623  /* The pitch is 4 byte aligned */
624  texture->pitch = (((w * SDL_BYTESPERPIXEL(format)) + 3) & ~3);
625  texture->pixels = SDL_calloc(1, texture->pitch * h);
626  if (!texture->pixels) {
628  return NULL;
629  }
630  }
631  }
632  return texture;
633 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::CreateTexture, GetClosestSupportedFormat(), SDL_Renderer::info, IsSupportedFormat(), SDL_RendererInfo::max_texture_height, SDL_RendererInfo::max_texture_width, NULL, SDL_Texture::prev, renderer, SDL_BYTESPERPIXEL, SDL_calloc, SDL_DestroyTexture(), SDL_GetScaleMode(), SDL_ISPIXELFORMAT_FOURCC, SDL_ISPIXELFORMAT_INDEXED, SDL_OutOfMemory, SDL_SetError, SDL_SW_CreateYUVTexture(), SDL_TEXTUREACCESS_STREAMING, SDL_RendererInfo::texture_formats, texture_magic, and SDL_Renderer::textures.

Referenced by SDL_CreateTextureFromSurface().

◆ SDL_CreateTextureFromSurface()

SDL_Texture* SDL_CreateTextureFromSurface ( SDL_Renderer renderer,
SDL_Surface surface 
)

Create a texture from an existing surface.

Parameters
rendererThe renderer.
surfaceThe surface containing pixel data used to fill the texture.
Returns
The created texture is returned, or NULL on error.
Note
The surface is not modified or freed by this function.
See also
SDL_QueryTexture()
SDL_DestroyTexture()

Definition at line 636 of file SDL_render.c.

637 {
638  const SDL_PixelFormat *fmt;
639  SDL_bool needAlpha;
640  Uint32 i;
641  Uint32 format;
643 
645 
646  if (!surface) {
647  SDL_SetError("SDL_CreateTextureFromSurface() passed NULL surface");
648  return NULL;
649  }
650 
651  /* See what the best texture format is */
652  fmt = surface->format;
653  if (fmt->Amask || SDL_HasColorKey(surface)) {
654  needAlpha = SDL_TRUE;
655  } else {
656  needAlpha = SDL_FALSE;
657  }
659  for (i = 0; i < renderer->info.num_texture_formats; ++i) {
663  break;
664  }
665  }
666 
668  surface->w, surface->h);
669  if (!texture) {
670  return NULL;
671  }
672 
673  if (format == surface->format->format) {
674  if (SDL_MUSTLOCK(surface)) {
676  SDL_UpdateTexture(texture, NULL, surface->pixels, surface->pitch);
678  } else {
679  SDL_UpdateTexture(texture, NULL, surface->pixels, surface->pitch);
680  }
681  } else {
682  SDL_PixelFormat *dst_fmt;
683  SDL_Surface *temp = NULL;
684 
685  /* Set up a destination surface for the texture update */
686  dst_fmt = SDL_AllocFormat(format);
687  if (!dst_fmt) {
689  return NULL;
690  }
691  temp = SDL_ConvertSurface(surface, dst_fmt, 0);
692  SDL_FreeFormat(dst_fmt);
693  if (temp) {
694  SDL_UpdateTexture(texture, NULL, temp->pixels, temp->pitch);
695  SDL_FreeSurface(temp);
696  } else {
698  return NULL;
699  }
700  }
701 
702  {
703  Uint8 r, g, b, a;
705 
708 
711 
712  if (SDL_HasColorKey(surface)) {
713  /* We converted to a texture with alpha format */
715  } else {
718  }
719  }
720  return texture;
721 }

References SDL_PixelFormat::Amask, blendMode, CHECK_RENDERER_MAGIC, SDL_PixelFormat::format, i, SDL_Renderer::info, NULL, SDL_RendererInfo::num_texture_formats, SDL_Surface::pitch, SDL_Surface::pixels, renderer, SDL_AllocFormat, SDL_BLENDMODE_BLEND, SDL_ConvertSurface, SDL_CreateTexture(), SDL_DestroyTexture(), SDL_FALSE, SDL_FreeFormat, SDL_FreeSurface, SDL_GetSurfaceAlphaMod, SDL_GetSurfaceBlendMode, SDL_GetSurfaceColorMod, SDL_HasColorKey, SDL_ISPIXELFORMAT_ALPHA, SDL_ISPIXELFORMAT_FOURCC, SDL_LockSurface, SDL_MUSTLOCK, SDL_SetError, SDL_SetTextureAlphaMod(), SDL_SetTextureBlendMode(), SDL_SetTextureColorMod(), SDL_TEXTUREACCESS_STATIC, SDL_TRUE, SDL_UnlockSurface, SDL_UpdateTexture(), and SDL_RendererInfo::texture_formats.

◆ SDL_CreateWindowAndRenderer()

int SDL_CreateWindowAndRenderer ( int  width,
int  height,
Uint32  window_flags,
SDL_Window **  window,
SDL_Renderer **  renderer 
)

Create a window and default renderer.

Parameters
widthThe width of the window
heightThe height of the window
window_flagsThe flags used to create the window
windowA pointer filled with the window, or NULL on error
rendererA pointer filled with the renderer, or NULL on error
Returns
0 on success, or -1 on error

Definition at line 284 of file SDL_render.c.

286 {
289  width, height, window_flags);
290  if (!*window) {
291  *renderer = NULL;
292  return -1;
293  }
294 
295  *renderer = SDL_CreateRenderer(*window, -1, 0);
296  if (!*renderer) {
297  return -1;
298  }
299 
300  return 0;
301 }

References NULL, renderer, SDL_CreateRenderer(), SDL_CreateWindow, and SDL_WINDOWPOS_UNDEFINED.

◆ SDL_DestroyRenderer()

void SDL_DestroyRenderer ( SDL_Renderer renderer)

Destroy the rendering context for a window and free associated textures.

See also
SDL_CreateRenderer()

Definition at line 2124 of file SDL_render.c.

2125 {
2127 
2129 
2130  /* Free existing textures for this renderer */
2131  while (renderer->textures) {
2132  SDL_Texture *tex = renderer->textures; (void) tex;
2134  SDL_assert(tex != renderer->textures); /* satisfy static analysis. */
2135  }
2136 
2137  if (renderer->window) {
2139  }
2140 
2141  /* It's no longer magical... */
2142  renderer->magic = NULL;
2143 
2144  /* Free the target mutex */
2147 
2148  /* Free the renderer instance */
2150 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::DestroyRenderer, SDL_Renderer::magic, NULL, renderer, SDL_assert, SDL_DelEventWatch, SDL_DestroyMutex, SDL_DestroyTexture(), SDL_RendererEventWatch(), SDL_SetWindowData, SDL_WINDOWRENDERDATA, SDL_Renderer::target_mutex, SDL_Renderer::textures, void, and SDL_Renderer::window.

◆ SDL_DestroyTexture()

void SDL_DestroyTexture ( SDL_Texture texture)

Destroy the specified texture.

See also
SDL_CreateTexture()
SDL_CreateTextureFromSurface()

Definition at line 2089 of file SDL_render.c.

2090 {
2092 
2094 
2095  renderer = texture->renderer;
2096  if (texture == renderer->target) {
2098  }
2099 
2100  texture->magic = NULL;
2101 
2102  if (texture->next) {
2103  texture->next->prev = texture->prev;
2104  }
2105  if (texture->prev) {
2106  texture->prev->next = texture->next;
2107  } else {
2109  }
2110 
2111  if (texture->native) {
2112  SDL_DestroyTexture(texture->native);
2113  }
2114  if (texture->yuv) {
2116  }
2117  SDL_free(texture->pixels);
2118 
2120  SDL_free(texture);
2121 }

References CHECK_TEXTURE_MAGIC, SDL_Renderer::DestroyTexture, SDL_Texture::next, NULL, renderer, SDL_free, SDL_SetRenderTarget(), SDL_SW_DestroyYUVTexture(), SDL_Renderer::target, and SDL_Renderer::textures.

Referenced by SDL_CreateTexture(), SDL_CreateTextureFromSurface(), and SDL_DestroyRenderer().

◆ SDL_GetNumRenderDrivers()

int SDL_GetNumRenderDrivers ( void  )

Get the number of 2D rendering drivers available for the current display.

A render driver is a set of code that handles rendering and texture management on a particular display. Normally there is only one, but some drivers may have several available with different capabilities.

See also
SDL_GetRenderDriverInfo()
SDL_CreateRenderer()

Definition at line 329 of file SDL_dynapi_procs.h.

References render_drivers, and SDL_arraysize.

Referenced by SDL_CreateRenderer(), and SDL_GetRenderDriverInfo().

◆ SDL_GetRenderDrawBlendMode()

int SDL_GetRenderDrawBlendMode ( SDL_Renderer renderer,
SDL_BlendMode blendMode 
)

Get the blend mode used for drawing operations.

Parameters
rendererThe renderer from which blend mode should be queried.
blendModeA pointer filled in with the current blend mode.
Returns
0 on success, or -1 on error
See also
SDL_SetRenderDrawBlendMode()

Definition at line 1593 of file SDL_render.c.

1594 {
1596 
1598  return 0;
1599 }

References SDL_Renderer::blendMode, blendMode, CHECK_RENDERER_MAGIC, and renderer.

◆ SDL_GetRenderDrawColor()

int SDL_GetRenderDrawColor ( SDL_Renderer renderer,
Uint8 r,
Uint8 g,
Uint8 b,
Uint8 a 
)

Get the color used for drawing operations (Rect, Line and Clear).

Parameters
rendererThe renderer from which drawing color should be queried.
rA pointer to the red value used to draw on the rendering target.
gA pointer to the green value used to draw on the rendering target.
bA pointer to the blue value used to draw on the rendering target.
aA pointer to the alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255).
Returns
0 on success, or -1 on error

Definition at line 1560 of file SDL_render.c.

1562 {
1564 
1565  if (r) {
1566  *r = renderer->r;
1567  }
1568  if (g) {
1569  *g = renderer->g;
1570  }
1571  if (b) {
1572  *b = renderer->b;
1573  }
1574  if (a) {
1575  *a = renderer->a;
1576  }
1577  return 0;
1578 }

References SDL_Renderer::a, SDL_Renderer::b, CHECK_RENDERER_MAGIC, SDL_Renderer::g, SDL_Renderer::r, and renderer.

◆ SDL_GetRenderDriverInfo()

int SDL_GetRenderDriverInfo ( int  index,
SDL_RendererInfo info 
)

Get information about a specific 2D rendering driver for the current display.

Parameters
indexThe index of the driver to query information about.
infoA pointer to an SDL_RendererInfo struct to be filled with information on the rendering driver.
Returns
0 on success, -1 if the index was out of range.
See also
SDL_CreateRenderer()

Definition at line 121 of file SDL_render.c.

122 {
123 #if !SDL_RENDER_DISABLED
125  return SDL_SetError("index must be in the range of 0 - %d",
127  }
128  *info = render_drivers[index]->info;
129  return 0;
130 #else
131  return SDL_SetError("SDL not built with rendering support");
132 #endif
133 }

References SDL_RenderDriver::info, render_drivers, SDL_GetNumRenderDrivers(), and SDL_SetError.

◆ SDL_GetRenderer()

SDL_Renderer* SDL_GetRenderer ( SDL_Window window)

Get the renderer associated with a window.

Definition at line 436 of file SDL_render.c.

437 {
439 }

References SDL_GetWindowData, and SDL_WINDOWRENDERDATA.

Referenced by SDL_CreateRenderer().

◆ SDL_GetRendererInfo()

int SDL_GetRendererInfo ( SDL_Renderer renderer,
SDL_RendererInfo info 
)

Get information about a rendering context.

Definition at line 442 of file SDL_render.c.

443 {
445 
446  *info = renderer->info;
447  return 0;
448 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::info, and renderer.

◆ SDL_GetRendererOutputSize()

int SDL_GetRendererOutputSize ( SDL_Renderer renderer,
int *  w,
int *  h 
)

Get the output size in pixels of a rendering context.

Definition at line 451 of file SDL_render.c.

452 {
454 
455  if (renderer->target) {
456  return SDL_QueryTexture(renderer->target, NULL, NULL, w, h);
457  } else if (renderer->GetOutputSize) {
458  return renderer->GetOutputSize(renderer, w, h);
459  } else if (renderer->window) {
461  return 0;
462  } else {
463  SDL_assert(0 && "This should never happen");
464  return SDL_SetError("Renderer doesn't support querying output size");
465  }
466 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::GetOutputSize, NULL, renderer, SDL_assert, SDL_GetWindowSize, SDL_QueryTexture(), SDL_SetError, SDL_Renderer::target, and SDL_Renderer::window.

Referenced by SDL_RendererEventWatch(), SDL_RenderSetViewport(), and UpdateLogicalSize().

◆ SDL_GetRenderTarget()

SDL_Texture* SDL_GetRenderTarget ( SDL_Renderer renderer)

Get the current render target or NULL for the default render target.

Returns
The current render target
See also
SDL_SetRenderTarget()

Definition at line 1287 of file SDL_render.c.

1288 {
1289  return renderer->target;
1290 }

References renderer, and SDL_Renderer::target.

Referenced by SDL_RendererEventWatch().

◆ SDL_GetTextureAlphaMod()

int SDL_GetTextureAlphaMod ( SDL_Texture texture,
Uint8 alpha 
)

Get the additional alpha value used in render copy operations.

Parameters
textureThe texture to query.
alphaA pointer filled in with the current alpha value.
Returns
0 on success, or -1 if the texture is not valid.
See also
SDL_SetTextureAlphaMod()

Definition at line 811 of file SDL_render.c.

812 {
814 
815  if (alpha) {
816  *alpha = texture->a;
817  }
818  return 0;
819 }

References CHECK_TEXTURE_MAGIC.

◆ SDL_GetTextureBlendMode()

int SDL_GetTextureBlendMode ( SDL_Texture texture,
SDL_BlendMode blendMode 
)

Get the blend mode used for texture copy operations.

Parameters
textureThe texture to query.
blendModeA pointer filled in with the current blend mode.
Returns
0 on success, or -1 if the texture is not valid.
See also
SDL_SetTextureBlendMode()

Definition at line 843 of file SDL_render.c.

844 {
846 
847  if (blendMode) {
848  *blendMode = texture->blendMode;
849  }
850  return 0;
851 }

References blendMode, and CHECK_TEXTURE_MAGIC.

◆ SDL_GetTextureColorMod()

int SDL_GetTextureColorMod ( SDL_Texture texture,
Uint8 r,
Uint8 g,
Uint8 b 
)

Get the additional color value used in render copy operations.

Parameters
textureThe texture to query.
rA pointer filled in with the current red color value.
gA pointer filled in with the current green color value.
bA pointer filled in with the current blue color value.
Returns
0 on success, or -1 if the texture is not valid.
See also
SDL_SetTextureColorMod()

Definition at line 770 of file SDL_render.c.

772 {
774 
775  if (r) {
776  *r = texture->r;
777  }
778  if (g) {
779  *g = texture->g;
780  }
781  if (b) {
782  *b = texture->b;
783  }
784  return 0;
785 }

References CHECK_TEXTURE_MAGIC.

◆ SDL_GL_BindTexture()

int 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.

Parameters
textureThe SDL texture to bind
texwA pointer to a float that will be filled with the texture width
texhA pointer to a float that will be filled with the texture height
Returns
0 on success, or -1 if the operation is not supported

Definition at line 2152 of file SDL_render.c.

2153 {
2155 
2157  renderer = texture->renderer;
2158  if (texture->native) {
2159  return SDL_GL_BindTexture(texture->native, texw, texh);
2160  } else if (renderer && renderer->GL_BindTexture) {
2161  return renderer->GL_BindTexture(renderer, texture, texw, texh);
2162  } else {
2163  return SDL_Unsupported();
2164  }
2165 }

References CHECK_TEXTURE_MAGIC, SDL_Renderer::GL_BindTexture, renderer, and SDL_Unsupported.

◆ SDL_GL_UnbindTexture()

int SDL_GL_UnbindTexture ( SDL_Texture texture)

Unbind a texture from the current OpenGL/ES/ES2 context.

Parameters
textureThe SDL texture to unbind
Returns
0 on success, or -1 if the operation is not supported

Definition at line 2167 of file SDL_render.c.

2168 {
2170 
2172  renderer = texture->renderer;
2173  if (texture->native) {
2174  return SDL_GL_UnbindTexture(texture->native);
2175  } else if (renderer && renderer->GL_UnbindTexture) {
2177  }
2178 
2179  return SDL_Unsupported();
2180 }

References CHECK_TEXTURE_MAGIC, SDL_Renderer::GL_UnbindTexture, renderer, and SDL_Unsupported.

◆ SDL_LockTexture()

int SDL_LockTexture ( SDL_Texture texture,
const SDL_Rect rect,
void **  pixels,
int *  pitch 
)

Lock a portion of the texture for write-only pixel access.

Parameters
textureThe texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
rectA pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
pixelsThis is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
pitchThis is filled in with the pitch of the locked pixels.
Returns
0 on success, or -1 if the texture is not valid or was not created with SDL_TEXTUREACCESS_STREAMING.
See also
SDL_UnlockTexture()

Definition at line 1108 of file SDL_render.c.

1110 {
1112  SDL_Rect full_rect;
1113 
1115 
1116  if (texture->access != SDL_TEXTUREACCESS_STREAMING) {
1117  return SDL_SetError("SDL_LockTexture(): texture must be streaming");
1118  }
1119 
1120  if (!rect) {
1121  full_rect.x = 0;
1122  full_rect.y = 0;
1123  full_rect.w = texture->w;
1124  full_rect.h = texture->h;
1125  rect = &full_rect;
1126  }
1127 
1128  if (texture->yuv) {
1129  return SDL_LockTextureYUV(texture, rect, pixels, pitch);
1130  } else if (texture->native) {
1131  return SDL_LockTextureNative(texture, rect, pixels, pitch);
1132  } else {
1133  renderer = texture->renderer;
1134  return renderer->LockTexture(renderer, texture, rect, pixels, pitch);
1135  }
1136 }

References CHECK_TEXTURE_MAGIC, SDL_Rect::h, SDL_Renderer::LockTexture, rect, renderer, SDL_LockTextureNative(), SDL_LockTextureYUV(), SDL_SetError, SDL_TEXTUREACCESS_STREAMING, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_UnlockTextureNative(), SDL_UnlockTextureYUV(), SDL_UpdateTextureNative(), SDL_UpdateTextureYUV(), and SDL_UpdateTextureYUVPlanar().

◆ SDL_QueryTexture()

int SDL_QueryTexture ( SDL_Texture texture,
Uint32 format,
int *  access,
int *  w,
int *  h 
)

Query the attributes of a texture.

Parameters
textureA texture to be queried.
formatA pointer filled in with the raw format of the texture. The actual format may differ, but pixel transfers will use this format.
accessA pointer filled in with the actual access to the texture.
wA pointer filled in with the width of the texture in pixels.
hA pointer filled in with the height of the texture in pixels.
Returns
0 on success, or -1 if the texture is not valid.

Definition at line 724 of file SDL_render.c.

726 {
728 
729  if (format) {
730  *format = texture->format;
731  }
732  if (access) {
733  *access = texture->access;
734  }
735  if (w) {
736  *w = texture->w;
737  }
738  if (h) {
739  *h = texture->h;
740  }
741  return 0;
742 }

References CHECK_TEXTURE_MAGIC.

Referenced by SDL_GetRendererOutputSize().

◆ SDL_RenderClear()

int SDL_RenderClear ( SDL_Renderer renderer)

Clear the current rendering target with the drawing color.

This function clears the entire rendering target, ignoring the viewport and the clip rectangle.

Returns
0 on success, or -1 on error

Definition at line 1602 of file SDL_render.c.

1603 {
1605 
1606  /* Don't draw while we're hidden */
1607  if (renderer->hidden) {
1608  return 0;
1609  }
1610  return renderer->RenderClear(renderer);
1611 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, SDL_Renderer::RenderClear, and renderer.

◆ SDL_RenderCopy()

int 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.

Parameters
rendererThe renderer which should copy parts of a texture.
textureThe source texture.
srcrectA pointer to the source rectangle, or NULL for the entire texture.
dstrectA pointer to the destination rectangle, or NULL for the entire rendering target.
Returns
0 on success, or -1 on error

Definition at line 1916 of file SDL_render.c.

1918 {
1919  SDL_Rect real_srcrect = { 0, 0, 0, 0 };
1920  SDL_Rect real_dstrect = { 0, 0, 0, 0 };
1921  SDL_FRect frect;
1922 
1925 
1926  if (renderer != texture->renderer) {
1927  return SDL_SetError("Texture was not created with this renderer");
1928  }
1929 
1930  /* Don't draw while we're hidden */
1931  if (renderer->hidden) {
1932  return 0;
1933  }
1934 
1935  real_srcrect.x = 0;
1936  real_srcrect.y = 0;
1937  real_srcrect.w = texture->w;
1938  real_srcrect.h = texture->h;
1939  if (srcrect) {
1940  if (!SDL_IntersectRect(srcrect, &real_srcrect, &real_srcrect)) {
1941  return 0;
1942  }
1943  }
1944 
1945  SDL_RenderGetViewport(renderer, &real_dstrect);
1946  real_dstrect.x = 0;
1947  real_dstrect.y = 0;
1948  if (dstrect) {
1949  if (!SDL_HasIntersection(dstrect, &real_dstrect)) {
1950  return 0;
1951  }
1952  real_dstrect = *dstrect;
1953  }
1954 
1955  if (texture->native) {
1956  texture = texture->native;
1957  }
1958 
1959  frect.x = real_dstrect.x * renderer->scale.x;
1960  frect.y = real_dstrect.y * renderer->scale.y;
1961  frect.w = real_dstrect.w * renderer->scale.x;
1962  frect.h = real_dstrect.h * renderer->scale.y;
1963 
1964  return renderer->RenderCopy(renderer, texture, &real_srcrect, &frect);
1965 }

References CHECK_RENDERER_MAGIC, CHECK_TEXTURE_MAGIC, SDL_Rect::h, SDL_FRect::h, SDL_Renderer::hidden, SDL_Renderer::RenderCopy, renderer, SDL_Renderer::scale, SDL_HasIntersection, SDL_IntersectRect, SDL_RenderGetViewport(), SDL_SetError, SDL_Rect::w, SDL_FRect::w, SDL_Rect::x, SDL_FPoint::x, SDL_FRect::x, SDL_Rect::y, SDL_FPoint::y, and SDL_FRect::y.

Referenced by SDL_RenderCopyEx().

◆ SDL_RenderCopyEx()

int 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 given center.

Parameters
rendererThe renderer which should copy parts of a texture.
textureThe source texture.
srcrectA pointer to the source rectangle, or NULL for the entire texture.
dstrectA pointer to the destination rectangle, or NULL for the entire rendering target.
angleAn angle in degrees that indicates the rotation that will be applied to dstrect, rotating it in a clockwise direction
centerA pointer to a point indicating the point around which dstrect will be rotated (if NULL, rotation will be done around dstrect.w/2, dstrect.h/2).
flipAn SDL_RendererFlip value stating which flipping actions should be performed on the texture
Returns
0 on success, or -1 on error

Definition at line 1969 of file SDL_render.c.

1972 {
1973  SDL_Rect real_srcrect = { 0, 0, 0, 0 };
1974  SDL_Rect real_dstrect = { 0, 0, 0, 0 };
1975  SDL_Point real_center;
1976  SDL_FRect frect;
1977  SDL_FPoint fcenter;
1978 
1979  if (flip == SDL_FLIP_NONE && (int)(angle/360) == angle/360) { /* fast path when we don't need rotation or flipping */
1980  return SDL_RenderCopy(renderer, texture, srcrect, dstrect);
1981  }
1982 
1985 
1986  if (renderer != texture->renderer) {
1987  return SDL_SetError("Texture was not created with this renderer");
1988  }
1989  if (!renderer->RenderCopyEx) {
1990  return SDL_SetError("Renderer does not support RenderCopyEx");
1991  }
1992 
1993  /* Don't draw while we're hidden */
1994  if (renderer->hidden) {
1995  return 0;
1996  }
1997 
1998  real_srcrect.x = 0;
1999  real_srcrect.y = 0;
2000  real_srcrect.w = texture->w;
2001  real_srcrect.h = texture->h;
2002  if (srcrect) {
2003  if (!SDL_IntersectRect(srcrect, &real_srcrect, &real_srcrect)) {
2004  return 0;
2005  }
2006  }
2007 
2008  /* We don't intersect the dstrect with the viewport as RenderCopy does because of potential rotation clipping issues... TODO: should we? */
2009  if (dstrect) {
2010  real_dstrect = *dstrect;
2011  } else {
2012  SDL_RenderGetViewport(renderer, &real_dstrect);
2013  real_dstrect.x = 0;
2014  real_dstrect.y = 0;
2015  }
2016 
2017  if (texture->native) {
2018  texture = texture->native;
2019  }
2020 
2021  if (center) {
2022  real_center = *center;
2023  } else {
2024  real_center.x = real_dstrect.w/2;
2025  real_center.y = real_dstrect.h/2;
2026  }
2027 
2028  frect.x = real_dstrect.x * renderer->scale.x;
2029  frect.y = real_dstrect.y * renderer->scale.y;
2030  frect.w = real_dstrect.w * renderer->scale.x;
2031  frect.h = real_dstrect.h * renderer->scale.y;
2032 
2033  fcenter.x = real_center.x * renderer->scale.x;
2034  fcenter.y = real_center.y * renderer->scale.y;
2035 
2036  return renderer->RenderCopyEx(renderer, texture, &real_srcrect, &frect, angle, &fcenter, flip);
2037 }

References CHECK_RENDERER_MAGIC, CHECK_TEXTURE_MAGIC, SDL_Rect::h, SDL_FRect::h, SDL_Renderer::hidden, SDL_Renderer::RenderCopyEx, renderer, SDL_Renderer::scale, SDL_FLIP_NONE, SDL_IntersectRect, SDL_RenderCopy(), SDL_RenderGetViewport(), SDL_SetError, SDL_Rect::w, SDL_FRect::w, SDL_Point::x, SDL_Rect::x, SDL_FPoint::x, SDL_FRect::x, SDL_Point::y, SDL_Rect::y, SDL_FPoint::y, and SDL_FRect::y.

◆ SDL_RenderDrawLine()

int SDL_RenderDrawLine ( SDL_Renderer renderer,
int  x1,
int  y1,
int  x2,
int  y2 
)

Draw a line on the current rendering target.

Parameters
rendererThe renderer which should draw a line.
x1The x coordinate of the start point.
y1The y coordinate of the start point.
x2The x coordinate of the end point.
y2The y coordinate of the end point.
Returns
0 on success, or -1 on error

Definition at line 1692 of file SDL_render.c.

1693 {
1694  SDL_Point points[2];
1695 
1696  points[0].x = x1;
1697  points[0].y = y1;
1698  points[1].x = x2;
1699  points[1].y = y2;
1700  return SDL_RenderDrawLines(renderer, points, 2);
1701 }

References renderer, SDL_RenderDrawLines(), and SDL_Point::x.

◆ SDL_RenderDrawLines()

int SDL_RenderDrawLines ( SDL_Renderer renderer,
const SDL_Point points,
int  count 
)

Draw a series of connected lines on the current rendering target.

Parameters
rendererThe renderer which should draw multiple lines.
pointsThe points along the lines
countThe number of points, drawing count-1 lines
Returns
0 on success, or -1 on error

Definition at line 1760 of file SDL_render.c.

1762 {
1763  SDL_FPoint *fpoints;
1764  int i;
1765  int status;
1766 
1768 
1769  if (!points) {
1770  return SDL_SetError("SDL_RenderDrawLines(): Passed NULL points");
1771  }
1772  if (count < 2) {
1773  return 0;
1774  }
1775 
1776  /* Don't draw while we're hidden */
1777  if (renderer->hidden) {
1778  return 0;
1779  }
1780 
1781  if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
1783  }
1784 
1785  fpoints = SDL_stack_alloc(SDL_FPoint, count);
1786  if (!fpoints) {
1787  return SDL_OutOfMemory();
1788  }
1789  for (i = 0; i < count; ++i) {
1790  fpoints[i].x = points[i].x * renderer->scale.x;
1791  fpoints[i].y = points[i].y * renderer->scale.y;
1792  }
1793 
1794  status = renderer->RenderDrawLines(renderer, fpoints, count);
1795 
1796  SDL_stack_free(fpoints);
1797 
1798  return status;
1799 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, i, SDL_Renderer::RenderDrawLines, RenderDrawLinesWithRects(), renderer, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_stack_alloc, SDL_stack_free, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_RenderDrawLine(), and SDL_RenderDrawRect().

◆ SDL_RenderDrawPoint()

int SDL_RenderDrawPoint ( SDL_Renderer renderer,
int  x,
int  y 
)

Draw a point on the current rendering target.

Parameters
rendererThe renderer which should draw a point.
xThe x coordinate of the point.
yThe y coordinate of the point.
Returns
0 on success, or -1 on error

Definition at line 1614 of file SDL_render.c.

1615 {
1616  SDL_Point point;
1617 
1618  point.x = x;
1619  point.y = y;
1620  return SDL_RenderDrawPoints(renderer, &point, 1);
1621 }

References renderer, SDL_RenderDrawPoints(), SDL_Point::x, and SDL_Point::y.

◆ SDL_RenderDrawPoints()

int SDL_RenderDrawPoints ( SDL_Renderer renderer,
const SDL_Point points,
int  count 
)

Draw multiple points on the current rendering target.

Parameters
rendererThe renderer which should draw multiple points.
pointsThe points to draw
countThe number of points to draw
Returns
0 on success, or -1 on error

Definition at line 1650 of file SDL_render.c.

1652 {
1653  SDL_FPoint *fpoints;
1654  int i;
1655  int status;
1656 
1658 
1659  if (!points) {
1660  return SDL_SetError("SDL_RenderDrawPoints(): Passed NULL points");
1661  }
1662  if (count < 1) {
1663  return 0;
1664  }
1665 
1666  /* Don't draw while we're hidden */
1667  if (renderer->hidden) {
1668  return 0;
1669  }
1670 
1671  if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
1673  }
1674 
1675  fpoints = SDL_stack_alloc(SDL_FPoint, count);
1676  if (!fpoints) {
1677  return SDL_OutOfMemory();
1678  }
1679  for (i = 0; i < count; ++i) {
1680  fpoints[i].x = points[i].x * renderer->scale.x;
1681  fpoints[i].y = points[i].y * renderer->scale.y;
1682  }
1683 
1684  status = renderer->RenderDrawPoints(renderer, fpoints, count);
1685 
1686  SDL_stack_free(fpoints);
1687 
1688  return status;
1689 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, i, SDL_Renderer::RenderDrawPoints, RenderDrawPointsWithRects(), renderer, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_stack_alloc, SDL_stack_free, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_RenderDrawPoint().

◆ SDL_RenderDrawRect()

int SDL_RenderDrawRect ( SDL_Renderer renderer,
const SDL_Rect rect 
)

Draw a rectangle on the current rendering target.

Parameters
rendererThe renderer which should draw a rectangle.
rectA pointer to the destination rectangle, or NULL to outline the entire rendering target.
Returns
0 on success, or -1 on error

Definition at line 1802 of file SDL_render.c.

1803 {
1804  SDL_Rect full_rect;
1805  SDL_Point points[5];
1806 
1808 
1809  /* If 'rect' == NULL, then outline the whole surface */
1810  if (!rect) {
1811  SDL_RenderGetViewport(renderer, &full_rect);
1812  full_rect.x = 0;
1813  full_rect.y = 0;
1814  rect = &full_rect;
1815  }
1816 
1817  points[0].x = rect->x;
1818  points[0].y = rect->y;
1819  points[1].x = rect->x+rect->w-1;
1820  points[1].y = rect->y;
1821  points[2].x = rect->x+rect->w-1;
1822  points[2].y = rect->y+rect->h-1;
1823  points[3].x = rect->x;
1824  points[3].y = rect->y+rect->h-1;
1825  points[4].x = rect->x;
1826  points[4].y = rect->y;
1827  return SDL_RenderDrawLines(renderer, points, 5);
1828 }

References CHECK_RENDERER_MAGIC, SDL_Rect::h, rect, renderer, SDL_RenderDrawLines(), SDL_RenderGetViewport(), SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_RenderDrawRects().

◆ SDL_RenderDrawRects()

int SDL_RenderDrawRects ( SDL_Renderer renderer,
const SDL_Rect rects,
int  count 
)

Draw some number of rectangles on the current rendering target.

Parameters
rendererThe renderer which should draw multiple rectangles.
rectsA pointer to an array of destination rectangles.
countThe number of rectangles.
Returns
0 on success, or -1 on error

Definition at line 1831 of file SDL_render.c.

1833 {
1834  int i;
1835 
1837 
1838  if (!rects) {
1839  return SDL_SetError("SDL_RenderDrawRects(): Passed NULL rects");
1840  }
1841  if (count < 1) {
1842  return 0;
1843  }
1844 
1845  /* Don't draw while we're hidden */
1846  if (renderer->hidden) {
1847  return 0;
1848  }
1849 
1850  for (i = 0; i < count; ++i) {
1851  if (SDL_RenderDrawRect(renderer, &rects[i]) < 0) {
1852  return -1;
1853  }
1854  }
1855  return 0;
1856 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, i, renderer, SDL_RenderDrawRect(), and SDL_SetError.

◆ SDL_RenderFillRect()

int SDL_RenderFillRect ( SDL_Renderer renderer,
const SDL_Rect rect 
)

Fill a rectangle on the current rendering target with the drawing color.

Parameters
rendererThe renderer which should fill a rectangle.
rectA pointer to the destination rectangle, or NULL for the entire rendering target.
Returns
0 on success, or -1 on error

Definition at line 1859 of file SDL_render.c.

1860 {
1861  SDL_Rect full_rect = { 0, 0, 0, 0 };
1862 
1864 
1865  /* If 'rect' == NULL, then outline the whole surface */
1866  if (!rect) {
1867  SDL_RenderGetViewport(renderer, &full_rect);
1868  full_rect.x = 0;
1869  full_rect.y = 0;
1870  rect = &full_rect;
1871  }
1872  return SDL_RenderFillRects(renderer, rect, 1);
1873 }

References CHECK_RENDERER_MAGIC, rect, renderer, SDL_RenderFillRects(), SDL_RenderGetViewport(), SDL_Rect::x, and SDL_Rect::y.

◆ SDL_RenderFillRects()

int 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.

Parameters
rendererThe renderer which should fill multiple rectangles.
rectsA pointer to an array of destination rectangles.
countThe number of rectangles.
Returns
0 on success, or -1 on error

Definition at line 1876 of file SDL_render.c.

1878 {
1879  SDL_FRect *frects;
1880  int i;
1881  int status;
1882 
1884 
1885  if (!rects) {
1886  return SDL_SetError("SDL_RenderFillRects(): Passed NULL rects");
1887  }
1888  if (count < 1) {
1889  return 0;
1890  }
1891 
1892  /* Don't draw while we're hidden */
1893  if (renderer->hidden) {
1894  return 0;
1895  }
1896 
1897  frects = SDL_stack_alloc(SDL_FRect, count);
1898  if (!frects) {
1899  return SDL_OutOfMemory();
1900  }
1901  for (i = 0; i < count; ++i) {
1902  frects[i].x = rects[i].x * renderer->scale.x;
1903  frects[i].y = rects[i].y * renderer->scale.y;
1904  frects[i].w = rects[i].w * renderer->scale.x;
1905  frects[i].h = rects[i].h * renderer->scale.y;
1906  }
1907 
1908  status = renderer->RenderFillRects(renderer, frects, count);
1909 
1910  SDL_stack_free(frects);
1911 
1912  return status;
1913 }

References CHECK_RENDERER_MAGIC, SDL_FRect::h, SDL_Renderer::hidden, i, renderer, SDL_Renderer::RenderFillRects, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_stack_alloc, SDL_stack_free, SDL_FRect::w, SDL_FPoint::x, SDL_FRect::x, SDL_FPoint::y, and SDL_FRect::y.

Referenced by SDL_RenderFillRect().

◆ SDL_RenderGetClipRect()

void SDL_RenderGetClipRect ( SDL_Renderer renderer,
SDL_Rect rect 
)

Get the clip rectangle for the current target.

Parameters
rendererThe renderer from which clip rectangle should be queried.
rectA pointer filled in with the current clip rectangle, or an empty rectangle if clipping is disabled.
See also
SDL_RenderSetClipRect()

Definition at line 1504 of file SDL_render.c.

1505 {
1507 
1508  if (rect) {
1509  rect->x = (int)(renderer->clip_rect.x / renderer->scale.x);
1510  rect->y = (int)(renderer->clip_rect.y / renderer->scale.y);
1511  rect->w = (int)(renderer->clip_rect.w / renderer->scale.x);
1512  rect->h = (int)(renderer->clip_rect.h / renderer->scale.y);
1513  }
1514 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::clip_rect, SDL_Rect::h, rect, renderer, SDL_Renderer::scale, SDL_Rect::w, SDL_Rect::x, SDL_FPoint::x, SDL_Rect::y, and SDL_FPoint::y.

◆ SDL_RenderGetIntegerScale()

SDL_bool SDL_RenderGetIntegerScale ( SDL_Renderer renderer)

Get whether integer scales are forced for resolution-independent rendering.

Parameters
rendererThe renderer from which integer scaling should be queried.
See also
SDL_RenderSetIntegerScale()

Definition at line 1445 of file SDL_render.c.

1446 {
1448 
1449  return renderer->integer_scale;
1450 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::integer_scale, renderer, and SDL_FALSE.

◆ SDL_RenderGetLogicalSize()

void SDL_RenderGetLogicalSize ( SDL_Renderer renderer,
int *  w,
int *  h 
)

Get device independent resolution for rendering.

Parameters
rendererThe renderer from which resolution should be queried.
wA pointer filled with the width of the logical resolution
hA pointer filled with the height of the logical resolution
See also
SDL_RenderSetLogicalSize()

Definition at line 1422 of file SDL_render.c.

1423 {
1425 
1426  if (w) {
1427  *w = renderer->logical_w;
1428  }
1429  if (h) {
1430  *h = renderer->logical_h;
1431  }
1432 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::logical_h, SDL_Renderer::logical_w, and renderer.

◆ SDL_RenderGetMetalCommandEncoder()

void* SDL_RenderGetMetalCommandEncoder ( SDL_Renderer renderer)

Get the Metal command encoder for the current frame.

Parameters
rendererThe renderer to query
Returns
id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer
See also
SDL_RenderGetMetalLayer()

Definition at line 2194 of file SDL_render.c.

2195 {
2197 
2200  }
2201  return NULL;
2202 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::GetMetalCommandEncoder, NULL, and renderer.

◆ SDL_RenderGetMetalLayer()

void* SDL_RenderGetMetalLayer ( SDL_Renderer renderer)

Get the CAMetalLayer associated with the given Metal renderer.

Parameters
rendererThe renderer to query
Returns
CAMetalLayer* on success, or NULL if the renderer isn't a Metal renderer
See also
SDL_RenderGetMetalCommandEncoder()

Definition at line 2183 of file SDL_render.c.

2184 {
2186 
2187  if (renderer->GetMetalLayer) {
2188  return renderer->GetMetalLayer(renderer);
2189  }
2190  return NULL;
2191 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::GetMetalLayer, NULL, and renderer.

◆ SDL_RenderGetScale()

void SDL_RenderGetScale ( SDL_Renderer renderer,
float *  scaleX,
float *  scaleY 
)

Get the drawing scale for the current target.

Parameters
rendererThe renderer from which drawing scale should be queried.
scaleXA pointer filled in with the horizontal scaling factor
scaleYA pointer filled in with the vertical scaling factor
See also
SDL_RenderSetScale()

Definition at line 1534 of file SDL_render.c.

1535 {
1537 
1538  if (scaleX) {
1539  *scaleX = renderer->scale.x;
1540  }
1541  if (scaleY) {
1542  *scaleY = renderer->scale.y;
1543  }
1544 }

References CHECK_RENDERER_MAGIC, renderer, SDL_Renderer::scale, SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_RenderGetViewport()

void SDL_RenderGetViewport ( SDL_Renderer renderer,
SDL_Rect rect 
)

Get the drawing area for the current target.

See also
SDL_RenderSetViewport()

Definition at line 1473 of file SDL_render.c.

1474 {
1476 
1477  if (rect) {
1478  rect->x = (int)(renderer->viewport.x / renderer->scale.x);
1479  rect->y = (int)(renderer->viewport.y / renderer->scale.y);
1480  rect->w = (int)(renderer->viewport.w / renderer->scale.x);
1481  rect->h = (int)(renderer->viewport.h / renderer->scale.y);
1482  }
1483 }

References CHECK_RENDERER_MAGIC, SDL_Rect::h, rect, renderer, SDL_Renderer::scale, SDL_Renderer::viewport, SDL_Rect::w, SDL_Rect::x, SDL_FPoint::x, SDL_Rect::y, and SDL_FPoint::y.

Referenced by SDL_RenderCopy(), SDL_RenderCopyEx(), SDL_RenderDrawRect(), and SDL_RenderFillRect().

◆ SDL_RenderIsClipEnabled()

SDL_bool SDL_RenderIsClipEnabled ( SDL_Renderer renderer)

Get whether clipping is enabled on the given renderer.

Parameters
rendererThe renderer from which clip state should be queried.
See also
SDL_RenderGetClipRect()

Definition at line 1517 of file SDL_render.c.

1518 {
1520  return renderer->clipping_enabled;
1521 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::clipping_enabled, renderer, and SDL_FALSE.

◆ SDL_RenderPresent()

void SDL_RenderPresent ( SDL_Renderer renderer)

Update the screen with rendering performed.

Definition at line 2077 of file SDL_render.c.

2078 {
2080 
2081  /* Don't draw while we're hidden */
2082  if (renderer->hidden) {
2083  return;
2084  }
2086 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, renderer, and SDL_Renderer::RenderPresent.

◆ SDL_RenderReadPixels()

int SDL_RenderReadPixels ( SDL_Renderer renderer,
const SDL_Rect rect,
Uint32  format,
void pixels,
int  pitch 
)

Read pixels from the current rendering target.

Parameters
rendererThe renderer from which pixels should be read.
rectA pointer to the rectangle to read, or NULL for the entire render target.
formatThe desired format of the pixel data, or 0 to use the format of the rendering target
pixelsA pointer to be filled in with the pixel data
pitchThe pitch of the pixels parameter.
Returns
0 on success, or -1 if pixel reading is not supported.
Warning
This is a very slow operation, and should not be used frequently.

Definition at line 2040 of file SDL_render.c.

2042 {
2043  SDL_Rect real_rect;
2044 
2046 
2047  if (!renderer->RenderReadPixels) {
2048  return SDL_Unsupported();
2049  }
2050 
2051  if (!format) {
2053  }
2054 
2055  real_rect.x = renderer->viewport.x;
2056  real_rect.y = renderer->viewport.y;
2057  real_rect.w = renderer->viewport.w;
2058  real_rect.h = renderer->viewport.h;
2059  if (rect) {
2060  if (!SDL_IntersectRect(rect, &real_rect, &real_rect)) {
2061  return 0;
2062  }
2063  if (real_rect.y > rect->y) {
2064  pixels = (Uint8 *)pixels + pitch * (real_rect.y - rect->y);
2065  }
2066  if (real_rect.x > rect->x) {
2067  int bpp = SDL_BYTESPERPIXEL(format);
2068  pixels = (Uint8 *)pixels + bpp * (real_rect.x - rect->x);
2069  }
2070  }
2071 
2072  return renderer->RenderReadPixels(renderer, &real_rect,
2073  format, pixels, pitch);
2074 }

References CHECK_RENDERER_MAGIC, SDL_Rect::h, rect, renderer, SDL_Renderer::RenderReadPixels, SDL_BYTESPERPIXEL, SDL_GetWindowPixelFormat, SDL_IntersectRect, SDL_Unsupported, SDL_Renderer::viewport, SDL_Rect::w, SDL_Renderer::window, SDL_Rect::x, and SDL_Rect::y.

◆ SDL_RenderSetClipRect()

int SDL_RenderSetClipRect ( SDL_Renderer renderer,
const SDL_Rect rect 
)

Set the clip rectangle for the current target.

Parameters
rendererThe renderer for which clip rectangle should be set.
rectA pointer to the rectangle to set as the clip rectangle, or NULL to disable clipping.
Returns
0 on success, or -1 on error
See also
SDL_RenderGetClipRect()

Definition at line 1486 of file SDL_render.c.

1487 {
1489 
1490  if (rect) {
1494  renderer->clip_rect.w = (int)SDL_ceil(rect->w * renderer->scale.x);
1495  renderer->clip_rect.h = (int)SDL_ceil(rect->h * renderer->scale.y);
1496  } else {
1499  }
1500  return renderer->UpdateClipRect(renderer);
1501 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::clip_rect, SDL_Renderer::clipping_enabled, SDL_Rect::h, rect, renderer, SDL_Renderer::scale, SDL_ceil, SDL_FALSE, SDL_floor, SDL_TRUE, SDL_zero, SDL_Renderer::UpdateClipRect, SDL_Rect::w, SDL_Rect::x, SDL_FPoint::x, SDL_Rect::y, and SDL_FPoint::y.

◆ SDL_RenderSetIntegerScale()

int SDL_RenderSetIntegerScale ( SDL_Renderer renderer,
SDL_bool  enable 
)

Set whether to force integer scales for resolution-independent rendering.

Parameters
rendererThe renderer for which integer scaling should be set.
enableEnable or disable integer scaling

This function restricts the logical viewport to integer values - that is, when a resolution is between two multiples of a logical size, the viewport size is rounded down to the lower multiple.

See also
SDL_RenderSetLogicalSize()

Definition at line 1435 of file SDL_render.c.

1436 {
1438 
1440 
1441  return UpdateLogicalSize(renderer);
1442 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::integer_scale, renderer, and UpdateLogicalSize().

◆ SDL_RenderSetLogicalSize()

int SDL_RenderSetLogicalSize ( SDL_Renderer renderer,
int  w,
int  h 
)

Set device independent resolution for rendering.

Parameters
rendererThe renderer for which resolution should be set.
wThe width of the logical resolution
hThe height of the logical resolution

This function uses the viewport and scaling functionality to allow a fixed logical resolution for rendering, regardless of the actual output resolution. If the actual output resolution doesn't have the same aspect ratio the output rendering will be centered within the output display.

If the output display is a window, mouse events in the window will be filtered and scaled so they seem to arrive within the logical resolution.

Note
If this function results in scaling or subpixel drawing by the rendering backend, it will be handled using the appropriate quality hints.
See also
SDL_RenderGetLogicalSize()
SDL_RenderSetScale()
SDL_RenderSetViewport()

Definition at line 1402 of file SDL_render.c.

1403 {
1405 
1406  if (!w || !h) {
1407  /* Clear any previous logical resolution */
1408  renderer->logical_w = 0;
1409  renderer->logical_h = 0;
1411  SDL_RenderSetScale(renderer, 1.0f, 1.0f);
1412  return 0;
1413  }
1414 
1415  renderer->logical_w = w;
1416  renderer->logical_h = h;
1417 
1418  return UpdateLogicalSize(renderer);
1419 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::logical_h, SDL_Renderer::logical_w, NULL, renderer, SDL_RenderSetScale(), SDL_RenderSetViewport(), and UpdateLogicalSize().

◆ SDL_RenderSetScale()

int SDL_RenderSetScale ( SDL_Renderer renderer,
float  scaleX,
float  scaleY 
)

Set the drawing scale for rendering on the current target.

Parameters
rendererThe renderer for which the drawing scale should be set.
scaleXThe horizontal scaling factor
scaleYThe vertical scaling factor

The drawing coordinates are scaled by the x/y scaling factors before they are used by the renderer. This allows resolution independent drawing with a single coordinate system.

Note
If this results in scaling or subpixel drawing by the rendering backend, it will be handled using the appropriate quality hints. For best results use integer scaling factors.
See also
SDL_RenderGetScale()
SDL_RenderSetLogicalSize()

Definition at line 1524 of file SDL_render.c.

1525 {
1527 
1528  renderer->scale.x = scaleX;
1529  renderer->scale.y = scaleY;
1530  return 0;
1531 }

References CHECK_RENDERER_MAGIC, renderer, SDL_Renderer::scale, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_RenderSetLogicalSize(), and UpdateLogicalSize().

◆ SDL_RenderSetViewport()

int SDL_RenderSetViewport ( SDL_Renderer renderer,
const SDL_Rect rect 
)

Set the drawing area for rendering on the current target.

Parameters
rendererThe renderer for which the drawing area should be set.
rectThe rectangle representing the drawing area, or NULL to set the viewport to the entire target.

The x,y of the viewport rect represents the origin for rendering.

Returns
0 on success, or -1 on error
Note
If the window associated with the renderer is resized, the viewport is automatically reset.
See also
SDL_RenderGetViewport()
SDL_RenderSetLogicalSize()

Definition at line 1453 of file SDL_render.c.

1454 {
1456 
1457  if (rect) {
1458  renderer->viewport.x = (int)SDL_floor(rect->x * renderer->scale.x);
1459  renderer->viewport.y = (int)SDL_floor(rect->y * renderer->scale.y);
1460  renderer->viewport.w = (int)SDL_ceil(rect->w * renderer->scale.x);
1461  renderer->viewport.h = (int)SDL_ceil(rect->h * renderer->scale.y);
1462  } else {
1463  renderer->viewport.x = 0;
1464  renderer->viewport.y = 0;
1466  return -1;
1467  }
1468  }
1469  return renderer->UpdateViewport(renderer);
1470 }

References CHECK_RENDERER_MAGIC, SDL_Rect::h, rect, renderer, SDL_Renderer::scale, SDL_ceil, SDL_floor, SDL_GetRendererOutputSize(), SDL_Renderer::UpdateViewport, SDL_Renderer::viewport, SDL_Rect::w, SDL_Rect::x, SDL_FPoint::x, SDL_Rect::y, and SDL_FPoint::y.

Referenced by SDL_CreateRenderer(), SDL_CreateSoftwareRenderer(), SDL_RenderSetLogicalSize(), and UpdateLogicalSize().

◆ SDL_RenderTargetSupported()

SDL_bool SDL_RenderTargetSupported ( SDL_Renderer renderer)

Determines whether a window supports the use of render targets.

Parameters
rendererThe renderer that will be checked
Returns
SDL_TRUE if supported, SDL_FALSE if not.

Definition at line 1201 of file SDL_render.c.

1202 {
1203  if (!renderer || !renderer->SetRenderTarget) {
1204  return SDL_FALSE;
1205  }
1206  return (renderer->info.flags & SDL_RENDERER_TARGETTEXTURE) != 0;
1207 }

References SDL_RendererInfo::flags, SDL_Renderer::info, renderer, SDL_FALSE, SDL_RENDERER_TARGETTEXTURE, and SDL_Renderer::SetRenderTarget.

Referenced by SDL_SetRenderTarget().

◆ SDL_SetRenderDrawBlendMode()

int SDL_SetRenderDrawBlendMode ( SDL_Renderer renderer,
SDL_BlendMode  blendMode 
)

Set the blend mode used for drawing operations (Fill and Line).

Parameters
rendererThe renderer for which blend mode should be set.
blendModeSDL_BlendMode to use for blending.
Returns
0 on success, or -1 on error
Note
If the blend mode is not supported, the closest supported mode is chosen.
See also
SDL_GetRenderDrawBlendMode()

Definition at line 1581 of file SDL_render.c.

1582 {
1584 
1586  return SDL_Unsupported();
1587  }
1589  return 0;
1590 }

References SDL_Renderer::blendMode, blendMode, CHECK_RENDERER_MAGIC, IsSupportedBlendMode(), renderer, and SDL_Unsupported.

◆ SDL_SetRenderDrawColor()

int SDL_SetRenderDrawColor ( SDL_Renderer renderer,
Uint8  r,
Uint8  g,
Uint8  b,
Uint8  a 
)

Set the color used for drawing operations (Rect, Line and Clear).

Parameters
rendererThe renderer for which drawing color should be set.
rThe red value used to draw on the rendering target.
gThe green value used to draw on the rendering target.
bThe blue value used to draw on the rendering target.
aThe alpha value used to draw on the rendering target, usually SDL_ALPHA_OPAQUE (255).
Returns
0 on success, or -1 on error

Definition at line 1547 of file SDL_render.c.

1549 {
1551 
1552  renderer->r = r;
1553  renderer->g = g;
1554  renderer->b = b;
1555  renderer->a = a;
1556  return 0;
1557 }

References SDL_Renderer::a, SDL_Renderer::b, CHECK_RENDERER_MAGIC, SDL_Renderer::g, SDL_Renderer::r, and renderer.

◆ SDL_SetRenderTarget()

int SDL_SetRenderTarget ( SDL_Renderer renderer,
SDL_Texture texture 
)

Set a texture as the current rendering target.

Parameters
rendererThe renderer.
textureThe targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
Returns
0 on success, or -1 on error
See also
SDL_GetRenderTarget()

Definition at line 1210 of file SDL_render.c.

1211 {
1213  return SDL_Unsupported();
1214  }
1215  if (texture == renderer->target) {
1216  /* Nothing to do! */
1217  return 0;
1218  }
1219 
1220  /* texture == NULL is valid and means reset the target to the window */
1221  if (texture) {
1223  if (renderer != texture->renderer) {
1224  return SDL_SetError("Texture was not created with this renderer");
1225  }
1226  if (texture->access != SDL_TEXTUREACCESS_TARGET) {
1227  return SDL_SetError("Texture not created with SDL_TEXTUREACCESS_TARGET");
1228  }
1229  if (texture->native) {
1230  /* Always render to the native texture */
1231  texture = texture->native;
1232  }
1233  }
1234 
1236 
1237  if (texture && !renderer->target) {
1238  /* Make a backup of the viewport */
1245  }
1246  renderer->target = texture;
1247 
1250  return -1;
1251  }
1252 
1253  if (texture) {
1254  renderer->viewport.x = 0;
1255  renderer->viewport.y = 0;
1256  renderer->viewport.w = texture->w;
1257  renderer->viewport.h = texture->h;
1260  renderer->scale.x = 1.0f;
1261  renderer->scale.y = 1.0f;
1262  renderer->logical_w = texture->w;
1263  renderer->logical_h = texture->h;
1264  } else {
1271  }
1272 
1274 
1275  if (renderer->UpdateViewport(renderer) < 0) {
1276  return -1;
1277  }
1278  if (renderer->UpdateClipRect(renderer) < 0) {
1279  return -1;
1280  }
1281 
1282  /* All set! */
1283  return 0;
1284 }

References CHECK_TEXTURE_MAGIC, SDL_Renderer::clip_rect, SDL_Renderer::clip_rect_backup, SDL_Renderer::clipping_enabled, SDL_Renderer::clipping_enabled_backup, SDL_Rect::h, SDL_Renderer::logical_h, SDL_Renderer::logical_h_backup, SDL_Renderer::logical_w, SDL_Renderer::logical_w_backup, renderer, SDL_Renderer::scale, SDL_Renderer::scale_backup, SDL_FALSE, SDL_LockMutex, SDL_RenderTargetSupported(), SDL_SetError, SDL_TEXTUREACCESS_TARGET, SDL_UnlockMutex, SDL_Unsupported, SDL_zero, SDL_Renderer::SetRenderTarget, SDL_Renderer::target, SDL_Renderer::target_mutex, SDL_Renderer::UpdateClipRect, SDL_Renderer::UpdateViewport, SDL_Renderer::viewport, SDL_Renderer::viewport_backup, SDL_Rect::w, SDL_Rect::x, SDL_FPoint::x, SDL_Rect::y, and SDL_FPoint::y.

Referenced by SDL_DestroyTexture(), and SDL_RendererEventWatch().

◆ SDL_SetTextureAlphaMod()

int SDL_SetTextureAlphaMod ( SDL_Texture texture,
Uint8  alpha 
)

Set an additional alpha value used in render copy operations.

Parameters
textureThe texture to update.
alphaThe alpha value multiplied into copy operations.
Returns
0 on success, or -1 if the texture is not valid or alpha modulation is not supported.
See also
SDL_GetTextureAlphaMod()

Definition at line 788 of file SDL_render.c.

789 {
791 
793 
794  renderer = texture->renderer;
795  if (alpha < 255) {
797  } else {
798  texture->modMode &= ~SDL_TEXTUREMODULATE_ALPHA;
799  }
800  texture->a = alpha;
801  if (texture->native) {
802  return SDL_SetTextureAlphaMod(texture->native, alpha);
803  } else if (renderer->SetTextureAlphaMod) {
805  } else {
806  return 0;
807  }
808 }

References CHECK_TEXTURE_MAGIC, renderer, SDL_TEXTUREMODULATE_ALPHA, and SDL_Renderer::SetTextureAlphaMod.

Referenced by SDL_CreateTextureFromSurface().

◆ SDL_SetTextureBlendMode()

int SDL_SetTextureBlendMode ( SDL_Texture texture,
SDL_BlendMode  blendMode 
)

Set the blend mode used for texture copy operations.

Parameters
textureThe texture to update.
blendModeSDL_BlendMode to use for texture blending.
Returns
0 on success, or -1 if the texture is not valid or the blend mode is not supported.
Note
If the blend mode is not supported, the closest supported mode is chosen.
See also
SDL_GetTextureBlendMode()

Definition at line 822 of file SDL_render.c.

823 {
825 
827 
828  renderer = texture->renderer;
830  return SDL_Unsupported();
831  }
832  texture->blendMode = blendMode;
833  if (texture->native) {
834  return SDL_SetTextureBlendMode(texture->native, blendMode);
835  } else if (renderer->SetTextureBlendMode) {
837  } else {
838  return 0;
839  }
840 }

References blendMode, CHECK_TEXTURE_MAGIC, IsSupportedBlendMode(), renderer, SDL_Unsupported, and SDL_Renderer::SetTextureBlendMode.

Referenced by SDL_CreateTextureFromSurface().

◆ SDL_SetTextureColorMod()

int SDL_SetTextureColorMod ( SDL_Texture texture,
Uint8  r,
Uint8  g,
Uint8  b 
)

Set an additional color value used in render copy operations.

Parameters
textureThe texture to update.
rThe red color value multiplied into copy operations.
gThe green color value multiplied into copy operations.
bThe blue color value multiplied into copy operations.
Returns
0 on success, or -1 if the texture is not valid or color modulation is not supported.
See also
SDL_GetTextureColorMod()

Definition at line 745 of file SDL_render.c.

746 {
748 
750 
751  renderer = texture->renderer;
752  if (r < 255 || g < 255 || b < 255) {
754  } else {
755  texture->modMode &= ~SDL_TEXTUREMODULATE_COLOR;
756  }
757  texture->r = r;
758  texture->g = g;
759  texture->b = b;
760  if (texture->native) {
761  return SDL_SetTextureColorMod(texture->native, r, g, b);
762  } else if (renderer->SetTextureColorMod) {
764  } else {
765  return 0;
766  }
767 }

References CHECK_TEXTURE_MAGIC, renderer, SDL_TEXTUREMODULATE_COLOR, and SDL_Renderer::SetTextureColorMod.

Referenced by SDL_CreateTextureFromSurface().

◆ SDL_UnlockTexture()

void SDL_UnlockTexture ( SDL_Texture texture)

Unlock a texture, uploading the changes to video memory, if needed.

See also
SDL_LockTexture()

Definition at line 1181 of file SDL_render.c.

1182 {
1184 
1186 
1187  if (texture->access != SDL_TEXTUREACCESS_STREAMING) {
1188  return;
1189  }
1190  if (texture->yuv) {
1192  } else if (texture->native) {
1194  } else {
1195  renderer = texture->renderer;
1197  }
1198 }

References CHECK_TEXTURE_MAGIC, renderer, SDL_TEXTUREACCESS_STREAMING, SDL_UnlockTextureNative(), SDL_UnlockTextureYUV(), and SDL_Renderer::UnlockTexture.

Referenced by SDL_UnlockTextureNative(), SDL_UnlockTextureYUV(), SDL_UpdateTextureNative(), SDL_UpdateTextureYUV(), and SDL_UpdateTextureYUVPlanar().

◆ SDL_UpdateTexture()

int SDL_UpdateTexture ( SDL_Texture texture,
const SDL_Rect rect,
const void pixels,
int  pitch 
)

Update the given texture rectangle with new pixel data.

Parameters
textureThe texture to update
rectA pointer to the rectangle of pixels to update, or NULL to update the entire texture.
pixelsThe raw pixel data in the format of the texture.
pitchThe number of bytes in a row of pixel data, including padding between lines.

The pixel data must be in the format of the texture. The pixel format can be queried with SDL_QueryTexture.

Returns
0 on success, or -1 if the texture is not valid.
Note
This is a fairly slow function.

Definition at line 941 of file SDL_render.c.

943 {
945  SDL_Rect full_rect;
946 
948 
949  if (!pixels) {
950  return SDL_InvalidParamError("pixels");
951  }
952  if (!pitch) {
953  return SDL_InvalidParamError("pitch");
954  }
955 
956  if (!rect) {
957  full_rect.x = 0;
958  full_rect.y = 0;
959  full_rect.w = texture->w;
960  full_rect.h = texture->h;
961  rect = &full_rect;
962  }
963 
964  if ((rect->w == 0) || (rect->h == 0)) {
965  return 0; /* nothing to do. */
966  } else if (texture->yuv) {
967  return SDL_UpdateTextureYUV(texture, rect, pixels, pitch);
968  } else if (texture->native) {
969  return SDL_UpdateTextureNative(texture, rect, pixels, pitch);
970  } else {
971  renderer = texture->renderer;
972  return renderer->UpdateTexture(renderer, texture, rect, pixels, pitch);
973  }
974 }

References CHECK_TEXTURE_MAGIC, SDL_Rect::h, rect, renderer, SDL_InvalidParamError, SDL_UpdateTextureNative(), SDL_UpdateTextureYUV(), SDL_Renderer::UpdateTexture, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

Referenced by SDL_CreateTextureFromSurface(), SDL_UpdateTextureNative(), SDL_UpdateTextureYUV(), and SDL_UpdateTextureYUVPlanar().

◆ SDL_UpdateYUVTexture()

int 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.

Parameters
textureThe texture to update
rectA pointer to the rectangle of pixels to update, or NULL to update the entire texture.
YplaneThe raw pixel data for the Y plane.
YpitchThe number of bytes between rows of pixel data for the Y plane.
UplaneThe raw pixel data for the U plane.
UpitchThe number of bytes between rows of pixel data for the U plane.
VplaneThe raw pixel data for the V plane.
VpitchThe number of bytes between rows of pixel data for the V plane.
Returns
0 on success, or -1 if the texture is not valid.
Note
You can use SDL_UpdateTexture() as long as your pixel data is a contiguous block of Y and U/V planes in the proper order, but this function is available if your pixel data is not contiguous.

Definition at line 1028 of file SDL_render.c.

1032 {
1034  SDL_Rect full_rect;
1035 
1037 
1038  if (!Yplane) {
1039  return SDL_InvalidParamError("Yplane");
1040  }
1041  if (!Ypitch) {
1042  return SDL_InvalidParamError("Ypitch");
1043  }
1044  if (!Uplane) {
1045  return SDL_InvalidParamError("Uplane");
1046  }
1047  if (!Upitch) {
1048  return SDL_InvalidParamError("Upitch");
1049  }
1050  if (!Vplane) {
1051  return SDL_InvalidParamError("Vplane");
1052  }
1053  if (!Vpitch) {
1054  return SDL_InvalidParamError("Vpitch");
1055  }
1056 
1057  if (texture->format != SDL_PIXELFORMAT_YV12 &&
1058  texture->format != SDL_PIXELFORMAT_IYUV) {
1059  return SDL_SetError("Texture format must by YV12 or IYUV");
1060  }
1061 
1062  if (!rect) {
1063  full_rect.x = 0;
1064  full_rect.y = 0;
1065  full_rect.w = texture->w;
1066  full_rect.h = texture->h;
1067  rect = &full_rect;
1068  }
1069 
1070  if (!rect->w || !rect->h) {
1071  return 0; /* nothing to do. */
1072  }
1073 
1074  if (texture->yuv) {
1075  return SDL_UpdateTextureYUVPlanar(texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
1076  } else {
1077  SDL_assert(!texture->native);
1078  renderer = texture->renderer;
1080  if (renderer->UpdateTextureYUV) {
1081  return renderer->UpdateTextureYUV(renderer, texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
1082  } else {
1083  return SDL_Unsupported();
1084  }
1085  }
1086 }

References CHECK_TEXTURE_MAGIC, SDL_Rect::h, rect, renderer, SDL_assert, SDL_InvalidParamError, SDL_PIXELFORMAT_IYUV, SDL_PIXELFORMAT_YV12, SDL_SetError, SDL_Unsupported, SDL_UpdateTextureYUVPlanar(), SDL_Renderer::UpdateTextureYUV, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

SDL_zero
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
SDL_UnlockSurface
#define SDL_UnlockSurface
Definition: SDL_dynapi_overrides.h:449
SDL_SetRenderTarget
int SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture)
Set a texture as the current rendering target.
Definition: SDL_render.c:1210
SDL_Renderer::blendMode
SDL_BlendMode blendMode
Definition: SDL_sysrender.h:179
SW_CreateRendererForSurface
SDL_Renderer * SW_CreateRendererForSurface(SDL_Surface *surface)
Definition: SDL_render_sw.c:126
format
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: SDL_opengl.h:1572
points
GLfixed GLfixed GLint GLint GLfixed points
Definition: SDL_opengl_glext.h:4558
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179
SDL_Point::x
int x
Definition: SDL_rect.h:50
SDL_Renderer::GL_UnbindTexture
int(* GL_UnbindTexture)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:133
SDL_HINT_RENDER_VSYNC
#define SDL_HINT_RENDER_VSYNC
A variable controlling whether updates to the SDL screen surface should be synchronized with the vert...
Definition: SDL_hints.h:154
SDL_CreateTexture
SDL_Texture * SDL_CreateTexture(SDL_Renderer *renderer, Uint32 format, int access, int w, int h)
Create a texture for a rendering context.
Definition: SDL_render.c:541
SDL_Renderer::clip_rect_backup
SDL_Rect clip_rect_backup
Definition: SDL_sysrender.h:160
SDL_GL_UnbindTexture
int SDL_GL_UnbindTexture(SDL_Texture *texture)
Unbind a texture from the current OpenGL/ES/ES2 context.
Definition: SDL_render.c:2167
SDL_GetWindowData
#define SDL_GetWindowData
Definition: SDL_dynapi_overrides.h:523
blendMode
static SDL_BlendMode blendMode
Definition: testdraw2.c:34
SDL_SetTextureAlphaMod
int SDL_SetTextureAlphaMod(SDL_Texture *texture, Uint8 alpha)
Set an additional alpha value used in render copy operations.
Definition: SDL_render.c:788
SDL_Surface
A collection of pixels used in software blitting.
Definition: SDL_surface.h:70
SDL_HasIntersection
#define SDL_HasIntersection
Definition: SDL_dynapi_overrides.h:293
SDL_Renderer::UpdateClipRect
int(* UpdateClipRect)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:112
SDL_UpdateTextureYUV
static int SDL_UpdateTextureYUV(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
Definition: SDL_render.c:854
SDL_Renderer::GetMetalLayer
void *(* GetMetalLayer)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:135
SDL_WINDOW_MINIMIZED
@ SDL_WINDOW_MINIMIZED
Definition: SDL_video.h:106
IsSupportedBlendMode
static SDL_bool IsSupportedBlendMode(SDL_Renderer *renderer, SDL_BlendMode blendMode)
Definition: SDL_render.c:469
SDL_RenderTargetSupported
SDL_bool SDL_RenderTargetSupported(SDL_Renderer *renderer)
Determines whether a window supports the use of render targets.
Definition: SDL_render.c:1201
SDL_TEXTUREMODULATE_COLOR
@ SDL_TEXTUREMODULATE_COLOR
Definition: SDL_render.h:104
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:260
SDL_RendererFlags
SDL_RendererFlags
Flags used when creating a rendering context.
Definition: SDL_render.h:65
window_w
int window_w
Definition: testoverlay2.c:143
SDL_FPoint::x
float x
Definition: SDL_sysrender.h:44
SDL_ceil
#define SDL_ceil
Definition: SDL_dynapi_overrides.h:426
SDL_FRect::h
float h
Definition: SDL_sysrender.h:53
NULL
#define NULL
Definition: begin_code.h:164
surface
EGLSurface surface
Definition: eglext.h:248
SDL_PixelFormat::format
Uint32 format
Definition: SDL_pixels.h:317
b
GLboolean GLboolean GLboolean b
Definition: SDL_opengl_glext.h:1109
SDL_Renderer::SetRenderTarget
int(* SetRenderTarget)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:110
enable
GLboolean enable
Definition: SDL_opengl_glext.h:4996
width
GLint GLint GLsizei width
Definition: SDL_opengl.h:1572
RenderDrawLinesWithRects
static int RenderDrawLinesWithRects(SDL_Renderer *renderer, const SDL_Point *points, int count)
Definition: SDL_render.c:1704
SDL_Surface::pixels
void * pixels
Definition: SDL_surface.h:75
g
GLboolean GLboolean g
Definition: SDL_opengl_glext.h:1109
access
GLuint GLint GLboolean GLint GLenum access
Definition: SDL_opengl_glext.h:2162
render_drivers
static const SDL_RenderDriver * render_drivers[]
Definition: SDL_render.c:76
SDL_Renderer::g
Uint8 g
Definition: SDL_sysrender.h:178
SDL_UpdateTextureNative
static int SDL_UpdateTextureNative(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
Definition: SDL_render.c:900
count
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
SDL_BLENDMODE_BLEND
@ SDL_BLENDMODE_BLEND
Definition: SDL_blendmode.h:44
SDL_UnlockTextureNative
static void SDL_UnlockTextureNative(SDL_Texture *texture)
Definition: SDL_render.c:1160
SDL_Renderer::SetTextureBlendMode
int(* SetTextureBlendMode)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:97
SDL_GetWindowFlags
#define SDL_GetWindowFlags
Definition: SDL_dynapi_overrides.h:518
SDL_RenderCopy
int 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.
Definition: SDL_render.c:1916
SDL_Renderer::hidden
SDL_bool hidden
Definition: SDL_sysrender.h:143
SDL_Renderer::scale
SDL_FPoint scale
Definition: SDL_sysrender.h:167
r
GLdouble GLdouble GLdouble r
Definition: SDL_opengl.h:2079
SDL_ConvertSurface
#define SDL_ConvertSurface
Definition: SDL_dynapi_overrides.h:463
SDL_InvalidParamError
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
SDL_CreateMutex
#define SDL_CreateMutex
Definition: SDL_dynapi_overrides.h:259
SDL_WINDOWPOS_UNDEFINED
#define SDL_WINDOWPOS_UNDEFINED
Definition: SDL_video.h:130
SDL_MUSTLOCK
#define SDL_MUSTLOCK(S)
Definition: SDL_surface.h:61
SDL_IntersectRect
#define SDL_IntersectRect
Definition: SDL_dynapi_overrides.h:294
SDL_UpdateTextureYUVPlanar
static int SDL_UpdateTextureYUVPlanar(SDL_Texture *texture, const SDL_Rect *rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch)
Definition: SDL_render.c:977
SDL_floor
#define SDL_floor
Definition: SDL_dynapi_overrides.h:431
SDL_Renderer::RenderFillRects
int(* RenderFillRects)(SDL_Renderer *renderer, const SDL_FRect *rects, int count)
Definition: SDL_sysrender.h:118
SDL_RenderDriver
Definition: SDL_sysrender.h:186
SDL_FRect::x
float x
Definition: SDL_sysrender.h:50
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDL_ISPIXELFORMAT_INDEXED
#define SDL_ISPIXELFORMAT_INDEXED(format)
Definition: SDL_pixels.h:134
SDL_Renderer::UpdateViewport
int(* UpdateViewport)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:111
SDL_Renderer::dpi_scale
SDL_FPoint dpi_scale
Definition: SDL_sysrender.h:171
SDL_Renderer::textures
SDL_Texture * textures
Definition: SDL_sysrender.h:174
SDL_GetRendererOutputSize
int SDL_GetRendererOutputSize(SDL_Renderer *renderer, int *w, int *h)
Get the output size in pixels of a rendering context.
Definition: SDL_render.c:451
index
GLuint index
Definition: SDL_opengl_glext.h:660
SDL_FPoint::y
float y
Definition: SDL_sysrender.h:45
x1
GLuint GLfloat GLfloat GLfloat x1
Definition: SDL_opengl_glext.h:8583
a
GLboolean GLboolean GLboolean GLboolean a
Definition: SDL_opengl_glext.h:1109
SDL_GetHint
#define SDL_GetHint
Definition: SDL_dynapi_overrides.h:191
SDL_CreateWindow
#define SDL_CreateWindow
Definition: SDL_dynapi_overrides.h:514
renderer_magic
static char renderer_magic
Definition: SDL_render.c:105
h
GLfloat GLfloat GLfloat GLfloat h
Definition: SDL_opengl_glext.h:1946
SDL_Renderer::target_mutex
SDL_mutex * target_mutex
Definition: SDL_sysrender.h:176
SDL_GetSurfaceBlendMode
#define SDL_GetSurfaceBlendMode
Definition: SDL_dynapi_overrides.h:460
SDL_QueryTexture
int SDL_QueryTexture(SDL_Texture *texture, Uint32 *format, int *access, int *w, int *h)
Query the attributes of a texture.
Definition: SDL_render.c:724
SDL_Rect::x
int x
Definition: SDL_rect.h:66
SDL_CreateRenderer
SDL_Renderer * SDL_CreateRenderer(SDL_Window *window, int index, Uint32 flags)
Create a 2D rendering context for a window.
Definition: SDL_render.c:304
SDL_Renderer::logical_w
int logical_w
Definition: SDL_sysrender.h:146
SDL_Renderer::viewport_backup
SDL_Rect viewport_backup
Definition: SDL_sysrender.h:156
SDL_AllocFormat
#define SDL_AllocFormat
Definition: SDL_dynapi_overrides.h:280
SDL_Texture::prev
SDL_Texture * prev
Definition: SDL_sysrender.h:80
SDL_GetNumRenderDrivers
int SDL_GetNumRenderDrivers(void)
Get the number of 2D rendering drivers available for the current display.
Definition: SDL_render.c:111
SDL_Rect::w
int w
Definition: SDL_rect.h:67
SDL_stack_alloc
#define SDL_stack_alloc(type, count)
Definition: SDL_stdinc.h:354
SDL_TEXTUREMODULATE_NONE
@ SDL_TEXTUREMODULATE_NONE
Definition: SDL_render.h:103
n
GLdouble n
Definition: SDL_opengl_glext.h:1952
SDL_RenderGetViewport
void SDL_RenderGetViewport(SDL_Renderer *renderer, SDL_Rect *rect)
Get the drawing area for the current target.
Definition: SDL_render.c:1473
SDL_strcasecmp
#define SDL_strcasecmp
Definition: SDL_dynapi_overrides.h:419
SDL_TextureModulate
SDL_TextureModulate
The texture channel modulation used in SDL_RenderCopy().
Definition: SDL_render.h:102
alpha
GLfloat GLfloat GLfloat alpha
Definition: SDL_opengl_glext.h:412
SDL_RenderDriver::CreateRenderer
SDL_Renderer *(* CreateRenderer)(SDL_Window *window, Uint32 flags)
Definition: SDL_sysrender.h:187
SDL_GetWindowSize
#define SDL_GetWindowSize
Definition: SDL_dynapi_overrides.h:527
SDL_LockTextureNative
static int SDL_LockTextureNative(SDL_Texture *texture, const SDL_Rect *rect, void **pixels, int *pitch)
Definition: SDL_render.c:1096
SDL_Surface::pitch
int pitch
Definition: SDL_surface.h:74
SDL_RENDERER_SOFTWARE
@ SDL_RENDERER_SOFTWARE
Definition: SDL_render.h:66
SDL_Renderer::viewport
SDL_Rect viewport
Definition: SDL_sysrender.h:155
RenderDrawPointsWithRects
static int RenderDrawPointsWithRects(SDL_Renderer *renderer, const SDL_Point *points, int count)
Definition: SDL_render.c:1624
SDL_PIXELFORMAT_YV12
@ SDL_PIXELFORMAT_YV12
Definition: SDL_pixels.h:277
SDL_RenderSetScale
int SDL_RenderSetScale(SDL_Renderer *renderer, float scaleX, float scaleY)
Set the drawing scale for rendering on the current target.
Definition: SDL_render.c:1524
SDL_GetHintBoolean
#define SDL_GetHintBoolean
Definition: SDL_dynapi_overrides.h:608
SDL_Renderer
Definition: SDL_sysrender.h:86
SDL_GL_BindTexture
int 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.
Definition: SDL_render.c:2152
SDL_FPoint
Definition: SDL_sysrender.h:43
SDL_FRect::y
float y
Definition: SDL_sysrender.h:51
SDL_Renderer::integer_scale
SDL_bool integer_scale
Definition: SDL_sysrender.h:152
SDL_Renderer::b
Uint8 b
Definition: SDL_sysrender.h:178
SDL_FRect::w
float w
Definition: SDL_sysrender.h:52
SDL_Renderer::scale_backup
SDL_FPoint scale_backup
Definition: SDL_sysrender.h:168
x
GLint GLint GLint GLint GLint x
Definition: SDL_opengl.h:1574
window_h
int window_h
Definition: testoverlay2.c:144
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_SetWindowData
#define SDL_SetWindowData
Definition: SDL_dynapi_overrides.h:522
SDL_Renderer::SetTextureColorMod
int(* SetTextureColorMod)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:93
SDL_RendererInfo::flags
Uint32 flags
Definition: SDL_render.h:81
SDL_Rect::y
int y
Definition: SDL_rect.h:66
SDL_UpdateTexture
int SDL_UpdateTexture(SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
Update the given texture rectangle with new pixel data.
Definition: SDL_render.c:941
SDL_Rect::h
int h
Definition: SDL_rect.h:67
SDL_Renderer::logical_h_backup
int logical_h_backup
Definition: SDL_sysrender.h:149
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
f
GLfloat f
Definition: SDL_opengl_glext.h:1870
SDL_TEXTUREACCESS_STATIC
@ SDL_TEXTUREACCESS_STATIC
Definition: SDL_render.h:93
SDL_FLIP_NONE
@ SDL_FLIP_NONE
Definition: SDL_render.h:113
height
GLint GLint GLsizei GLsizei height
Definition: SDL_opengl.h:1572
UpdateLogicalSize
static int UpdateLogicalSize(SDL_Renderer *renderer)
Definition: SDL_render.c:1293
SDL_FLIP_HORIZONTAL
@ SDL_FLIP_HORIZONTAL
Definition: SDL_render.h:114
SDL_RENDERER_PRESENTVSYNC
@ SDL_RENDERER_PRESENTVSYNC
Definition: SDL_render.h:69
SDL_DestroyTexture
void SDL_DestroyTexture(SDL_Texture *texture)
Destroy the specified texture.
Definition: SDL_render.c:2089
rect
SDL_Rect rect
Definition: testrelative.c:27
SDL_FreeSurface
#define SDL_FreeSurface
Definition: SDL_dynapi_overrides.h:446
SDL_Renderer::RenderDrawLines
int(* RenderDrawLines)(SDL_Renderer *renderer, const SDL_FPoint *points, int count)
Definition: SDL_sysrender.h:116
SDL_LockTextureYUV
static int SDL_LockTextureYUV(SDL_Texture *texture, const SDL_Rect *rect, void **pixels, int *pitch)
Definition: SDL_render.c:1089
SDL_SW_DestroyYUVTexture
void SDL_SW_DestroyYUVTexture(SDL_SW_YUVTexture *swdata)
Definition: SDL_yuv_sw.c:404
SDL_Renderer::RenderClear
int(* RenderClear)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:113
SDL_UnlockTextureYUV
static void SDL_UnlockTextureYUV(SDL_Texture *texture)
Definition: SDL_render.c:1139
SDL_FreeFormat
#define SDL_FreeFormat
Definition: SDL_dynapi_overrides.h:281
SDL_PixelFormat::Amask
Uint32 Amask
Definition: SDL_pixels.h:325
SDL_Texture::next
SDL_Texture * next
Definition: SDL_sysrender.h:81
SDL_Renderer::GL_BindTexture
int(* GL_BindTexture)(SDL_Renderer *renderer, SDL_Texture *texture, float *texw, float *texh)
Definition: SDL_sysrender.h:132
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_PixelFormat
Definition: SDL_pixels.h:316
SDL_PIXELFORMAT_IYUV
@ SDL_PIXELFORMAT_IYUV
Definition: SDL_pixels.h:279
SDL_Renderer::RenderDrawPoints
int(* RenderDrawPoints)(SDL_Renderer *renderer, const SDL_FPoint *points, int count)
Definition: SDL_sysrender.h:114
SDL_TEXTUREMODULATE_ALPHA
@ SDL_TEXTUREMODULATE_ALPHA
Definition: SDL_render.h:105
SDL_assert
#define SDL_assert(condition)
Definition: SDL_assert.h:169
pixels
GLint GLint GLsizei GLsizei GLsizei GLint GLenum GLenum const GLvoid * pixels
Definition: SDL_opengl.h:1572
SDL_Renderer::GetOutputSize
int(* GetOutputSize)(SDL_Renderer *renderer, int *w, int *h)
Definition: SDL_sysrender.h:90
SDL_Renderer::RenderCopy
int(* RenderCopy)(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *srcrect, const SDL_FRect *dstrect)
Definition: SDL_sysrender.h:120
SDL_OutOfMemory
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
SDL_Renderer::SetTextureAlphaMod
int(* SetTextureAlphaMod)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:95
SDL_Renderer::CreateTexture
int(* CreateTexture)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:92
y
GLint GLint GLint GLint GLint GLint y
Definition: SDL_opengl.h:1574
SDL_LOG_CATEGORY_RENDER
@ SDL_LOG_CATEGORY_RENDER
Definition: SDL_log.h:72
SDL_LockSurface
#define SDL_LockSurface
Definition: SDL_dynapi_overrides.h:448
SDL_Renderer::DestroyRenderer
void(* DestroyRenderer)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:130
SDL_Renderer::LockTexture
int(* LockTexture)(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *rect, void **pixels, int *pitch)
Definition: SDL_sysrender.h:107
SDL_Renderer::GetMetalCommandEncoder
void *(* GetMetalCommandEncoder)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:136
SDL_SW_CreateYUVTexture
SDL_SW_YUVTexture * SDL_SW_CreateYUVTexture(Uint32 format, int w, int h)
Definition: SDL_yuv_sw.c:31
SDL_GetSurfaceAlphaMod
#define SDL_GetSurfaceAlphaMod
Definition: SDL_dynapi_overrides.h:458
SDL_calloc
#define SDL_calloc
Definition: SDL_dynapi_overrides.h:375
SDL_Renderer::logical_h
int logical_h
Definition: SDL_sysrender.h:147
SDL_LogInfo
#define SDL_LogInfo
Definition: SDL_dynapi_overrides.h:34
SDL_Renderer::RenderReadPixels
int(* RenderReadPixels)(SDL_Renderer *renderer, const SDL_Rect *rect, Uint32 format, void *pixels, int pitch)
Definition: SDL_sysrender.h:125
SDL_Renderer::RenderCopyEx
int(* RenderCopyEx)(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *srcquad, const SDL_FRect *dstrect, const double angle, const SDL_FPoint *center, const SDL_RendererFlip flip)
Definition: SDL_sysrender.h:122
SDL_RendererFlip
SDL_RendererFlip
Flip constants for SDL_RenderCopyEx.
Definition: SDL_render.h:112
renderer
static SDL_Renderer * renderer
Definition: testaudiocapture.c:21
SDL_FLIP_VERTICAL
@ SDL_FLIP_VERTICAL
Definition: SDL_render.h:115
SDL_WINDOW_HIDDEN
@ SDL_WINDOW_HIDDEN
Definition: SDL_video.h:103
SDL_stack_free
#define SDL_stack_free(data)
Definition: SDL_stdinc.h:355
SDL_ISPIXELFORMAT_FOURCC
#define SDL_ISPIXELFORMAT_FOURCC(format)
Definition: SDL_pixels.h:167
SDL_GetRenderer
SDL_Renderer * SDL_GetRenderer(SDL_Window *window)
Get the renderer associated with a window.
Definition: SDL_render.c:436
SDL_Point
The structure that defines a point.
Definition: SDL_rect.h:49
SDL_Renderer::info
SDL_RendererInfo info
Definition: SDL_sysrender.h:139
SDL_RENDERER_TARGETTEXTURE
@ SDL_RENDERER_TARGETTEXTURE
Definition: SDL_render.h:71
SDL_GetWindowPixelFormat
#define SDL_GetWindowPixelFormat
Definition: SDL_dynapi_overrides.h:513
x2
GLfixed GLfixed x2
Definition: SDL_opengl_glext.h:4583
CHECK_TEXTURE_MAGIC
#define CHECK_TEXTURE_MAGIC(texture, retval)
Definition: SDL_render.c:42
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_Renderer::RenderPresent
void(* RenderPresent)(SDL_Renderer *renderer)
Definition: SDL_sysrender.h:127
SDL_BYTESPERPIXEL
#define SDL_BYTESPERPIXEL(X)
Definition: SDL_pixels.h:128
SDL_RenderSetViewport
int SDL_RenderSetViewport(SDL_Renderer *renderer, const SDL_Rect *rect)
Set the drawing area for rendering on the current target.
Definition: SDL_render.c:1453
SDL_RenderDrawPoints
int SDL_RenderDrawPoints(SDL_Renderer *renderer, const SDL_Point *points, int count)
Draw multiple points on the current rendering target.
Definition: SDL_render.c:1650
SDL_Rect
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:65
SDL_RendererInfo::max_texture_width
int max_texture_width
Definition: SDL_render.h:84
SDL_GetScaleMode
static SDL_ScaleMode SDL_GetScaleMode(void)
Definition: SDL_render.c:525
IsSupportedFormat
static SDL_bool IsSupportedFormat(SDL_Renderer *renderer, Uint32 format)
Definition: SDL_render.c:486
SDL_Texture
Definition: SDL_sysrender.h:58
SDL_Renderer::UpdateTexture
int(* UpdateTexture)(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *rect, const void *pixels, int pitch)
Definition: SDL_sysrender.h:99
SDL_TEXTUREACCESS_TARGET
@ SDL_TEXTUREACCESS_TARGET
Definition: SDL_render.h:95
y1
GLfixed y1
Definition: SDL_opengl_glext.h:4583
SDL_DestroyMutex
#define SDL_DestroyMutex
Definition: SDL_dynapi_overrides.h:263
SDL_RendererEventWatch
static int SDL_RendererEventWatch(void *userdata, SDL_Event *event)
Definition: SDL_render.c:146
SDL_AddEventWatch
#define SDL_AddEventWatch
Definition: SDL_dynapi_overrides.h:128
SDL_FRect
Definition: SDL_sysrender.h:49
y2
GLfixed GLfixed GLfixed y2
Definition: SDL_opengl_glext.h:4583
SDL_GetSurfaceColorMod
#define SDL_GetSurfaceColorMod
Definition: SDL_dynapi_overrides.h:456
SDL_RenderDriver::info
SDL_RendererInfo info
Definition: SDL_sysrender.h:190
angle
GLfloat angle
Definition: SDL_opengl_glext.h:6097
SDL_Renderer::logical_w_backup
int logical_w_backup
Definition: SDL_sysrender.h:148
SDL_Renderer::clipping_enabled
SDL_bool clipping_enabled
Definition: SDL_sysrender.h:163
SDL_Renderer::magic
const void * magic
Definition: SDL_sysrender.h:87
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_RendererInfo::name
const char * name
Definition: SDL_render.h:80
SDL_SetTextureColorMod
int SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b)
Set an additional color value used in render copy operations.
Definition: SDL_render.c:745
CHECK_RENDERER_MAGIC
#define CHECK_RENDERER_MAGIC(renderer, retval)
Definition: SDL_render.c:35
SDL_HINT_RENDER_DRIVER
#define SDL_HINT_RENDER_DRIVER
A variable specifying which render driver to use.
Definition: SDL_hints.h:85
SDL_ISPIXELFORMAT_ALPHA
#define SDL_ISPIXELFORMAT_ALPHA(format)
Definition: SDL_pixels.h:154
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
SDL_Renderer::r
Uint8 r
Definition: SDL_sysrender.h:178
SDL_RenderFillRects
int 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.
Definition: SDL_render.c:1876
SDL_Unsupported
#define SDL_Unsupported()
Definition: SDL_error.h:53
SDL_Renderer::a
Uint8 a
Definition: SDL_sysrender.h:178
SDL_SetTextureBlendMode
int SDL_SetTextureBlendMode(SDL_Texture *texture, SDL_BlendMode blendMode)
Set the blend mode used for texture copy operations.
Definition: SDL_render.c:822
SDL_RENDERER_ACCELERATED
@ SDL_RENDERER_ACCELERATED
Definition: SDL_render.h:67
SDL_RendererInfo::texture_formats
Uint32 texture_formats[16]
Definition: SDL_render.h:83
SDL_RendererInfo::max_texture_height
int max_texture_height
Definition: SDL_render.h:85
void
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
Definition: SDL_dynapi_procs.h:89
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:262
flags
GLbitfield flags
Definition: SDL_opengl_glext.h:1480
SDL_Renderer::window
SDL_Window * window
Definition: SDL_sysrender.h:142
SDL_TEXTUREACCESS_STREAMING
@ SDL_TEXTUREACCESS_STREAMING
Definition: SDL_render.h:94
SDL_Renderer::target
SDL_Texture * target
Definition: SDL_sysrender.h:175
texture
GLenum GLenum GLuint texture
Definition: SDL_opengl_glext.h:1178
texture_magic
static char texture_magic
Definition: SDL_render.c:106
rects
EGLSurface EGLint * rects
Definition: eglext.h:282
SDL_TextureAccess
SDL_TextureAccess
The access pattern allowed for a texture.
Definition: SDL_render.h:92
i
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
SDL_RenderDrawRect
int SDL_RenderDrawRect(SDL_Renderer *renderer, const SDL_Rect *rect)
Draw a rectangle on the current rendering target.
Definition: SDL_render.c:1802
SDL_Renderer::clipping_enabled_backup
SDL_bool clipping_enabled_backup
Definition: SDL_sysrender.h:164
SDL_HasColorKey
#define SDL_HasColorKey
Definition: SDL_dynapi_overrides.h:699
SDL_RenderDrawLines
int 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.c:1760
SDL_Renderer::clip_rect
SDL_Rect clip_rect
Definition: SDL_sysrender.h:159
SDL_Point::y
int y
Definition: SDL_rect.h:51
SDL_BlendMode
SDL_BlendMode
The blend mode used in SDL_RenderCopy() and drawing operations.
Definition: SDL_blendmode.h:41
SDL_WINDOWRENDERDATA
#define SDL_WINDOWRENDERDATA
Definition: SDL_render.c:33
GetClosestSupportedFormat
static Uint32 GetClosestSupportedFormat(SDL_Renderer *renderer, Uint32 format)
Definition: SDL_render.c:499
SDL_Renderer::UnlockTexture
void(* UnlockTexture)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:109
SDL_RendererInfo::num_texture_formats
Uint32 num_texture_formats
Definition: SDL_render.h:82
SDL_DelEventWatch
#define SDL_DelEventWatch
Definition: SDL_dynapi_overrides.h:129
SDL_Renderer::DestroyTexture
void(* DestroyTexture)(SDL_Renderer *renderer, SDL_Texture *texture)
Definition: SDL_sysrender.h:128
SDL_Renderer::UpdateTextureYUV
int(* UpdateTextureYUV)(SDL_Renderer *renderer, SDL_Texture *texture, const SDL_Rect *rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch)
Definition: SDL_sysrender.h:102
w
GLubyte GLubyte GLubyte GLubyte w
Definition: SDL_opengl_glext.h:731