Calculate the intersection of a rectangle and line segment.
const SDL_Rect *
SDL_bool SDL_IntersectRectAndLine(int *X1,
rect, int *Y1, int *X2,
int *Y2);
rect | an SDL_Rect structure representing the rectangle to intersect |
X1 | a pointer to the starting X-coordinate of the line |
Y1 | a pointer to the starting Y-coordinate of the line |
X2 | a pointer to the ending X-coordinate of the line |
Y2 | a pointer to the ending Y-coordinate of the line |
Returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
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.
This function is available since SDL 2.0.0.