(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_RenderViewportSet

Return whether an explicit rectangle was set as the viewport.

Header File

Syntax

bool SDL_RenderViewportSet(SDL_Renderer *renderer);

Function Parameters

SDL_Renderer *

renderer

the rendering context.

Return Value

(bool) Returns true if the viewport was set to a specific rectangle, or false if it was set to NULL (the entire target).

Remarks

This is useful if you're saving and restoring the viewport and want to know whether you should restore a specific rectangle or NULL. Note that the viewport is always reset when changing rendering targets.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.