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

SDL_RenderSetViewport

Set the drawing area for rendering on the current target.

Header File

Defined in SDL_render.h

Syntax

int SDL_RenderSetViewport(SDL_Renderer * renderer,
                          const SDL_Rect * rect);

Function Parameters

renderer the rendering context
rect the SDL_Rect structure representing the drawing area, or NULL to set the viewport to the entire target

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

When the window is resized, the viewport is reset to fill the entire new window size.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryRender