Wiki Page Content

SDL_IntersectRectAndLine

Use this function to calculate the intersection of a rectangle and line segment.

Syntax

SDL_bool SDL_IntersectRectAndLine(const SDL_Rect* rect,
                                  int*            X1,
                                  int*            Y1,
                                  int*            X2,
                                  int*            Y2)

Function Parameters

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

Return Value

Returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.

Code Examples

You can add your code example here

Remarks

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.


CategoryAPI, CategoryRect

None: SDL_IntersectRectAndLine (last edited 2010-10-16 06:14:25 by SheenaSmith)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit