Scroll to navigation

SDL_RectsEqual(3) SDL3 FUNCTIONS SDL_RectsEqual(3)

NAME

SDL_RectsEqual - Determine whether two rectangles are equal.

HEADER FILE

Defined in SDL3/SDL_rect.h

SYNOPSIS

#include "SDL3/SDL.h"
SDL_FORCE_INLINE SDL_bool SDL_RectsEqual(const SDL_Rect *a, const SDL_Rect *b);

DESCRIPTION

Rectangles are considered equal if both are not NULL and each of their x, y, width and height match.

Note that this is a forced-inline function in a header, and not a public API function available in the SDL library (which is to say, the code is embedded in the calling program and the linker and dynamic loader will not be able to find this function inside SDL itself).

FUNCTION PARAMETERS

the first rectangle to test.
the second rectangle to test.

RETURN VALUE

Returns SDL_TRUE
if the rectangles are equal,

SDL_FALSE
otherwise.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.0.0.

SDL 3.1.2 Simple Directmedia Layer