plucky (3) SDL_GetRectIntersection.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME

       SDL_GetRectIntersection - Calculate the intersection of two rectangles.

HEADER FILE

       Defined in SDL3/SDL_rect.h

SYNOPSIS

       #include "SDL3/SDL.h"

       bool SDL_GetRectIntersection(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result);

DESCRIPTION

       If result is NULL then this function will return false.

FUNCTION PARAMETERS

       A      an SDL_Rect
               structure representing the first rectangle.

       B      an SDL_Rect
               structure representing the second rectangle.

       result an SDL_Rect
               structure filled in with the intersection of rectangles A and B .

RETURN VALUE

       Returns true if there is an intersection, false otherwise.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_HasRectIntersection(3)