SDL_RenderViewportSet - Man Page

Return whether an explicit rectangle was set as the viewport.

Header File

Defined in SDL3/SDL_render.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_RenderViewportSet(SDL_Renderer *renderer);

Description

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.

Function Parameters

renderer

the rendering context.

Return Value

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

Thread Safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_GetRenderViewport(3), ·(3), SDL_SetRenderViewport(3)

Referenced By

SDL_GetRenderViewport(3), SDL_SetRenderViewport(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS