SDL_GetRenderLogicalPresentationRect

Function SDL_GetRenderLogicalPresentationRect 

Source
pub unsafe extern "C" fn SDL_GetRenderLogicalPresentationRect(
    renderer: *mut SDL_Renderer,
    rect: *mut SDL_FRect,
) -> bool
Expand description

Get the final presentation rectangle for rendering.

This function returns the calculated rectangle used for logical presentation, based on the presentation mode and output size. If logical presentation is disabled, it will fill the rectangle with the output size, in pixels.

Each render target has its own logical presentation state. This function gets the rectangle for the current render target.

§Parameters

  • renderer: the rendering context.
  • rect: a pointer filled in with the final presentation rectangle, may be NULL.

§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