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

Function SDL_CreateRenderer

pub unsafe extern "C" fn SDL_CreateRenderer(
    window: *mut SDL_Window,
    name: *const i8,
) -> *mut SDL_Renderer
Available on crate feature dep_sdl3 only.
Expand description

Create a 2D rendering context for a window.

If you want a specific renderer, you can specify its name here. A list of available renderers can be obtained by calling SDL_GetRenderDriver() multiple times, with indices from 0 to SDL_GetNumRenderDrivers()-1. If you don’t need a specific renderer, specify NULL and SDL will attempt to choose the best option for you, based on what is available on the user’s system.

If name is a comma-separated list, SDL will try each name, in the order listed, until one succeeds or all of them fail.

By default the rendering size matches the window size in pixels, but you can call SDL_SetRenderLogicalPresentation() to change the content size and scaling options.

§Parameters

  • window: the window where rendering is displayed.
  • name: the name of the rendering driver to initialize, or NULL to let SDL choose one.

§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