SDL_CreateRenderer - Create a 2D rendering context for a window.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Function Parameters
window the window where rendering is displayed.
name the name of the rendering driver to initialize, or NULL to let SDL choose one.
Header File
Defined in SDL3/SDL_render.h
Name
SDL_CreateRenderer - Create a 2D rendering context for a window.
Return Value
( SDL_Renderer
*) Returns a valid rendering context or NULL if there was an error; call SDL_GetError () for more
information.
See Also
•(3), SDL_CreateRendererWithProperties(3), •(3), SDL_CreateSoftwareRenderer(3), •(3), SDL_DestroyRenderer(3), •(3), SDL_GetNumRenderDrivers(3), •(3), SDL_GetRenderDriver(3), •(3), SDL_GetRendererName(3) Simple Directmedia Layer SDL 3.2.10 SDL_CreateRenderer(3)
Synopsis
#include"SDL3/SDL.h"SDL_Renderer*SDL_CreateRenderer(SDL_Window*window,constchar*name);
Thread Safety
This function should only be called on the main thread.
