Scroll to navigation

SDL_GetRectEnclosingPoints(3) SDL3 FUNCTIONS SDL_GetRectEnclosingPoints(3)

NAME

SDL_GetRectEnclosingPoints - Calculate a minimal rectangle enclosing a set of points.

SYNOPSIS

#include "SDL3/SDL.h"
SDL_bool SDL_GetRectEnclosingPoints(const SDL_Point * points,
                           int count,
                           const SDL_Rect * clip,
                           SDL_Rect * result);

DESCRIPTION

If clip is not NULL then only points inside of the clipping rectangle are considered.

FUNCTION PARAMETERS

an array of SDL_Point
structures representing points to be enclosed
the number of structures in the points array
an SDL_Rect
used for clipping or NULL to enclose all points
an SDL_Rect
structure filled in with the minimal enclosing rectangle

RETURN VALUE

Returns SDL_TRUE
if any points were enclosed or

SDL_FALSE
if all the points were outside of the clipping rectangle.

AVAILABILITY

This function is available since SDL 3.0.0.

SDL 3.1.0 SDL