(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetRectAndLineIntersection

Calculate the intersection of a rectangle and line segment.

Header File

Defined in <SDL3/SDL_rect.h>

Syntax

SDL_bool SDL_GetRectAndLineIntersection(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.

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.

Version

This function is available since SDL 3.0.0.

---

CategoryAPI, CategoryAPIFunction

---

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.