Determine whether a point resides inside a rectangle.
Defined in <SDL3/SDL_rect.h>
bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r); SDL_FORCE_INLINE
const SDL_Point * | p | the point to test. |
const SDL_Rect * | r | the rectangle to test. |
(bool) Returns true if p
is contained by r
, 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.1.3.