SDL Wiki
(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable 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

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

Return Value

(int) 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


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