(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_IntersectRect

Calculate the intersection of two rectangles.

Header File

Defined in SDL_rect.h

Syntax

SDL_bool SDL_IntersectRect(const SDL_Rect * A,
                           const SDL_Rect * B,
                           SDL_Rect * result);

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 SDL_TRUE if there is an intersection, SDL_FALSE otherwise.

Remarks

If result is NULL then this function will return SDL_FALSE.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryRect