devela::_dep::sdl3::sys::render

Function SDL_SetRenderViewport

pub unsafe extern "C" fn SDL_SetRenderViewport(
    renderer: *mut SDL_Renderer,
    rect: *const SDL_Rect,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set the drawing area for rendering on the current target.

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.

§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