(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_CreateSoftwareRenderer

Create a 2D software rendering context for a surface.

Header File

Defined in SDL_render.h

Syntax

SDL_Renderer * SDL_CreateSoftwareRenderer(SDL_Surface * surface);

Function Parameters

surface the SDL_Surface structure representing the surface where rendering is done

Return Value

Returns a valid rendering context or NULL if there was an error; call SDL_GetError() for more information.

Remarks

Two other API which can be used to create SDL_Renderer: SDL_CreateRenderer() and SDL_CreateWindowAndRenderer(). These can also create a software renderer, but they are intended to be used with an SDL_Window as the final destination and not an SDL_Surface.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryRender