SDL_GetRectAndLineIntersectionFloat - Calculate the intersection of a rectangle and line segment with
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.10 SDL_GetRectAndLineIntersectionFloat(3)
Description
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.
Function Parameters
rect an SDL_FRect
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.
Header File
Defined in SDL3/SDL_rect.h
Name
SDL_GetRectAndLineIntersectionFloat - Calculate the intersection of a rectangle and line segment with
float precision.
Return Value
Returns true if there is an intersection, false otherwise.
Synopsis
#include"SDL3/SDL.h"boolSDL_GetRectAndLineIntersectionFloat(constSDL_FRect*rect,float*X1,float*Y1,float*X2,float*Y2);
