SDL_render.h File Reference

Information on the capabilities of a render driver or context.

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.

Flip constants for SDL_RenderCopyEx.

Enumerator:

SDL_FLIP_NONE	Do not flip.
SDL_FLIP_HORIZONTAL	flip horizontally
SDL_FLIP_VERTICAL	flip vertically

Definition at line 111 of file SDL_render.h.

The access pattern allowed for a texture.

Enumerator:

SDL_TEXTUREACCESS_STATIC	Changes rarely, not lockable.
SDL_TEXTUREACCESS_STREAMING	Changes frequently, lockable.
SDL_TEXTUREACCESS_TARGET	Texture can be used as a render target.

Definition at line 91 of file SDL_render.h.

The texture channel modulation used in SDL_RenderCopy().

Enumerator:

SDL_TEXTUREMODULATE_NONE	No modulation.
SDL_TEXTUREMODULATE_COLOR	srcC = srcC * color
SDL_TEXTUREMODULATE_ALPHA	srcA = srcA * alpha

Definition at line 101 of file SDL_render.h.

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()

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()

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 0 if no rendering context was active, the format was unsupported, or the width or height were out of range.

See also:

SDL_QueryTexture()

SDL_UpdateTexture()

SDL_DestroyTexture()

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 0 on error.

Note:

The surface is not modified or freed by this function.

See also:

SDL_QueryTexture()

SDL_DestroyTexture()

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

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

See also:

SDL_CreateRenderer()

Destroy the specified texture.

See also:

SDL_CreateTexture()

SDL_CreateTextureFromSurface()

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()

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()

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

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()

Get the renderer associated with a window.

Get information about a rendering context.

Get the output size of a rendering context.

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

Returns:

The current render target

See also:

SDL_SetRenderTarget()

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()

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()

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()

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

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

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()

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.

Clear the current rendering target with the drawing color.

This function clears the entire rendering target, ignoring the viewport.

Returns:

0 on success, or -1 on error

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

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
center	A pointer to a point indicating the point around which dstrect will be rotated (if NULL, rotation will be done aroud 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

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

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

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

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

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

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

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

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

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()

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()

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()

Get the drawing area for the current target.

See also:

SDL_RenderSetViewport()

Update the screen with rendering performed.

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.

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, or NULL to disable clipping.

Returns:

0 on success, or -1 on error

See also:

SDL_RenderGetClipRect()

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()

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()

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()

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.

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()

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

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()

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()

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()

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()

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

See also:

SDL_LockTexture()

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.
pitch	The number of bytes between rows of pixel data.

Returns:

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

Note:

This is a fairly slow function.

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.