#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_ScaleMode { SDL_ScaleModeNearest , SDL_ScaleModeLinear , SDL_ScaleModeBest }
	The scaling mode for a texture. 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_Renderer *	SDL_CreateRenderer (SDL_Window *window, int index, Uint32 flags)
	Create a 2D rendering context for a window. More...

SDL_Renderer *	SDL_CreateSoftwareRenderer (SDL_Surface *surface)
	Create a 2D software rendering context for a surface. More...

SDL_Renderer *	SDL_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_Texture *	SDL_CreateTexture (SDL_Renderer *renderer, Uint32 format, int access, int w, int h)
	Create a texture for a rendering context. More...

SDL_Texture *	SDL_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_SetTextureScaleMode (SDL_Texture *texture, SDL_ScaleMode scaleMode)
	Set the scale mode used for texture scale operations. More...

int	SDL_GetTextureScaleMode (SDL_Texture texture, SDL_ScaleMode scaleMode)
	Get the scale mode used for texture scale 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...

int	SDL_LockTextureToSurface (SDL_Texture texture, const SDL_Rect rect, SDL_Surface **surface)
	Lock a portion of the texture for write-only pixel access. Expose it as a SDL surface. More...

void	SDL_UnlockTexture (SDL_Texture *texture)
	Unlock a texture, uploading the changes to video memory, if needed. If SDL_LockTextureToSurface() was called for locking, the SDL surface is freed. 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_Texture *	SDL_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_RenderDrawPointF (SDL_Renderer *renderer, float x, float y)
	Draw a point on the current rendering target. More...

int	SDL_RenderDrawPointsF (SDL_Renderer renderer, const SDL_FPoint points, int count)
	Draw multiple points on the current rendering target. More...

int	SDL_RenderDrawLineF (SDL_Renderer *renderer, float x1, float y1, float x2, float y2)
	Draw a line on the current rendering target. More...

int	SDL_RenderDrawLinesF (SDL_Renderer renderer, const SDL_FPoint points, int count)
	Draw a series of connected lines on the current rendering target. More...

int	SDL_RenderDrawRectF (SDL_Renderer renderer, const SDL_FRect rect)
	Draw a rectangle on the current rendering target. More...

int	SDL_RenderDrawRectsF (SDL_Renderer renderer, const SDL_FRect rects, int count)
	Draw some number of rectangles on the current rendering target. More...

int	SDL_RenderFillRectF (SDL_Renderer renderer, const SDL_FRect rect)
	Fill a rectangle on the current rendering target with the drawing color. More...

int	SDL_RenderFillRectsF (SDL_Renderer renderer, const SDL_FRect rects, int count)
	Fill some number of rectangles on the current rendering target with the drawing color. More...

int	SDL_RenderCopyF (SDL_Renderer renderer, SDL_Texture texture, const SDL_Rect srcrect, const SDL_FRect dstrect)
	Copy a portion of the texture to the current rendering target. More...

int	SDL_RenderCopyExF (SDL_Renderer renderer, SDL_Texture texture, const SDL_Rect srcrect, const SDL_FRect dstrect, const double angle, const SDL_FPoint *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_RenderFlush (SDL_Renderer *renderer)
	Force the rendering context to flush any pending commands to the underlying rendering API. 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...

void *	SDL_RenderGetMetalLayer (SDL_Renderer *renderer)
	Get the CAMetalLayer associated with the given Metal renderer. More...

void *	SDL_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

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

 {
     SDL_RENDERER_SOFTWARE = 0x00000001,         /**< The renderer is a software fallback */
     SDL_RENDERER_ACCELERATED = 0x00000002,      /**< The renderer uses hardware
                                                      acceleration */
     SDL_RENDERER_PRESENTVSYNC = 0x00000004,     /**< Present is synchronized
                                                      with the refresh rate */
     SDL_RENDERER_TARGETTEXTURE = 0x00000008     /**< The renderer supports
                                                      rendering to texture */
 } SDL_RendererFlags;

◆ SDL_RendererFlip

enum 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 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) g int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext SDL_RWops int return return void return int int return double return SDL_bool return int int return SDL_AudioDeviceID const void Uint32 return SDL_AudioDeviceID int float float float return SDL_JoystickID return int SDL_Rect return SDL_Window float return SDL_Window return SDL_Renderer SDL_bool return SDL_AudioDeviceID void Uint32 return Uint32 int int int Uint32 return const char SDL_bool return int return SDL_Joystick return SDL_Joystick return SDL_GameController return return int return int return int return SDL_RWops size_t int return SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation return const char return SDL_Window VkInstance VkSurfaceKHR return SDL_malloc_func SDL_calloc_func SDL_realloc_func SDL_free_func return SDL_AudioStream const void int return SDL_AudioStream SDL_AudioStream float return float return float return float return float return float int return float float return return SDL_Renderer return double return int return double return const wchar_t return SDL_Joystick Uint16 Uint16 Uint32 return int return int return int return SDL_Sensor return SDL_Sensor return SDL_Sensor float int return int return SDL_ThreadFunction const char const size_t void return SDL_Joystick return SDL_Renderer return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FRect int return SDL_Renderer const SDL_FRect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_FRect const double const SDL_FPoint const 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 121 of file SDL_render.h.

 {
     SDL_FLIP_NONE = 0x00000000,     /**< Do not flip */
     SDL_FLIP_HORIZONTAL = 0x00000001,    /**< flip horizontally */
     SDL_FLIP_VERTICAL = 0x00000002     /**< flip vertically */
 } SDL_RendererFlip;

◆ SDL_ScaleMode

enum 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 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) b int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext SDL_RWops int return return void return int int return double return SDL_bool return int int return SDL_AudioDeviceID const void Uint32 return SDL_AudioDeviceID int float float float return SDL_JoystickID return int SDL_Rect return SDL_Window float return SDL_Window return SDL_Renderer SDL_bool return SDL_AudioDeviceID void Uint32 return Uint32 int int int Uint32 return const char SDL_bool return int return SDL_Joystick return SDL_Joystick return SDL_GameController return return int return int return int return SDL_RWops size_t int return SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation return const char return SDL_Window VkInstance VkSurfaceKHR return SDL_malloc_func SDL_calloc_func SDL_realloc_func SDL_free_func return SDL_AudioStream const void int return SDL_AudioStream SDL_AudioStream float return float return float return float return float return float int return float float return return SDL_Renderer return double return int return double return const wchar_t return SDL_Joystick Uint16 Uint16 Uint32 return int return int return int return SDL_Sensor return SDL_Sensor return SDL_Sensor float int return int return SDL_ThreadFunction const char const size_t void return SDL_Joystick return SDL_Renderer return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FRect int return SDL_Renderer const SDL_FRect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_FRect const double const SDL_FPoint const SDL_RendererFlip return return void SDL_RWops Sint64 int return SDL_RWops void size_t size_t return SDL_RWops return SDL_Window return SDL_Texture const SDL_Rect SDL_Surface return char const char char return const wchar_t const wchar_t size_t return SDL_GameController return SDL_GameController int SDL_Joystick int SDL_Texture SDL_ScaleMode

The scaling mode for a texture.

Enumerator
SDL_ScaleModeNearest	nearest pixel sampling
SDL_ScaleModeLinear	linear filtering
SDL_ScaleModeBest	anisotropic filtering

Definition at line 91 of file SDL_render.h.

 {
     SDL_ScaleModeNearest, /**< nearest pixel sampling */
     SDL_ScaleModeLinear,  /**< linear filtering */
     SDL_ScaleModeBest     /**< anisotropic filtering */
 } SDL_ScaleMode;

◆ SDL_TextureAccess

enum 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 101 of file SDL_render.h.

 {
     SDL_TEXTUREACCESS_STATIC,    /**< Changes rarely, not lockable */
     SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
     SDL_TEXTUREACCESS_TARGET     /**< Texture can be used as a render target */
 } SDL_TextureAccess;

◆ SDL_TextureModulate

enum 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 111 of file SDL_render.h.

 {
     SDL_TEXTUREMODULATE_NONE = 0x00000000,     /**< No modulation */
     SDL_TEXTUREMODULATE_COLOR = 0x00000001,    /**< srcC = srcC * color */
     SDL_TEXTUREMODULATE_ALPHA = 0x00000002     /**< srcA = srcA * alpha */
 } SDL_TextureModulate;

Function Documentation

◆ SDL_CreateRenderer()

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

Create a 2D rendering context for a window.

Parameters

window	The window where rendering is displayed.
index	The index of the rendering driver to initialize, or -1 to initialize the first one supporting the requested flags.
flags	SDL_RendererFlags.

Returns: A valid rendering context or NULL if there was an error.

See also: SDL_CreateSoftwareRenderer(); SDL_GetRendererInfo(); SDL_DestroyRenderer()

Definition at line 786 of file SDL_render.c.

 {
 #if !SDL_RENDER_DISABLED
     SDL_Renderer *renderer = NULL;
     int n = SDL_GetNumRenderDrivers();
     SDL_bool batching = SDL_TRUE;
     const char *hint;
  
 #if defined(__ANDROID__)
     Android_ActivityMutex_Lock_Running();
 #endif
  
     if (!window) {
         SDL_SetError("Invalid window");
         goto error;
     }
  
     if (SDL_GetRenderer(window)) {
         SDL_SetError("Renderer already associated with window");
         goto error;
     }
  
     if (SDL_GetHint(SDL_HINT_RENDER_VSYNC)) {
         if (SDL_GetHintBoolean(SDL_HINT_RENDER_VSYNC, SDL_TRUE)) {
             flags |= SDL_RENDERER_PRESENTVSYNC;
         } else {
             flags &= ~SDL_RENDERER_PRESENTVSYNC;
         }
     }
  
     if (index < 0) {
         hint = SDL_GetHint(SDL_HINT_RENDER_DRIVER);
         if (hint) {
             for (index = 0; index < n; ++index) {
                 const SDL_RenderDriver *driver = render_drivers[index];
  
                 if (SDL_strcasecmp(hint, driver->info.name) == 0) {
                     /* Create a new renderer instance */
                     renderer = driver->CreateRenderer(window, flags);
                     if (renderer) {
                         batching = SDL_FALSE;
                     }
                     break;
                 }
             }
         }
  
         if (!renderer) {
             for (index = 0; index < n; ++index) {
                 const SDL_RenderDriver *driver = render_drivers[index];
  
                 if ((driver->info.flags & flags) == flags) {
                     /* Create a new renderer instance */
                     renderer = driver->CreateRenderer(window, flags);
                     if (renderer) {
                         /* Yay, we got one! */
                         break;
                     }
                 }
             }
         }
         if (index == n) {
             SDL_SetError("Couldn't find matching render driver");
             goto error;
         }
     } else {
         if (index >= SDL_GetNumRenderDrivers()) {
             SDL_SetError("index must be -1 or in the range of 0 - %d",
                          SDL_GetNumRenderDrivers() - 1);
             goto error;
         }
         /* Create a new renderer instance */
         renderer = render_drivers[index]->CreateRenderer(window, flags);
         batching = SDL_FALSE;
     }
  
     if (!renderer) {
         goto error;
     }
  
     VerifyDrawQueueFunctions(renderer);
  
     /* let app/user override batching decisions. */
     if (renderer->always_batch) {
         batching = SDL_TRUE;
     } else if (SDL_GetHint(SDL_HINT_RENDER_BATCHING)) {
         batching = SDL_GetHintBoolean(SDL_HINT_RENDER_BATCHING, SDL_TRUE);
     }
  
     renderer->batching = batching;
     renderer->magic = &renderer_magic;
     renderer->window = window;
     renderer->target_mutex = SDL_CreateMutex();
     renderer->scale.x = 1.0f;
     renderer->scale.y = 1.0f;
     renderer->dpi_scale.x = 1.0f;
     renderer->dpi_scale.y = 1.0f;
  
     /* new textures start at zero, so we start at 1 so first render doesn't flush by accident. */
     renderer->render_command_generation = 1;
  
     if (window && renderer->GetOutputSize) {
         int window_w, window_h;
         int output_w, output_h;
         if (renderer->GetOutputSize(renderer, &output_w, &output_h) == 0) {
             SDL_GetWindowSize(renderer->window, &window_w, &window_h);
             renderer->dpi_scale.x = (float)window_w / output_w;
             renderer->dpi_scale.y = (float)window_h / output_h;
         }
     }
  
     renderer->relative_scaling = SDL_GetHintBoolean(SDL_HINT_MOUSE_RELATIVE_SCALING, SDL_TRUE);
  
     if (SDL_GetWindowFlags(window) & (SDL_WINDOW_HIDDEN|SDL_WINDOW_MINIMIZED)) {
         renderer->hidden = SDL_TRUE;
     } else {
         renderer->hidden = SDL_FALSE;
     }
  
     SDL_SetWindowData(window, SDL_WINDOWRENDERDATA, renderer);
  
     SDL_RenderSetViewport(renderer, NULL);
  
     SDL_AddEventWatch(SDL_RendererEventWatch, renderer);
  
     SDL_LogInfo(SDL_LOG_CATEGORY_RENDER,
                 "Created renderer: %s", renderer->info.name);
  
 #if defined(__ANDROID__)
     Android_ActivityMutex_Unlock();
 #endif
     return renderer;
  
 error:
  
 #if defined(__ANDROID__)
     Android_ActivityMutex_Unlock();
 #endif
     return NULL;
  
 #else
     SDL_SetError("SDL not built with rendering support");
     return NULL;
 #endif
 }

References SDL_Renderer::always_batch, Android_ActivityMutex_Lock_Running(), Android_ActivityMutex_Unlock(), SDL_Renderer::batching, 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, SDL_Renderer::relative_scaling, SDL_Renderer::render_command_generation, 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_MOUSE_RELATIVE_SCALING, SDL_HINT_RENDER_BATCHING, 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, VerifyDrawQueueFunctions(), 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

surface The 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 933 of file SDL_render.c.

 {
 #if !SDL_RENDER_DISABLED && SDL_VIDEO_RENDER_SW
     SDL_Renderer *renderer;
  
     renderer = SW_CreateRendererForSurface(surface);
  
     if (renderer) {
         VerifyDrawQueueFunctions(renderer);
         renderer->magic = &renderer_magic;
         renderer->target_mutex = SDL_CreateMutex();
         renderer->scale.x = 1.0f;
         renderer->scale.y = 1.0f;
  
         /* new textures start at zero, so we start at 1 so first render doesn't flush by accident. */
         renderer->render_command_generation = 1;
  
         SDL_RenderSetViewport(renderer, NULL);
     }
     return renderer;
 #else
     SDL_SetError("SDL not built with rendering support");
     return NULL;
 #endif /* !SDL_RENDER_DISABLED */
 }

References SDL_Renderer::magic, NULL, SDL_Renderer::render_command_generation, renderer, renderer_magic, SDL_Renderer::scale, SDL_CreateMutex, SDL_RenderSetViewport(), SDL_SetError, SW_CreateRendererForSurface(), SDL_Renderer::target_mutex, VerifyDrawQueueFunctions(), 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

renderer	The renderer.
format	The format of the texture.
access	One of the enumerated values in SDL_TextureAccess.
w	The width of the texture in pixels.
h	The 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 1066 of file SDL_render.c.

 {
     SDL_Texture *texture;
  
     CHECK_RENDERER_MAGIC(renderer, NULL);
  
     if (!format) {
         format = renderer->info.texture_formats[0];
     }
     if (SDL_BYTESPERPIXEL(format) == 0) {
         SDL_SetError("Invalid texture format");
         return NULL;
     }
     if (SDL_ISPIXELFORMAT_INDEXED(format)) {
         SDL_SetError("Palettized textures are not supported");
         return NULL;
     }
     if (w <= 0 || h <= 0) {
         SDL_SetError("Texture dimensions can't be 0");
         return NULL;
     }
     if ((renderer->info.max_texture_width && w > renderer->info.max_texture_width) ||
         (renderer->info.max_texture_height && h > renderer->info.max_texture_height)) {
         SDL_SetError("Texture dimensions are limited to %dx%d", renderer->info.max_texture_width, renderer->info.max_texture_height);
         return NULL;
     }
     texture = (SDL_Texture *) SDL_calloc(1, sizeof(*texture));
     if (!texture) {
         SDL_OutOfMemory();
         return NULL;
     }
     texture->magic = &texture_magic;
     texture->format = format;
     texture->access = access;
     texture->w = w;
     texture->h = h;
     texture->r = 255;
     texture->g = 255;
     texture->b = 255;
     texture->a = 255;
     texture->scaleMode = SDL_GetScaleMode();
     texture->renderer = renderer;
     texture->next = renderer->textures;
     if (renderer->textures) {
         renderer->textures->prev = texture;
     }
     renderer->textures = texture;
  
     if (IsSupportedFormat(renderer, format)) {
         if (renderer->CreateTexture(renderer, texture) < 0) {
             SDL_DestroyTexture(texture);
             return NULL;
         }
     } else {
         texture->native = SDL_CreateTexture(renderer,
                                 GetClosestSupportedFormat(renderer, format),
                                 access, w, h);
         if (!texture->native) {
             SDL_DestroyTexture(texture);
             return NULL;
         }
  
         /* Swap textures to have texture before texture->native in the list */
         texture->native->next = texture->next;
         if (texture->native->next) {
             texture->native->next->prev = texture->native;
         }
         texture->prev = texture->native->prev;
         if (texture->prev) {
             texture->prev->next = texture;
         }
         texture->native->prev = texture;
         texture->next = texture->native;
         renderer->textures = texture;
  
         if (SDL_ISPIXELFORMAT_FOURCC(texture->format)) {
 #if SDL_HAVE_YUV
             texture->yuv = SDL_SW_CreateYUVTexture(format, w, h);
 #else
             SDL_SetError("SDL not built with YUV support");
 #endif
             if (!texture->yuv) {
                 SDL_DestroyTexture(texture);
                 return NULL;
             }
         } else if (access == SDL_TEXTUREACCESS_STREAMING) {
             /* The pitch is 4 byte aligned */
             texture->pitch = (((w * SDL_BYTESPERPIXEL(format)) + 3) & ~3);
             texture->pixels = SDL_calloc(1, texture->pitch * h);
             if (!texture->pixels) {
                 SDL_DestroyTexture(texture);
                 return NULL;
             }
         }
     }
     return texture;
 }

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_CreateTexture(), 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_CreateTexture(), and SDL_CreateTextureFromSurface().

◆ SDL_CreateTextureFromSurface()

SDL_Texture* SDL_CreateTextureFromSurface	(	SDL_Renderer *	renderer,
		SDL_Surface *	surface
	)

Create a texture from an existing surface.

Parameters

renderer	The renderer.
surface	The 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 1165 of file SDL_render.c.

 {
     const SDL_PixelFormat *fmt;
     SDL_bool needAlpha;
     SDL_bool direct_update;
     int i;
     Uint32 format = SDL_PIXELFORMAT_UNKNOWN;
     SDL_Texture *texture;
  
     CHECK_RENDERER_MAGIC(renderer, NULL);
  
     if (!surface) {
         SDL_SetError("SDL_CreateTextureFromSurface() passed NULL surface");
         return NULL;
     }
  
     /* See what the best texture format is */
     fmt = surface->format;
     if (fmt->Amask || SDL_HasColorKey(surface)) {
         needAlpha = SDL_TRUE;
     } else {
         needAlpha = SDL_FALSE;
     }
  
     /* If Palette contains alpha values, promotes to alpha format */
     if (fmt->palette) {
         SDL_bool is_opaque, has_alpha_channel;
         SDL_DetectPalette(fmt->palette, &is_opaque, &has_alpha_channel);
         if (!is_opaque) {
             needAlpha = SDL_TRUE;
         }
     }
  
     /* Try to have the best pixel format for the texture */
     /* No alpha, but a colorkey => promote to alpha */
     if (!fmt->Amask && SDL_HasColorKey(surface)) {
         if (fmt->format == SDL_PIXELFORMAT_RGB888) {
             for (i = 0; i < (int)renderer->info.num_texture_formats; ++i) {
                 if (renderer->info.texture_formats[i] == SDL_PIXELFORMAT_ARGB8888) {
                     format = SDL_PIXELFORMAT_ARGB8888;
                     break;
                 }
             }
         } else if (fmt->format == SDL_PIXELFORMAT_BGR888) {
             for (i = 0; i < (int)renderer->info.num_texture_formats; ++i) {
                 if (renderer->info.texture_formats[i] == SDL_PIXELFORMAT_ABGR8888) {
                     format = SDL_PIXELFORMAT_ABGR8888;
                     break;
                 }
             }
         }
     } else {
         /* Exact match would be fine */
         for (i = 0; i < (int)renderer->info.num_texture_formats; ++i) {
             if (renderer->info.texture_formats[i] == fmt->format) {
                 format = fmt->format;
                 break;
             }
         }
     }
  
     /* Fallback, choose a valid pixel format */
     if (format == SDL_PIXELFORMAT_UNKNOWN) {
         format = renderer->info.texture_formats[0];
         for (i = 0; i < (int)renderer->info.num_texture_formats; ++i) {
             if (!SDL_ISPIXELFORMAT_FOURCC(renderer->info.texture_formats[i]) &&
                     SDL_ISPIXELFORMAT_ALPHA(renderer->info.texture_formats[i]) == needAlpha) {
                 format = renderer->info.texture_formats[i];
                 break;
             }
         }
     }
  
     texture = SDL_CreateTexture(renderer, format, SDL_TEXTUREACCESS_STATIC,
                                 surface->w, surface->h);
     if (!texture) {
         return NULL;
     }
  
     if (format == surface->format->format) {
         if (surface->format->Amask && SDL_HasColorKey(surface)) {
             /* Surface and Renderer formats are identicals. 
              * Intermediate conversion is needed to convert color key to alpha (SDL_ConvertColorkeyToAlpha()). */
             direct_update = SDL_FALSE;
         } else {
             /* Update Texture directly */
             direct_update = SDL_TRUE;
         }
     } else {
         /* Surface and Renderer formats are differents, it needs an intermediate conversion. */
         direct_update = SDL_FALSE;
     }
  
     if (direct_update) {
         if (SDL_MUSTLOCK(surface)) {
             SDL_LockSurface(surface);
             SDL_UpdateTexture(texture, NULL, surface->pixels, surface->pitch);
             SDL_UnlockSurface(surface);
         } else {
             SDL_UpdateTexture(texture, NULL, surface->pixels, surface->pitch);
         }
     } else {
         SDL_PixelFormat *dst_fmt;
         SDL_Surface *temp = NULL;
  
         /* Set up a destination surface for the texture update */
         dst_fmt = SDL_AllocFormat(format);
         if (!dst_fmt) {
            SDL_DestroyTexture(texture);
            return NULL;
         }
         temp = SDL_ConvertSurface(surface, dst_fmt, 0);
         SDL_FreeFormat(dst_fmt);
         if (temp) {
             SDL_UpdateTexture(texture, NULL, temp->pixels, temp->pitch);
             SDL_FreeSurface(temp);
         } else {
             SDL_DestroyTexture(texture);
             return NULL;
         }
     }
  
     {
         Uint8 r, g, b, a;
         SDL_BlendMode blendMode;
  
         SDL_GetSurfaceColorMod(surface, &r, &g, &b);
         SDL_SetTextureColorMod(texture, r, g, b);
  
         SDL_GetSurfaceAlphaMod(surface, &a);
         SDL_SetTextureAlphaMod(texture, a);
  
         if (SDL_HasColorKey(surface)) {
             /* We converted to a texture with alpha format */
             SDL_SetTextureBlendMode(texture, SDL_BLENDMODE_BLEND);
         } else {
             SDL_GetSurfaceBlendMode(surface, &blendMode);
             SDL_SetTextureBlendMode(texture, blendMode);
         }
     }
     return texture;
 }

References SDL_PixelFormat::Amask, blendMode, CHECK_RENDERER_MAGIC, SDL_PixelFormat::format, i, SDL_Renderer::info, int(), NULL, SDL_RendererInfo::num_texture_formats, SDL_PixelFormat::palette, SDL_Surface::pitch, SDL_Surface::pixels, renderer, SDL_AllocFormat, SDL_BLENDMODE_BLEND, SDL_ConvertSurface, SDL_CreateTexture(), SDL_DestroyTexture(), SDL_DetectPalette(), 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_PIXELFORMAT_ABGR8888, SDL_PIXELFORMAT_ARGB8888, SDL_PIXELFORMAT_BGR888, SDL_PIXELFORMAT_RGB888, SDL_PIXELFORMAT_UNKNOWN, 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

width	The width of the window
height	The height of the window
window_flags	The flags used to create the window
window	A pointer filled with the window, or NULL on error
renderer	A pointer filled with the renderer, or NULL on error

Returns: 0 on success, or -1 on error

Definition at line 752 of file SDL_render.c.

 {
     *window = SDL_CreateWindow(NULL, SDL_WINDOWPOS_UNDEFINED,
                                      SDL_WINDOWPOS_UNDEFINED,
                                      width, height, window_flags);
     if (!*window) {
         *renderer = NULL;
         return -1;
     }
  
     *renderer = SDL_CreateRenderer(*window, -1, 0);
     if (!*renderer) {
         return -1;
     }
  
     return 0;
 }

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 3227 of file SDL_render.c.

 {
     SDL_RenderCommand *cmd;
  
     CHECK_RENDERER_MAGIC(renderer, );
  
     SDL_DelEventWatch(SDL_RendererEventWatch, renderer);
  
     if (renderer->render_commands_tail != NULL) {
         renderer->render_commands_tail->next = renderer->render_commands_pool;
         cmd = renderer->render_commands;
     } else {
         cmd = renderer->render_commands_pool;
     }
  
     renderer->render_commands_pool = NULL;
     renderer->render_commands_tail = NULL;
     renderer->render_commands = NULL;
  
     while (cmd != NULL) {
         SDL_RenderCommand *next = cmd->next;
         SDL_free(cmd);
         cmd = next;
     }
  
     SDL_free(renderer->vertex_data);
  
     /* Free existing textures for this renderer */
     while (renderer->textures) {
         SDL_Texture *tex = renderer->textures; (void) tex;
         SDL_DestroyTexture(renderer->textures);
         SDL_assert(tex != renderer->textures);  /* satisfy static analysis. */
     }
  
     if (renderer->window) {
         SDL_SetWindowData(renderer->window, SDL_WINDOWRENDERDATA, NULL);
     }
  
     /* It's no longer magical... */
     renderer->magic = NULL;
  
     /* Free the target mutex */
     SDL_DestroyMutex(renderer->target_mutex);
     renderer->target_mutex = NULL;
  
     /* Free the renderer instance */
     renderer->DestroyRenderer(renderer);
 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::DestroyRenderer, SDL_Renderer::magic, SDL_RenderCommand::next, NULL, SDL_Renderer::render_commands, SDL_Renderer::render_commands_pool, SDL_Renderer::render_commands_tail, renderer, SDL_assert, SDL_DelEventWatch, SDL_DestroyMutex, SDL_DestroyTexture(), SDL_free, SDL_RendererEventWatch(), SDL_SetWindowData, SDL_WINDOWRENDERDATA, SDL_Renderer::target_mutex, SDL_Renderer::textures, SDL_Renderer::vertex_data, 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 3184 of file SDL_render.c.

 {
     SDL_Renderer *renderer;
  
     CHECK_TEXTURE_MAGIC(texture, );
  
     renderer = texture->renderer;
     if (texture == renderer->target) {
         SDL_SetRenderTarget(renderer, NULL);  /* implies command queue flush */
     } else {
         FlushRenderCommandsIfTextureNeeded(texture);
     }
  
     texture->magic = NULL;
  
     if (texture->next) {
         texture->next->prev = texture->prev;
     }
     if (texture->prev) {
         texture->prev->next = texture->next;
     } else {
         renderer->textures = texture->next;
     }
  
     if (texture->native) {
         SDL_DestroyTexture(texture->native);
     }
 #if SDL_HAVE_YUV
     if (texture->yuv) {
         SDL_SW_DestroyYUVTexture(texture->yuv);
     }
 #endif
     SDL_free(texture->pixels);
  
     renderer->DestroyTexture(renderer, texture);
  
     SDL_FreeSurface(texture->locked_surface);
     texture->locked_surface = NULL;
  
     SDL_free(texture);
 }

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

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

◆ 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

renderer	The renderer from which blend mode should be queried.
blendMode	A pointer filled in with the current blend mode.

Returns: 0 on success, or -1 on error

See also: SDL_SetRenderDrawBlendMode()

Definition at line 2267 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     *blendMode = renderer->blendMode;
     return 0;
 }

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

renderer	The renderer from which drawing color should be queried.
r	A pointer to the red value used to draw on the rendering target.
g	A pointer to the green value used to draw on the rendering target.
b	A pointer to the blue value used to draw on the rendering target.
a	A 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 2234 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (r) {
         *r = renderer->r;
     }
     if (g) {
         *g = renderer->g;
     }
     if (b) {
         *b = renderer->b;
     }
     if (a) {
         *a = renderer->a;
     }
     return 0;
 }

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

index	The index of the driver to query information about.
info	A 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 562 of file SDL_render.c.

 {
 #if !SDL_RENDER_DISABLED
     if (index < 0 || index >= SDL_GetNumRenderDrivers()) {
         return SDL_SetError("index must be in the range of 0 - %d",
                             SDL_GetNumRenderDrivers() - 1);
     }
     *info = render_drivers[index]->info;
     return 0;
 #else
     return SDL_SetError("SDL not built with rendering support");
 #endif
 }

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 960 of file SDL_render.c.

 {
     return (SDL_Renderer *)SDL_GetWindowData(window, SDL_WINDOWRENDERDATA);
 }

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 966 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     *info = renderer->info;
     return 0;
 }

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 975 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (renderer->target) {
         return SDL_QueryTexture(renderer->target, NULL, NULL, w, h);
     } else if (renderer->GetOutputSize) {
         return renderer->GetOutputSize(renderer, w, h);
     } else if (renderer->window) {
         SDL_GetWindowSize(renderer->window, w, h);
         return 0;
     } else {
         SDL_assert(0 && "This should never happen");
         return SDL_SetError("Renderer doesn't support querying output size");
     }
 }

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_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 1956 of file SDL_render.c.

 {
     return renderer->target;
 }

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

texture	The texture to query.
alpha	A 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 1384 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (alpha) {
         *alpha = texture->a;
     }
     return 0;
 }

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

texture	The texture to query.
blendMode	A 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 1413 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (blendMode) {
         *blendMode = texture->blendMode;
     }
     return 0;
 }

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

texture	The texture to query.
r	A pointer filled in with the current red color value.
g	A pointer filled in with the current green color value.
b	A 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 1349 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (r) {
         *r = texture->r;
     }
     if (g) {
         *g = texture->g;
     }
     if (b) {
         *b = texture->b;
     }
     return 0;
 }

References CHECK_TEXTURE_MAGIC.

◆ SDL_GetTextureScaleMode()

int SDL_GetTextureScaleMode	(	SDL_Texture *	texture,
		SDL_ScaleMode *	scaleMode
	)

Get the scale mode used for texture scale operations.

Parameters

texture	The texture to query.
scaleMode	A pointer filled in with the current scale mode.

Returns: 0 on success, or -1 if the texture is not valid.

See also: SDL_SetTextureScaleMode()

Definition at line 1440 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (scaleMode) {
         *scaleMode = texture->scaleMode;
     }
     return 0;
 }

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

texture	The SDL texture to bind
texw	A pointer to a float that will be filled with the texture width
texh	A 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 3276 of file SDL_render.c.

 {
     SDL_Renderer *renderer;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
     renderer = texture->renderer;
     if (texture->native) {
         return SDL_GL_BindTexture(texture->native, texw, texh);
     } else if (renderer && renderer->GL_BindTexture) {
         FlushRenderCommandsIfTextureNeeded(texture);  /* in case the app is going to mess with it. */
         return renderer->GL_BindTexture(renderer, texture, texw, texh);
     } else {
         return SDL_Unsupported();
     }
 }

References CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfTextureNeeded(), SDL_Renderer::GL_BindTexture, renderer, SDL_GL_BindTexture(), and SDL_Unsupported.

Referenced by SDL_GL_BindTexture().

◆ SDL_GL_UnbindTexture()

int SDL_GL_UnbindTexture ( SDL_Texture * texture )

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

Parameters

texture The SDL texture to unbind

Returns: 0 on success, or -1 if the operation is not supported

Definition at line 3292 of file SDL_render.c.

 {
     SDL_Renderer *renderer;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
     renderer = texture->renderer;
     if (texture->native) {
         return SDL_GL_UnbindTexture(texture->native);
     } else if (renderer && renderer->GL_UnbindTexture) {
         FlushRenderCommandsIfTextureNeeded(texture);  /* in case the app messed with it. */
         return renderer->GL_UnbindTexture(renderer, texture);
     }
  
     return SDL_Unsupported();
 }

References CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfTextureNeeded(), SDL_Renderer::GL_UnbindTexture, renderer, SDL_GL_UnbindTexture(), and SDL_Unsupported.

Referenced by SDL_GL_UnbindTexture().

◆ 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

texture	The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
rect	A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
pixels	This is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
pitch	This 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 1722 of file SDL_render.c.

 {
     SDL_Rect full_rect;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (texture->access != SDL_TEXTUREACCESS_STREAMING) {
         return SDL_SetError("SDL_LockTexture(): texture must be streaming");
     }
  
     if (!rect) {
         full_rect.x = 0;
         full_rect.y = 0;
         full_rect.w = texture->w;
         full_rect.h = texture->h;
         rect = &full_rect;
     }
  
 #if SDL_HAVE_YUV
     if (texture->yuv) {
         if (FlushRenderCommandsIfTextureNeeded(texture) < 0) {
             return -1;
         }
         return SDL_LockTextureYUV(texture, rect, pixels, pitch);
     } else
 #endif
     if (texture->native) {
         /* Calls a real SDL_LockTexture/SDL_UnlockTexture on unlock, flushing then. */
         return SDL_LockTextureNative(texture, rect, pixels, pitch);
     } else {
         SDL_Renderer *renderer = texture->renderer;
         if (FlushRenderCommandsIfTextureNeeded(texture) < 0) {
             return -1;
         }
         return renderer->LockTexture(renderer, texture, rect, pixels, pitch);
     }
 }

References CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfTextureNeeded(), 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_LockTextureToSurface(), SDL_UnlockTextureNative(), SDL_UnlockTextureYUV(), SDL_UpdateTextureNative(), SDL_UpdateTextureYUV(), and SDL_UpdateTextureYUVPlanar().

◆ SDL_LockTextureToSurface()

int SDL_LockTextureToSurface	(	SDL_Texture *	texture,
		const SDL_Rect *	rect,
		SDL_Surface **	surface
	)

Lock a portion of the texture for write-only pixel access. Expose it as a SDL surface.

Parameters

texture	The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING.
rect	A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked.
surface	This is filled in with a SDL surface representing the locked area Surface is freed internally after calling SDL_UnlockTexture or SDL_DestroyTexture.

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 1762 of file SDL_render.c.

 {
     SDL_Rect real_rect;
     void *pixels = NULL;
     int pitch = 0; /* fix static analysis */
     int ret;
  
     if (texture == NULL || surface == NULL) {
         return -1;
     }
  
     real_rect.x = 0;
     real_rect.y = 0;
     real_rect.w = texture->w;
     real_rect.h = texture->h;
  
     if (rect) {
         SDL_IntersectRect(rect, &real_rect, &real_rect);
     }
  
     ret = SDL_LockTexture(texture, &real_rect, &pixels, &pitch);
     if (ret < 0) {
         return ret;
     }
  
     texture->locked_surface = SDL_CreateRGBSurfaceWithFormatFrom(pixels, real_rect.w, real_rect.h, 0, pitch, texture->format);
     if (texture->locked_surface == NULL) {
         SDL_UnlockTexture(texture);
         return -1;
     }
  
     *surface = texture->locked_surface;
     return 0;
 }

References SDL_Rect::h, NULL, rect, SDL_CreateRGBSurfaceWithFormatFrom, SDL_IntersectRect, SDL_LockTexture(), SDL_UnlockTexture(), SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

◆ SDL_QueryTexture()

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

Query the attributes of a texture.

Parameters

texture	A texture to be queried.
format	A pointer filled in with the raw format of the texture. The actual format may differ, but pixel transfers will use this format.
access	A pointer filled in with the actual access to the texture.
w	A pointer filled in with the width of the texture in pixels.
h	A 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 1309 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (format) {
         *format = texture->format;
     }
     if (access) {
         *access = texture->access;
     }
     if (w) {
         *w = texture->w;
     }
     if (h) {
         *h = texture->h;
     }
     return 0;
 }

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 2276 of file SDL_render.c.

 {
     int retval;
     CHECK_RENDERER_MAGIC(renderer, -1);
     retval = QueueCmdClear(renderer);
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), QueueCmdClear(), renderer, and retval.

◆ 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

renderer	The renderer which should copy parts of a texture.
texture	The source texture.
srcrect	A pointer to the source rectangle, or NULL for the entire texture.
dstrect	A pointer to the destination rectangle, or NULL for the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2952 of file SDL_render.c.

 {
     SDL_FRect dstfrect;
     SDL_FRect *pdstfrect = NULL;
     if (dstrect) {
         dstfrect.x = (float) dstrect->x;
         dstfrect.y = (float) dstrect->y;
         dstfrect.w = (float) dstrect->w;
         dstfrect.h = (float) dstrect->h;
         pdstfrect = &dstfrect;
     }
     return SDL_RenderCopyF(renderer, texture, srcrect, pdstfrect);
 }

References SDL_Rect::h, SDL_FRect::h, NULL, renderer, SDL_RenderCopyF(), SDL_Rect::w, SDL_FRect::w, SDL_Rect::x, SDL_FRect::x, SDL_Rect::y, and SDL_FRect::y.

◆ 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

renderer	The renderer which should copy parts of a texture.
texture	The source texture.
srcrect	A pointer to the source rectangle, or NULL for the entire texture.
dstrect	A pointer to the destination rectangle, or NULL for the entire rendering target.
angle	An angle in degrees that indicates the rotation that will be applied to dstrect, rotating it in a clockwise direction
center	A 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).
flip	An SDL_RendererFlip value stating which flipping actions should be performed on the texture

Returns: 0 on success, or -1 on error

Definition at line 3027 of file SDL_render.c.

 {
     SDL_FRect dstfrect;
     SDL_FRect *pdstfrect = NULL;
     SDL_FPoint fcenter;
     SDL_FPoint *pfcenter = NULL;
  
     if (dstrect) {
         dstfrect.x = (float) dstrect->x;
         dstfrect.y = (float) dstrect->y;
         dstfrect.w = (float) dstrect->w;
         dstfrect.h = (float) dstrect->h;
         pdstfrect = &dstfrect;
     }
  
     if (center) {
         fcenter.x = (float) center->x;
         fcenter.y = (float) center->y;
         pfcenter = &fcenter;
     }
  
     return SDL_RenderCopyExF(renderer, texture, srcrect, pdstfrect, angle, pfcenter, flip);
 }

References SDL_Rect::h, SDL_FRect::h, NULL, renderer, SDL_RenderCopyExF(), SDL_Rect::w, SDL_FRect::w, SDL_Point::x, SDL_FPoint::x, SDL_Rect::x, SDL_FRect::x, SDL_Point::y, SDL_FPoint::y, SDL_Rect::y, and SDL_FRect::y.

◆ SDL_RenderCopyExF()

int SDL_RenderCopyExF	(	SDL_Renderer *	renderer,
		SDL_Texture *	texture,
		const SDL_Rect *	srcrect,
		const SDL_FRect *	dstrect,
		const double	angle,
		const SDL_FPoint *	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

renderer	The renderer which should copy parts of a texture.
texture	The source texture.
srcrect	A pointer to the source rectangle, or NULL for the entire texture.
dstrect	A pointer to the destination rectangle, or NULL for the entire rendering target.
angle	An angle in degrees that indicates the rotation that will be applied to dstrect, rotating it in a clockwise direction
center	A 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).
flip	An SDL_RendererFlip value stating which flipping actions should be performed on the texture

Returns: 0 on success, or -1 on error

Definition at line 3054 of file SDL_render.c.

 {
     SDL_Rect real_srcrect;
     SDL_FRect real_dstrect;
     SDL_FPoint real_center;
     int retval;
  
     if (flip == SDL_FLIP_NONE && (int)(angle/360) == angle/360) { /* fast path when we don't need rotation or flipping */
         return SDL_RenderCopyF(renderer, texture, srcrect, dstrect);
     }
  
     CHECK_RENDERER_MAGIC(renderer, -1);
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (renderer != texture->renderer) {
         return SDL_SetError("Texture was not created with this renderer");
     }
     if (!renderer->QueueCopyEx) {
         return SDL_SetError("Renderer does not support RenderCopyEx");
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     real_srcrect.x = 0;
     real_srcrect.y = 0;
     real_srcrect.w = texture->w;
     real_srcrect.h = texture->h;
     if (srcrect) {
         if (!SDL_IntersectRect(srcrect, &real_srcrect, &real_srcrect)) {
             return 0;
         }
     }
  
     /* We don't intersect the dstrect with the viewport as RenderCopy does because of potential rotation clipping issues... TODO: should we? */
     if (dstrect) {
         real_dstrect = *dstrect;
     } else {
         SDL_Rect r;
         SDL_zero(r);
         SDL_RenderGetViewport(renderer, &r);
         real_dstrect.x = 0.0f;
         real_dstrect.y = 0.0f;
         real_dstrect.w = (float) r.w;
         real_dstrect.h = (float) r.h;
     }
  
     if (texture->native) {
         texture = texture->native;
     }
  
     if (center) {
         real_center = *center;
     } else {
         real_center.x = real_dstrect.w / 2.0f;
         real_center.y = real_dstrect.h / 2.0f;
     }
  
     real_dstrect.x *= renderer->scale.x;
     real_dstrect.y *= renderer->scale.y;
     real_dstrect.w *= renderer->scale.x;
     real_dstrect.h *= renderer->scale.y;
  
     real_center.x *= renderer->scale.x;
     real_center.y *= renderer->scale.y;
  
     texture->last_command_generation = renderer->render_command_generation;
  
     retval = QueueCmdCopyEx(renderer, texture, &real_srcrect, &real_dstrect, angle, &real_center, flip);
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Rect::h, SDL_FRect::h, SDL_Renderer::hidden, QueueCmdCopyEx(), SDL_Renderer::QueueCopyEx, SDL_Renderer::render_command_generation, renderer, retval, SDL_Renderer::scale, SDL_FLIP_NONE, SDL_IntersectRect, SDL_RenderCopyF(), SDL_RenderGetViewport(), SDL_SetError, SDL_zero, SDL_Rect::w, SDL_FRect::w, SDL_FPoint::x, SDL_Rect::x, SDL_FRect::x, SDL_FPoint::y, SDL_Rect::y, and SDL_FRect::y.

Referenced by SDL_RenderCopyEx().

◆ SDL_RenderCopyF()

int SDL_RenderCopyF	(	SDL_Renderer *	renderer,
		SDL_Texture *	texture,
		const SDL_Rect *	srcrect,
		const SDL_FRect *	dstrect
	)

Copy a portion of the texture to the current rendering target.

Parameters

renderer	The renderer which should copy parts of a texture.
texture	The source texture.
srcrect	A pointer to the source rectangle, or NULL for the entire texture.
dstrect	A pointer to the destination rectangle, or NULL for the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2968 of file SDL_render.c.

 {
     SDL_Rect real_srcrect;
     SDL_FRect real_dstrect;
     SDL_Rect r;
     int retval;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (renderer != texture->renderer) {
         return SDL_SetError("Texture was not created with this renderer");
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     real_srcrect.x = 0;
     real_srcrect.y = 0;
     real_srcrect.w = texture->w;
     real_srcrect.h = texture->h;
     if (srcrect) {
         if (!SDL_IntersectRect(srcrect, &real_srcrect, &real_srcrect)) {
             return 0;
         }
     }
  
     SDL_zero(r);
     SDL_RenderGetViewport(renderer, &r);
     real_dstrect.x = 0.0f;
     real_dstrect.y = 0.0f;
     real_dstrect.w = (float) r.w;
     real_dstrect.h = (float) r.h;
     if (dstrect) {
         if (!SDL_HasIntersectionF(dstrect, &real_dstrect)) {
             return 0;
         }
         real_dstrect = *dstrect;
     }
  
     if (texture->native) {
         texture = texture->native;
     }
  
     real_dstrect.x *= renderer->scale.x;
     real_dstrect.y *= renderer->scale.y;
     real_dstrect.w *= renderer->scale.x;
     real_dstrect.h *= renderer->scale.y;
  
     texture->last_command_generation = renderer->render_command_generation;
  
     retval = QueueCmdCopy(renderer, texture, &real_srcrect, &real_dstrect);
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Rect::h, SDL_FRect::h, SDL_Renderer::hidden, QueueCmdCopy(), SDL_Renderer::render_command_generation, renderer, retval, SDL_Renderer::scale, SDL_HasIntersectionF(), SDL_IntersectRect, SDL_RenderGetViewport(), SDL_SetError, SDL_zero, SDL_Rect::w, SDL_FRect::w, SDL_FPoint::x, SDL_Rect::x, SDL_FRect::x, SDL_FPoint::y, SDL_Rect::y, and SDL_FRect::y.

Referenced by SDL_RenderCopy(), and SDL_RenderCopyExF().

◆ 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

renderer	The renderer which should draw a line.
x1	The x coordinate of the start point.
y1	The y coordinate of the start point.
x2	The x coordinate of the end point.
y2	The y coordinate of the end point.

Returns: 0 on success, or -1 on error

Definition at line 2447 of file SDL_render.c.

 {
     SDL_FPoint points[2];
     points[0].x = (float) x1;
     points[0].y = (float) y1;
     points[1].x = (float) x2;
     points[1].y = (float) y2;
     return SDL_RenderDrawLinesF(renderer, points, 2);
 }

References renderer, SDL_RenderDrawLinesF(), and SDL_FPoint::x.

◆ SDL_RenderDrawLineF()

int SDL_RenderDrawLineF	(	SDL_Renderer *	renderer,
		float	x1,
		float	y1,
		float	x2,
		float	y2
	)

Draw a line on the current rendering target.

Parameters

renderer	The renderer which should draw a line.
x1	The x coordinate of the start point.
y1	The y coordinate of the start point.
x2	The x coordinate of the end point.
y2	The y coordinate of the end point.

Returns: 0 on success, or -1 on error

Definition at line 2458 of file SDL_render.c.

 {
     SDL_FPoint points[2];
     points[0].x = x1;
     points[0].y = y1;
     points[1].x = x2;
     points[1].y = y2;
     return SDL_RenderDrawLinesF(renderer, points, 2);
 }

References renderer, SDL_RenderDrawLinesF(), and SDL_FPoint::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

renderer	The renderer which should draw multiple lines.
points	The points along the lines
count	The number of points, drawing count-1 lines

Returns: 0 on success, or -1 on error

Definition at line 2579 of file SDL_render.c.

 {
     SDL_FPoint *fpoints;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!points) {
         return SDL_SetError("SDL_RenderDrawLines(): Passed NULL points");
     }
     if (count < 2) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
         return RenderDrawLinesWithRects(renderer, points, count);
     }
  
     fpoints = SDL_small_alloc(SDL_FPoint, count, &isstack);
     if (!fpoints) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         fpoints[i].x = points[i].x * renderer->scale.x;
         fpoints[i].y = points[i].y * renderer->scale.y;
     }
  
     retval = QueueCmdDrawLines(renderer, fpoints, count);
  
     SDL_small_free(fpoints, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Renderer::hidden, i, QueueCmdDrawLines(), RenderDrawLinesWithRects(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_RenderDrawLinesF()

int SDL_RenderDrawLinesF	(	SDL_Renderer *	renderer,
		const SDL_FPoint *	points,
		int	count
	)

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

Parameters

renderer	The renderer which should draw multiple lines.
points	The points along the lines
count	The number of points, drawing count-1 lines

Returns: 0 on success, or -1 on error

Definition at line 2622 of file SDL_render.c.

 {
     SDL_FPoint *fpoints;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!points) {
         return SDL_SetError("SDL_RenderDrawLines(): Passed NULL points");
     }
     if (count < 2) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
         return RenderDrawLinesWithRectsF(renderer, points, count);
     }
  
     fpoints = SDL_small_alloc(SDL_FPoint, count, &isstack);
     if (!fpoints) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         fpoints[i].x = points[i].x * renderer->scale.x;
         fpoints[i].y = points[i].y * renderer->scale.y;
     }
  
     retval = QueueCmdDrawLines(renderer, fpoints, count);
  
     SDL_small_free(fpoints, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Renderer::hidden, i, QueueCmdDrawLines(), RenderDrawLinesWithRectsF(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_RenderDrawLine(), SDL_RenderDrawLineF(), and SDL_RenderDrawRectF().

◆ SDL_RenderDrawPoint()

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

Draw a point on the current rendering target.

Parameters

renderer	The renderer which should draw a point.
x	The x coordinate of the point.
y	The y coordinate of the point.

Returns: 0 on success, or -1 on error

Definition at line 2289 of file SDL_render.c.

 {
     SDL_FPoint fpoint;
     fpoint.x = (float) x;
     fpoint.y = (float) y;
     return SDL_RenderDrawPointsF(renderer, &fpoint, 1);
 }

References renderer, SDL_RenderDrawPointsF(), SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_RenderDrawPointF()

int SDL_RenderDrawPointF	(	SDL_Renderer *	renderer,
		float	x,
		float	y
	)

Draw a point on the current rendering target.

Parameters

renderer	The renderer which should draw a point.
x	The x coordinate of the point.
y	The y coordinate of the point.

Returns: 0 on success, or -1 on error

Definition at line 2298 of file SDL_render.c.

 {
     SDL_FPoint fpoint;
     fpoint.x = x;
     fpoint.y = y;
     return SDL_RenderDrawPointsF(renderer, &fpoint, 1);
 }

References renderer, SDL_RenderDrawPointsF(), SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_RenderDrawPoints()

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

Draw multiple points on the current rendering target.

Parameters

renderer	The renderer which should draw multiple points.
points	The points to draw
count	The number of points to draw

Returns: 0 on success, or -1 on error

Definition at line 2334 of file SDL_render.c.

 {
     SDL_FPoint *fpoints;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!points) {
         return SDL_SetError("SDL_RenderDrawPoints(): Passed NULL points");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
         return RenderDrawPointsWithRects(renderer, points, count);
     }
  
     fpoints = SDL_small_alloc(SDL_FPoint, count, &isstack);
     if (!fpoints) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         fpoints[i].x = points[i].x * renderer->scale.x;
         fpoints[i].y = points[i].y * renderer->scale.y;
     }
  
     retval = QueueCmdDrawPoints(renderer, fpoints, count);
  
     SDL_small_free(fpoints, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Renderer::hidden, i, QueueCmdDrawPoints(), RenderDrawPointsWithRects(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FPoint::x, and SDL_FPoint::y.

◆ SDL_RenderDrawPointsF()

int SDL_RenderDrawPointsF	(	SDL_Renderer *	renderer,
		const SDL_FPoint *	points,
		int	count
	)

Draw multiple points on the current rendering target.

Parameters

renderer	The renderer which should draw multiple points.
points	The points to draw
count	The number of points to draw

Returns: 0 on success, or -1 on error

Definition at line 2404 of file SDL_render.c.

 {
     SDL_FPoint *fpoints;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!points) {
         return SDL_SetError("SDL_RenderDrawFPoints(): Passed NULL points");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     if (renderer->scale.x != 1.0f || renderer->scale.y != 1.0f) {
         return RenderDrawPointsWithRectsF(renderer, points, count);
     }
  
     fpoints = SDL_small_alloc(SDL_FPoint, count, &isstack);
     if (!fpoints) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         fpoints[i].x = points[i].x * renderer->scale.x;
         fpoints[i].y = points[i].y * renderer->scale.y;
     }
  
     retval = QueueCmdDrawPoints(renderer, fpoints, count);
  
     SDL_small_free(fpoints, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Renderer::hidden, i, QueueCmdDrawPoints(), RenderDrawPointsWithRectsF(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FPoint::x, and SDL_FPoint::y.

Referenced by SDL_RenderDrawPoint(), and SDL_RenderDrawPointF().

◆ SDL_RenderDrawRect()

int SDL_RenderDrawRect	(	SDL_Renderer *	renderer,
		const SDL_Rect *	rect
	)

Draw a rectangle on the current rendering target.

Parameters

renderer	The renderer which should draw a rectangle.
rect	A pointer to the destination rectangle, or NULL to outline the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2665 of file SDL_render.c.

 {
     SDL_FRect frect;
     SDL_FRect *prect = NULL;
  
     if (rect) {
         frect.x = (float) rect->x;
         frect.y = (float) rect->y;
         frect.w = (float) rect->w;
         frect.h = (float) rect->h;
         prect = &frect;
     }
  
     return SDL_RenderDrawRectF(renderer, prect);
 }

References SDL_Rect::h, SDL_FRect::h, NULL, rect, renderer, SDL_RenderDrawRectF(), SDL_Rect::w, SDL_FRect::w, SDL_Rect::x, SDL_FRect::x, SDL_Rect::y, and SDL_FRect::y.

Referenced by SDL_RenderDrawRects().

◆ SDL_RenderDrawRectF()

int SDL_RenderDrawRectF	(	SDL_Renderer *	renderer,
		const SDL_FRect *	rect
	)

Draw a rectangle on the current rendering target.

Parameters

renderer	The renderer which should draw a rectangle.
rect	A pointer to the destination rectangle, or NULL to outline the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2682 of file SDL_render.c.

 {
     SDL_FRect frect;
     SDL_FPoint points[5];
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     /* If 'rect' == NULL, then outline the whole surface */
     if (!rect) {
         SDL_Rect r;
         SDL_RenderGetViewport(renderer, &r);
         frect.x = 0.0f;
         frect.y = 0.0f;
         frect.w = (float) r.w;
         frect.h = (float) r.h;
         rect = &frect;
     }
  
     points[0].x = rect->x;
     points[0].y = rect->y;
     points[1].x = rect->x+rect->w-1;
     points[1].y = rect->y;
     points[2].x = rect->x+rect->w-1;
     points[2].y = rect->y+rect->h-1;
     points[3].x = rect->x;
     points[3].y = rect->y+rect->h-1;
     points[4].x = rect->x;
     points[4].y = rect->y;
     return SDL_RenderDrawLinesF(renderer, points, 5);
 }

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

Referenced by SDL_RenderDrawRect(), and SDL_RenderDrawRectsF().

◆ 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

renderer	The renderer which should draw multiple rectangles.
rects	A pointer to an array of destination rectangles.
count	The number of rectangles.

Returns: 0 on success, or -1 on error

Definition at line 2714 of file SDL_render.c.

 {
     int i;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!rects) {
         return SDL_SetError("SDL_RenderDrawRects(): Passed NULL rects");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     for (i = 0; i < count; ++i) {
         if (SDL_RenderDrawRect(renderer, &rects[i]) < 0) {
             return -1;
         }
     }
     return 0;
 }

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

◆ SDL_RenderDrawRectsF()

int SDL_RenderDrawRectsF	(	SDL_Renderer *	renderer,
		const SDL_FRect *	rects,
		int	count
	)

Draw some number of rectangles on the current rendering target.

Parameters

renderer	The renderer which should draw multiple rectangles.
rects	A pointer to an array of destination rectangles.
count	The number of rectangles.

Returns: 0 on success, or -1 on error

Definition at line 2742 of file SDL_render.c.

 {
     int i;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!rects) {
         return SDL_SetError("SDL_RenderDrawRects(): Passed NULL rects");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     for (i = 0; i < count; ++i) {
         if (SDL_RenderDrawRectF(renderer, &rects[i]) < 0) {
             return -1;
         }
     }
     return 0;
 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::hidden, i, renderer, SDL_RenderDrawRectF(), 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

renderer	The renderer which should fill a rectangle.
rect	A pointer to the destination rectangle, or NULL for the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2770 of file SDL_render.c.

 {
     SDL_FRect frect;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     /* If 'rect' == NULL, then outline the whole surface */
     if (rect) {
         frect.x = (float) rect->x;
         frect.y = (float) rect->y;
         frect.w = (float) rect->w;
         frect.h = (float) rect->h;
     } else {
         SDL_Rect r;
         SDL_zero(r);
         SDL_RenderGetViewport(renderer, &r);
         frect.x = 0.0f;
         frect.y = 0.0f;
         frect.w = (float) r.w;
         frect.h = (float) r.h;
     }
     return SDL_RenderFillRectsF(renderer, &frect, 1);
 }

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

◆ SDL_RenderFillRectF()

int SDL_RenderFillRectF	(	SDL_Renderer *	renderer,
		const SDL_FRect *	rect
	)

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

Parameters

renderer	The renderer which should fill a rectangle.
rect	A pointer to the destination rectangle, or NULL for the entire rendering target.

Returns: 0 on success, or -1 on error

Definition at line 2795 of file SDL_render.c.

 {
     SDL_FRect frect;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     /* If 'rect' == NULL, then outline the whole surface */
     if (!rect) {
         SDL_Rect r;
         SDL_zero(r);
         SDL_RenderGetViewport(renderer, &r);
         frect.x = 0.0f;
         frect.y = 0.0f;
         frect.w = (float) r.w;
         frect.h = (float) r.h;
         rect = &frect;
     }
     return SDL_RenderFillRectsF(renderer, rect, 1);
 }

References CHECK_RENDERER_MAGIC, SDL_FRect::h, rect, renderer, SDL_RenderFillRectsF(), SDL_RenderGetViewport(), SDL_zero, SDL_FRect::w, SDL_FRect::x, and SDL_FRect::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

renderer	The renderer which should fill multiple rectangles.
rects	A pointer to an array of destination rectangles.
count	The number of rectangles.

Returns: 0 on success, or -1 on error

Definition at line 2816 of file SDL_render.c.

 {
     SDL_FRect *frects;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!rects) {
         return SDL_SetError("SDL_RenderFillRects(): Passed NULL rects");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     frects = SDL_small_alloc(SDL_FRect, count, &isstack);
     if (!frects) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         frects[i].x = rects[i].x * renderer->scale.x;
         frects[i].y = rects[i].y * renderer->scale.y;
         frects[i].w = rects[i].w * renderer->scale.x;
         frects[i].h = rects[i].h * renderer->scale.y;
     }
  
     retval = QueueCmdFillRects(renderer, frects, count);
  
     SDL_small_free(frects, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_FRect::h, SDL_Renderer::hidden, i, QueueCmdFillRects(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FRect::w, SDL_FPoint::x, SDL_FRect::x, SDL_FPoint::y, and SDL_FRect::y.

◆ SDL_RenderFillRectsF()

int SDL_RenderFillRectsF	(	SDL_Renderer *	renderer,
		const SDL_FRect *	rects,
		int	count
	)

Fill some number of rectangles on the current rendering target with the drawing color.

Parameters

renderer	The renderer which should fill multiple rectangles.
rects	A pointer to an array of destination rectangles.
count	The number of rectangles.

Returns: 0 on success, or -1 on error

Definition at line 2857 of file SDL_render.c.

 {
     SDL_FRect *frects;
     int i;
     int retval;
     SDL_bool isstack;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!rects) {
         return SDL_SetError("SDL_RenderFillFRects(): Passed NULL rects");
     }
     if (count < 1) {
         return 0;
     }
  
     /* Don't draw while we're hidden */
     if (renderer->hidden) {
         return 0;
     }
  
     frects = SDL_small_alloc(SDL_FRect, count, &isstack);
     if (!frects) {
         return SDL_OutOfMemory();
     }
     for (i = 0; i < count; ++i) {
         frects[i].x = rects[i].x * renderer->scale.x;
         frects[i].y = rects[i].y * renderer->scale.y;
         frects[i].w = rects[i].w * renderer->scale.x;
         frects[i].h = rects[i].h * renderer->scale.y;
     }
  
     retval = QueueCmdFillRects(renderer, frects, count);
  
     SDL_small_free(frects, isstack);
  
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_FRect::h, SDL_Renderer::hidden, i, QueueCmdFillRects(), renderer, retval, SDL_Renderer::scale, SDL_OutOfMemory, SDL_SetError, SDL_small_alloc, SDL_small_free, SDL_FRect::w, SDL_FPoint::x, SDL_FRect::x, SDL_FPoint::y, and SDL_FRect::y.

Referenced by SDL_RenderFillRect(), and SDL_RenderFillRectF().

◆ SDL_RenderFlush()

int SDL_RenderFlush ( SDL_Renderer * renderer )

Force the rendering context to flush any pending commands to the underlying rendering API.

You do not need to (and in fact, shouldn't) call this function unless you are planning to call into OpenGL/Direct3D/Metal/whatever directly in addition to using an SDL_Renderer.

This is for a very-specific case: if you are using SDL's render API, you asked for a specific renderer backend (OpenGL, Direct3D, etc), you set SDL_HINT_RENDER_BATCHING to "1", and you plan to make OpenGL/D3D/whatever calls in addition to SDL render API calls. If all of this applies, you should call SDL_RenderFlush() between calls to SDL's render API and the low-level API you're using in cooperation.

In all other cases, you can ignore this function. This is only here to get maximum performance out of a specific situation. In all other cases, SDL will do the right thing, perhaps at a performance loss.

This function is first available in SDL 2.0.10, and is not needed in 2.0.9 and earlier, as earlier versions did not queue rendering commands at all, instead flushing them to the OS immediately.

Definition at line 256 of file SDL_render.c.

 {
     return FlushRenderCommands(renderer);
 }

References FlushRenderCommands(), and renderer.

◆ SDL_RenderGetClipRect()

void SDL_RenderGetClipRect	(	SDL_Renderer *	renderer,
		SDL_Rect *	rect
	)

Get the clip rectangle for the current target.

Parameters

renderer	The renderer from which clip rectangle should be queried.
rect	A pointer filled in with the current clip rectangle, or an empty rectangle if clipping is disabled.

See also: SDL_RenderSetClipRect()

Definition at line 2178 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, )
  
     if (rect) {
         rect->x = (int)(renderer->clip_rect.x / renderer->scale.x);
         rect->y = (int)(renderer->clip_rect.y / renderer->scale.y);
         rect->w = (int)(renderer->clip_rect.w / renderer->scale.x);
         rect->h = (int)(renderer->clip_rect.h / renderer->scale.y);
     }
 }

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

◆ SDL_RenderGetIntegerScale()

SDL_bool SDL_RenderGetIntegerScale ( SDL_Renderer * renderer )

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

Parameters

renderer The renderer from which integer scaling should be queried.

See also: SDL_RenderSetIntegerScale()

Definition at line 2114 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, SDL_FALSE);
  
     return renderer->integer_scale;
 }

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

renderer	The renderer from which resolution should be queried.
w	A pointer filled with the width of the logical resolution
h	A pointer filled with the height of the logical resolution

See also: SDL_RenderSetLogicalSize()

Definition at line 2091 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, );
  
     if (w) {
         *w = renderer->logical_w;
     }
     if (h) {
         *h = renderer->logical_h;
     }
 }

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

renderer The 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 3321 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, NULL);
  
     if (renderer->GetMetalCommandEncoder) {
         FlushRenderCommands(renderer);  /* in case the app is going to mess with it. */
         return renderer->GetMetalCommandEncoder(renderer);
     }
     return NULL;
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommands(), SDL_Renderer::GetMetalCommandEncoder, NULL, and renderer.

◆ SDL_RenderGetMetalLayer()

void* SDL_RenderGetMetalLayer ( SDL_Renderer * renderer )

Get the CAMetalLayer associated with the given Metal renderer.

Parameters

renderer The renderer to query

Returns: CAMetalLayer* on success, or NULL if the renderer isn't a Metal renderer

See also: SDL_RenderGetMetalCommandEncoder()

Definition at line 3309 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, NULL);
  
     if (renderer->GetMetalLayer) {
         FlushRenderCommands(renderer);  /* in case the app is going to mess with it. */
         return renderer->GetMetalLayer(renderer);
     }
     return NULL;
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommands(), 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

renderer	The renderer from which drawing scale should be queried.
scaleX	A pointer filled in with the horizontal scaling factor
scaleY	A pointer filled in with the vertical scaling factor

See also: SDL_RenderSetScale()

Definition at line 2208 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, );
  
     if (scaleX) {
         *scaleX = renderer->scale.x;
     }
     if (scaleY) {
         *scaleY = renderer->scale.y;
     }
 }

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 2144 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, );
  
     if (rect) {
         rect->x = (int)(renderer->viewport.x / renderer->scale.x);
         rect->y = (int)(renderer->viewport.y / renderer->scale.y);
         rect->w = (int)(renderer->viewport.w / renderer->scale.x);
         rect->h = (int)(renderer->viewport.h / renderer->scale.y);
     }
 }

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

Referenced by SDL_RenderCopyExF(), SDL_RenderCopyF(), SDL_RenderDrawRectF(), SDL_RenderFillRect(), and SDL_RenderFillRectF().

◆ SDL_RenderIsClipEnabled()

SDL_bool SDL_RenderIsClipEnabled ( SDL_Renderer * renderer )

Get whether clipping is enabled on the given renderer.

Parameters

renderer The renderer from which clip state should be queried.

See also: SDL_RenderGetClipRect()

Definition at line 2191 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, SDL_FALSE)
     return renderer->clipping_enabled;
 }

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 3170 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, );
  
     FlushRenderCommands(renderer);  /* time to send everything to the GPU! */
  
     /* Don't present while we're hidden */
     if (renderer->hidden) {
         return;
     }
     renderer->RenderPresent(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommands(), 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

renderer	The renderer from which pixels should be read.
rect	A pointer to the rectangle to read, or NULL for the entire render target.
format	The desired format of the pixel data, or 0 to use the format of the rendering target
pixels	A pointer to be filled in with the pixel data
pitch	The 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 3131 of file SDL_render.c.

 {
     SDL_Rect real_rect;
  
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!renderer->RenderReadPixels) {
         return SDL_Unsupported();
     }
  
     FlushRenderCommands(renderer);  /* we need to render before we read the results. */
  
     if (!format) {
         format = SDL_GetWindowPixelFormat(renderer->window);
     }
  
     real_rect.x = renderer->viewport.x;
     real_rect.y = renderer->viewport.y;
     real_rect.w = renderer->viewport.w;
     real_rect.h = renderer->viewport.h;
     if (rect) {
         if (!SDL_IntersectRect(rect, &real_rect, &real_rect)) {
             return 0;
         }
         if (real_rect.y > rect->y) {
             pixels = (Uint8 *)pixels + pitch * (real_rect.y - rect->y);
         }
         if (real_rect.x > rect->x) {
             int bpp = SDL_BYTESPERPIXEL(format);
             pixels = (Uint8 *)pixels + bpp * (real_rect.x - rect->x);
         }
     }
  
     return renderer->RenderReadPixels(renderer, &real_rect,
                                       format, pixels, pitch);
 }

References bpp, CHECK_RENDERER_MAGIC, FlushRenderCommands(), 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

renderer	The renderer for which clip rectangle should be set.
rect	A pointer to the rectangle to set as the clip rectangle, relative to the viewport, or NULL to disable clipping.

Returns: 0 on success, or -1 on error

See also: SDL_RenderGetClipRect()

Definition at line 2157 of file SDL_render.c.

 {
     int retval;
     CHECK_RENDERER_MAGIC(renderer, -1)
  
     if (rect) {
         renderer->clipping_enabled = SDL_TRUE;
         renderer->clip_rect.x = (int)SDL_floor(rect->x * renderer->scale.x);
         renderer->clip_rect.y = (int)SDL_floor(rect->y * renderer->scale.y);
         renderer->clip_rect.w = (int)SDL_ceil(rect->w * renderer->scale.x);
         renderer->clip_rect.h = (int)SDL_ceil(rect->h * renderer->scale.y);
     } else {
         renderer->clipping_enabled = SDL_FALSE;
         SDL_zero(renderer->clip_rect);
     }
  
     retval = QueueCmdSetClipRect(renderer);
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, SDL_Renderer::clip_rect, SDL_Renderer::clipping_enabled, FlushRenderCommandsIfNotBatching(), SDL_Rect::h, int(), QueueCmdSetClipRect(), rect, renderer, retval, SDL_Renderer::scale, SDL_ceil, SDL_FALSE, SDL_floor, SDL_TRUE, SDL_zero, SDL_Rect::w, SDL_FPoint::x, SDL_Rect::x, SDL_FPoint::y, and SDL_Rect::y.

◆ SDL_RenderSetIntegerScale()

int SDL_RenderSetIntegerScale	(	SDL_Renderer *	renderer,
		SDL_bool	enable
	)

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

Parameters

renderer	The renderer for which integer scaling should be set.
enable	Enable 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 2104 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     renderer->integer_scale = enable;
  
     return UpdateLogicalSize(renderer);
 }

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

renderer	The renderer for which resolution should be set.
w	The width of the logical resolution
h	The 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 2071 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!w || !h) {
         /* Clear any previous logical resolution */
         renderer->logical_w = 0;
         renderer->logical_h = 0;
         SDL_RenderSetViewport(renderer, NULL);
         SDL_RenderSetScale(renderer, 1.0f, 1.0f);
         return 0;
     }
  
     renderer->logical_w = w;
     renderer->logical_h = h;
  
     return UpdateLogicalSize(renderer);
 }

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

renderer	The renderer for which the drawing scale should be set.
scaleX	The horizontal scaling factor
scaleY	The 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 2198 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     renderer->scale.x = scaleX;
     renderer->scale.y = scaleY;
     return 0;
 }

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

renderer	The renderer for which the drawing area should be set.
rect	The 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 2122 of file SDL_render.c.

 {
     int retval;
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (rect) {
         renderer->viewport.x = (int)SDL_floor(rect->x * renderer->scale.x);
         renderer->viewport.y = (int)SDL_floor(rect->y * renderer->scale.y);
         renderer->viewport.w = (int)SDL_ceil(rect->w * renderer->scale.x);
         renderer->viewport.h = (int)SDL_ceil(rect->h * renderer->scale.y);
     } else {
         renderer->viewport.x = 0;
         renderer->viewport.y = 0;
         if (SDL_GetRendererOutputSize(renderer, &renderer->viewport.w, &renderer->viewport.h) < 0) {
             return -1;
         }
     }
     retval = QueueCmdSetViewport(renderer);
     return retval < 0 ? retval : FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_RENDERER_MAGIC, FlushRenderCommandsIfNotBatching(), SDL_Rect::h, int(), QueueCmdSetViewport(), rect, renderer, retval, SDL_Renderer::scale, SDL_ceil, SDL_floor, SDL_GetRendererOutputSize(), SDL_Renderer::viewport, SDL_Rect::w, SDL_FPoint::x, SDL_Rect::x, SDL_FPoint::y, and SDL_Rect::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

renderer The renderer that will be checked

Returns: SDL_TRUE if supported, SDL_FALSE if not.

Definition at line 1867 of file SDL_render.c.

 {
     if (!renderer || !renderer->SetRenderTarget) {
         return SDL_FALSE;
     }
     return (renderer->info.flags & SDL_RENDERER_TARGETTEXTURE) != 0;
 }

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

renderer	The renderer for which blend mode should be set.
blendMode	SDL_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 2255 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     if (!IsSupportedBlendMode(renderer, blendMode)) {
         return SDL_Unsupported();
     }
     renderer->blendMode = blendMode;
     return 0;
 }

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

renderer	The renderer for which drawing color should be set.
r	The red value used to draw on the rendering target.
g	The green value used to draw on the rendering target.
b	The blue value used to draw on the rendering target.
a	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 2221 of file SDL_render.c.

 {
     CHECK_RENDERER_MAGIC(renderer, -1);
  
     renderer->r = r;
     renderer->g = g;
     renderer->b = b;
     renderer->a = a;
     return 0;
 }

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

renderer	The renderer.
texture	The 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 1876 of file SDL_render.c.

 {
     if (!SDL_RenderTargetSupported(renderer)) {
         return SDL_Unsupported();
     }
  
     /* texture == NULL is valid and means reset the target to the window */
     if (texture) {
         CHECK_TEXTURE_MAGIC(texture, -1);
         if (renderer != texture->renderer) {
             return SDL_SetError("Texture was not created with this renderer");
         }
         if (texture->access != SDL_TEXTUREACCESS_TARGET) {
             return SDL_SetError("Texture not created with SDL_TEXTUREACCESS_TARGET");
         }
         if (texture->native) {
             /* Always render to the native texture */
             texture = texture->native;
         }
     }
  
     if (texture == renderer->target) {
         /* Nothing to do! */
         return 0;
     }
  
     FlushRenderCommands(renderer);  /* time to send everything to the GPU! */
  
     SDL_LockMutex(renderer->target_mutex);
  
     if (texture && !renderer->target) {
         /* Make a backup of the viewport */
         renderer->viewport_backup = renderer->viewport;
         renderer->clip_rect_backup = renderer->clip_rect;
         renderer->clipping_enabled_backup = renderer->clipping_enabled;
         renderer->scale_backup = renderer->scale;
         renderer->logical_w_backup = renderer->logical_w;
         renderer->logical_h_backup = renderer->logical_h;
     }
     renderer->target = texture;
  
     if (renderer->SetRenderTarget(renderer, texture) < 0) {
         SDL_UnlockMutex(renderer->target_mutex);
         return -1;
     }
  
     if (texture) {
         renderer->viewport.x = 0;
         renderer->viewport.y = 0;
         renderer->viewport.w = texture->w;
         renderer->viewport.h = texture->h;
         SDL_zero(renderer->clip_rect);
         renderer->clipping_enabled = SDL_FALSE;
         renderer->scale.x = 1.0f;
         renderer->scale.y = 1.0f;
         renderer->logical_w = texture->w;
         renderer->logical_h = texture->h;
     } else {
         renderer->viewport = renderer->viewport_backup;
         renderer->clip_rect = renderer->clip_rect_backup;
         renderer->clipping_enabled = renderer->clipping_enabled_backup;
         renderer->scale = renderer->scale_backup;
         renderer->logical_w = renderer->logical_w_backup;
         renderer->logical_h = renderer->logical_h_backup;
     }
  
     SDL_UnlockMutex(renderer->target_mutex);
  
     if (QueueCmdSetViewport(renderer) < 0) {
         return -1;
     }
     if (QueueCmdSetClipRect(renderer) < 0) {
         return -1;
     }
  
     /* All set! */
     return FlushRenderCommandsIfNotBatching(renderer);
 }

References CHECK_TEXTURE_MAGIC, SDL_Renderer::clip_rect, SDL_Renderer::clip_rect_backup, SDL_Renderer::clipping_enabled, SDL_Renderer::clipping_enabled_backup, FlushRenderCommands(), FlushRenderCommandsIfNotBatching(), SDL_Rect::h, SDL_Renderer::logical_h, SDL_Renderer::logical_h_backup, SDL_Renderer::logical_w, SDL_Renderer::logical_w_backup, QueueCmdSetClipRect(), QueueCmdSetViewport(), 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::viewport, SDL_Renderer::viewport_backup, SDL_Rect::w, SDL_FPoint::x, SDL_Rect::x, SDL_FPoint::y, and SDL_Rect::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

texture	The texture to update.
alpha	The 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 1367 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (alpha < 255) {
         texture->modMode |= SDL_TEXTUREMODULATE_ALPHA;
     } else {
         texture->modMode &= ~SDL_TEXTUREMODULATE_ALPHA;
     }
     texture->a = alpha;
     if (texture->native) {
         return SDL_SetTextureAlphaMod(texture->native, alpha);
     }
     return 0;
 }

References CHECK_TEXTURE_MAGIC, SDL_SetTextureAlphaMod(), and SDL_TEXTUREMODULATE_ALPHA.

Referenced by SDL_CreateTextureFromSurface(), and SDL_SetTextureAlphaMod().

◆ SDL_SetTextureBlendMode()

int SDL_SetTextureBlendMode	(	SDL_Texture *	texture,
		SDL_BlendMode	blendMode
	)

Set the blend mode used for texture copy operations.

Parameters

texture	The texture to update.
blendMode	SDL_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 1395 of file SDL_render.c.

 {
     SDL_Renderer *renderer;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     renderer = texture->renderer;
     if (!IsSupportedBlendMode(renderer, blendMode)) {
         return SDL_Unsupported();
     }
     texture->blendMode = blendMode;
     if (texture->native) {
         return SDL_SetTextureBlendMode(texture->native, blendMode);
     }
     return 0;
 }

References blendMode, CHECK_TEXTURE_MAGIC, IsSupportedBlendMode(), renderer, SDL_SetTextureBlendMode(), and SDL_Unsupported.

Referenced by SDL_CreateTextureFromSurface(), and SDL_SetTextureBlendMode().

◆ 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

texture	The texture to update.
r	The red color value multiplied into copy operations.
g	The green color value multiplied into copy operations.
b	The 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 1330 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (r < 255 || g < 255 || b < 255) {
         texture->modMode |= SDL_TEXTUREMODULATE_COLOR;
     } else {
         texture->modMode &= ~SDL_TEXTUREMODULATE_COLOR;
     }
     texture->r = r;
     texture->g = g;
     texture->b = b;
     if (texture->native) {
         return SDL_SetTextureColorMod(texture->native, r, g, b);
     }
     return 0;
 }

References CHECK_TEXTURE_MAGIC, SDL_SetTextureColorMod(), and SDL_TEXTUREMODULATE_COLOR.

Referenced by SDL_CreateTextureFromSurface(), and SDL_SetTextureColorMod().

◆ SDL_SetTextureScaleMode()

int SDL_SetTextureScaleMode	(	SDL_Texture *	texture,
		SDL_ScaleMode	scaleMode
	)

Set the scale mode used for texture scale operations.

Parameters

texture	The texture to update.
scaleMode	SDL_ScaleMode to use for texture scaling.

Returns: 0 on success, or -1 if the texture is not valid.

Note: If the scale mode is not supported, the closest supported mode is chosen.

See also: SDL_GetTextureScaleMode()

Definition at line 1424 of file SDL_render.c.

 {
     SDL_Renderer *renderer;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     renderer = texture->renderer;
     renderer->SetTextureScaleMode(renderer, texture, scaleMode);
     texture->scaleMode = scaleMode;
     if (texture->native) {
         return SDL_SetTextureScaleMode(texture->native, scaleMode);
     }
     return 0;
 }

References CHECK_TEXTURE_MAGIC, renderer, SDL_SetTextureScaleMode(), and SDL_Renderer::SetTextureScaleMode.

Referenced by SDL_SetTextureScaleMode().

◆ SDL_UnlockTexture()

void SDL_UnlockTexture ( SDL_Texture * texture )

Unlock a texture, uploading the changes to video memory, if needed. If SDL_LockTextureToSurface() was called for locking, the SDL surface is freed.

See also: SDL_LockTexture(); SDL_LockTextureToSurface()

Definition at line 1843 of file SDL_render.c.

 {
     CHECK_TEXTURE_MAGIC(texture, );
  
     if (texture->access != SDL_TEXTUREACCESS_STREAMING) {
         return;
     }
 #if SDL_HAVE_YUV
     if (texture->yuv) {
         SDL_UnlockTextureYUV(texture);
     } else
 #endif
     if (texture->native) {
         SDL_UnlockTextureNative(texture);
     } else {
         SDL_Renderer *renderer = texture->renderer;
         renderer->UnlockTexture(renderer, texture);
     }
  
     SDL_FreeSurface(texture->locked_surface);
     texture->locked_surface = NULL;
 }

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

Referenced by SDL_LockTextureToSurface(), 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

texture	The texture to update
rect	A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
pixels	The raw pixel data in the format of the texture.
pitch	The 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 1540 of file SDL_render.c.

 {
     SDL_Rect full_rect;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (!pixels) {
         return SDL_InvalidParamError("pixels");
     }
     if (!pitch) {
         return SDL_InvalidParamError("pitch");
     }
  
     if (!rect) {
         full_rect.x = 0;
         full_rect.y = 0;
         full_rect.w = texture->w;
         full_rect.h = texture->h;
         rect = &full_rect;
     }
  
     if ((rect->w == 0) || (rect->h == 0)) {
         return 0;  /* nothing to do. */
 #if SDL_HAVE_YUV
     } else if (texture->yuv) {
         return SDL_UpdateTextureYUV(texture, rect, pixels, pitch);
 #endif
     } else if (texture->native) {
         return SDL_UpdateTextureNative(texture, rect, pixels, pitch);
     } else {
         SDL_Renderer *renderer = texture->renderer;
         if (FlushRenderCommandsIfTextureNeeded(texture) < 0) {
             return -1;
         }
         return renderer->UpdateTexture(renderer, texture, rect, pixels, pitch);
     }
 }

References CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfTextureNeeded(), 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

texture	The texture to update
rect	A pointer to the rectangle of pixels to update, or NULL to update the entire texture.
Yplane	The raw pixel data for the Y plane.
Ypitch	The number of bytes between rows of pixel data for the Y plane.
Uplane	The raw pixel data for the U plane.
Upitch	The number of bytes between rows of pixel data for the U plane.
Vplane	The raw pixel data for the V plane.
Vpitch	The 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 1633 of file SDL_render.c.

 {
 #if SDL_HAVE_YUV
     SDL_Renderer *renderer;
     SDL_Rect full_rect;
  
     CHECK_TEXTURE_MAGIC(texture, -1);
  
     if (!Yplane) {
         return SDL_InvalidParamError("Yplane");
     }
     if (!Ypitch) {
         return SDL_InvalidParamError("Ypitch");
     }
     if (!Uplane) {
         return SDL_InvalidParamError("Uplane");
     }
     if (!Upitch) {
         return SDL_InvalidParamError("Upitch");
     }
     if (!Vplane) {
         return SDL_InvalidParamError("Vplane");
     }
     if (!Vpitch) {
         return SDL_InvalidParamError("Vpitch");
     }
  
     if (texture->format != SDL_PIXELFORMAT_YV12 &&
         texture->format != SDL_PIXELFORMAT_IYUV) {
         return SDL_SetError("Texture format must by YV12 or IYUV");
     }
  
     if (!rect) {
         full_rect.x = 0;
         full_rect.y = 0;
         full_rect.w = texture->w;
         full_rect.h = texture->h;
         rect = &full_rect;
     }
  
     if (!rect->w || !rect->h) {
         return 0;  /* nothing to do. */
     }
  
     if (texture->yuv) {
         return SDL_UpdateTextureYUVPlanar(texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
     } else {
         SDL_assert(!texture->native);
         renderer = texture->renderer;
         SDL_assert(renderer->UpdateTextureYUV);
         if (renderer->UpdateTextureYUV) {
             if (FlushRenderCommandsIfTextureNeeded(texture) < 0) {
                 return -1;
             }
             return renderer->UpdateTextureYUV(renderer, texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
         } else {
             return SDL_Unsupported();
         }
     }
 #else
     return -1;
 #endif
 }

References CHECK_TEXTURE_MAGIC, FlushRenderCommandsIfTextureNeeded(), 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.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ SDL_RendererFlags

◆ SDL_RendererFlip

◆ SDL_ScaleMode

◆ SDL_TextureAccess

◆ SDL_TextureModulate

Function Documentation

◆ SDL_CreateRenderer()

◆ SDL_CreateSoftwareRenderer()

◆ SDL_CreateTexture()

◆ SDL_CreateTextureFromSurface()

◆ SDL_CreateWindowAndRenderer()

◆ SDL_DestroyRenderer()

◆ SDL_DestroyTexture()

◆ SDL_GetNumRenderDrivers()

◆ SDL_GetRenderDrawBlendMode()

◆ SDL_GetRenderDrawColor()

◆ SDL_GetRenderDriverInfo()

◆ SDL_GetRenderer()

◆ SDL_GetRendererInfo()

◆ SDL_GetRendererOutputSize()

◆ SDL_GetRenderTarget()

◆ SDL_GetTextureAlphaMod()

◆ SDL_GetTextureBlendMode()

◆ SDL_GetTextureColorMod()

◆ SDL_GetTextureScaleMode()

◆ SDL_GL_BindTexture()

◆ SDL_GL_UnbindTexture()

◆ SDL_LockTexture()

◆ SDL_LockTextureToSurface()

◆ SDL_QueryTexture()

◆ SDL_RenderClear()

◆ SDL_RenderCopy()

◆ SDL_RenderCopyEx()

◆ SDL_RenderCopyExF()

◆ SDL_RenderCopyF()

◆ SDL_RenderDrawLine()

◆ SDL_RenderDrawLineF()

◆ SDL_RenderDrawLines()

◆ SDL_RenderDrawLinesF()

◆ SDL_RenderDrawPoint()

◆ SDL_RenderDrawPointF()

◆ SDL_RenderDrawPoints()

◆ SDL_RenderDrawPointsF()

◆ SDL_RenderDrawRect()

◆ SDL_RenderDrawRectF()

◆ SDL_RenderDrawRects()

◆ SDL_RenderDrawRectsF()

◆ SDL_RenderFillRect()

◆ SDL_RenderFillRectF()

◆ SDL_RenderFillRects()

◆ SDL_RenderFillRectsF()

◆ SDL_RenderFlush()

◆ SDL_RenderGetClipRect()

◆ SDL_RenderGetIntegerScale()

◆ SDL_RenderGetLogicalSize()

◆ SDL_RenderGetMetalCommandEncoder()

◆ SDL_RenderGetMetalLayer()

◆ SDL_RenderGetScale()

◆ SDL_RenderGetViewport()

◆ SDL_RenderIsClipEnabled()

◆ SDL_RenderPresent()

◆ SDL_RenderReadPixels()

◆ SDL_RenderSetClipRect()

◆ SDL_RenderSetIntegerScale()

◆ SDL_RenderSetLogicalSize()

◆ SDL_RenderSetScale()

◆ SDL_RenderSetViewport()

◆ SDL_RenderTargetSupported()

◆ SDL_SetRenderDrawBlendMode()

◆ SDL_SetRenderDrawColor()

◆ SDL_SetRenderTarget()

◆ SDL_SetTextureAlphaMod()

◆ SDL_SetTextureBlendMode()

◆ SDL_SetTextureColorMod()

◆ SDL_SetTextureScaleMode()