Determine whether a point resides inside a rectangle.
Defined in SDL_rect.h, but apps should use #include <SDL3/SDL.h>
const SDL_Point *p, const SDL_Rect *r); SDL_FORCE_INLINE SDL_bool SDL_PointInRect(
p | the point to test. |
r | the rectangle to test. |
Returns SDL_TRUE if p
is contained by r
, SDL_FALSE otherwise.
A point is considered part of a rectangle if both p
and r
are not NULL, and p
's x and y coordinates are >= to the rectangle's top left corner, and < the rectangle's x+w and y+h. So a 1x1 rectangle considers point (0,0) as "inside" and (0,1) as not.
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).
It is safe to call this function from any thread.
This function is available since SDL 3.0.0.
CategoryAPI, CategoryAPIFunction