devela::_dep::sdl3::sys::rect

Function SDL_GetRectAndLineIntersection

pub unsafe extern "C" fn SDL_GetRectAndLineIntersection(
    rect: *const SDL_Rect,
    X1: *mut i32,
    Y1: *mut i32,
    X2: *mut i32,
    Y2: *mut i32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Calculate the intersection of a rectangle and line segment.

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.

§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 true if there is an intersection, false otherwise.

§Availability

This function is available since SDL 3.2.0.