Function sdl2_sys::SDL_IntersectRectAndLine
source ยท pub unsafe extern "C" fn SDL_IntersectRectAndLine(
rect: *const SDL_Rect,
X1: *mut c_int,
Y1: *mut c_int,
X2: *mut c_int,
Y2: *mut c_int,
) -> SDL_bool
Expand description
Calculate the intersection of a rectangle and line segment.
This function is used to clip a line segment to a rectangle. A line segment
contained entirely within the rectangle or that does not intersect will
remain unchanged. A line segment that crosses the rectangle at either or
both ends will be clipped to the boundary of the rectangle and the new
coordinates saved in X1
, Y1
, X2
, and/or Y2
as necessary.
\param rect an SDL_Rect structure representing the rectangle to intersect \param X1 a pointer to the starting X-coordinate of the line \param Y1 a pointer to the starting Y-coordinate of the line \param X2 a pointer to the ending X-coordinate of the line \param Y2 a pointer to the ending Y-coordinate of the line \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
\since This function is available since SDL 2.0.0.