devela::_dep::sdl3::sys::render

Function SDL_CreateSoftwareRenderer

pub unsafe extern "C" fn SDL_CreateSoftwareRenderer(
    surface: *mut SDL_Surface,
) -> *mut SDL_Renderer
Available on crate feature dep_sdl3 only.
Expand description

Create a 2D software rendering context for a surface.

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.

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

§Thread safety

This function should only be called on the main thread.

§Availability

This function is available since SDL 3.2.0.

§See also