logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_PointInRect - Determine whether a point resides inside a rectangle.

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10                                 SDL_PointInRect(3)

Description

       A  point  is considered part of a rectangle if both p and r are not NULL, and p 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).

Function Parameters

p      the point to test.

       r      the rectangle to test.

Header File

       Defined in SDL3/SDL_rect.h

Name

       SDL_PointInRect - Determine whether a point resides inside a rectangle.

Return Value

       Returns true if p is contained by r , false otherwise.

Synopsis

#include"SDL3/SDL.h"SDL_FORCE_INLINEboolSDL_PointInRect(constSDL_Point*p,constSDL_Rect*r);

Thread Safety

       It is safe to call this function from any thread.

See Also