devela::_dep::sdl3::sys::rect

Function SDL_PointInRect

pub unsafe fn SDL_PointInRect(p: *const SDL_Point, r: *const SDL_Rect) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Determine whether a point resides inside a rectangle.

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).

§Parameters

  • p: the point to test.
  • r: the rectangle to test.

§Return value

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

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.