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


Set the drawing area for rendering on the current target.

Header File

Defined in SDL_render.h, but apps should only #include "SDL.h"!


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.


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


This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.