SDL_RenderViewportSet(3)

SDL_RenderViewportSet3

Return whether an explicit rectangle was set as the viewport.

Usage

#include "SDL3/SDL.h"

bool SDL_RenderViewportSet(SDL_Renderer *renderer);

Header file

Defined in SDL3/SDL_render.h

Overview

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.

Each render target has its own viewport. This function checks the viewport for the current render target.

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.