SDL_SetRenderViewport - Man Page

Set the drawing area for rendering on the current target.

Header File

Defined in SDL3/SDL_render.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_SetRenderViewport(SDL_Renderer *renderer, const SDL_Rect *rect);

Description

Drawing will clip to this area (separately from any clipping done with

SDL_SetRenderClipRect ), and the top left of the area will become coordinate (0, 0) for future drawing commands.

The area's width and height must be >= 0.

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 true on success or false on failure; call

SDL_GetError () for more information.

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_RenderViewportSet(3)

Referenced By

SDL_GetRenderViewport(3), SDL_RenderCoordinatesToWindow(3), SDL_RenderViewportSet(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS