.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetRectAndLineIntersection:
.\"   https://wiki.libsdl.org/SDL_GetRectAndLineIntersection
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetRectAndLineIntersection
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetRectAndLineIntersection 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetRectAndLineIntersection \- Calculate the intersection of a rectangle and line segment\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_bool SDL_GetRectAndLineIntersection(const SDL_Rect *
.BI "                                  rect, int *X1,
.BI "                                  int *Y1, int *X2,
.BI "                                  int *Y2);
.fi
.SH DESCRIPTION
This function is used to clip a line segment to a rectangle\[char46] A line segment
contained entirely within the rectangle or that does not intersect will
remain unchanged\[char46] 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
.BR X1
,
.BR Y1
,
.BR X2
, and/or
.BR Y2
as necessary\[char46]

.SH FUNCTION PARAMETERS
.TP
.I rect
an 
.BR SDL_Rect
 structure representing the rectangle to intersect
.TP
.I X1
a pointer to the starting X-coordinate of the line
.TP
.I Y1
a pointer to the starting Y-coordinate of the line
.TP
.I X2
a pointer to the ending X-coordinate of the line
.TP
.I Y2
a pointer to the ending Y-coordinate of the line
.SH RETURN VALUE
Returns 
.BR SDL_TRUE
 if there is an intersection,

.BR SDL_FALSE
 otherwise\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]