SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_pixels.h>
#include <SDL3/SDL_rwops.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Data Structures | |
struct | SDL_Point |
struct | SDL_FPoint |
struct | SDL_Rect |
struct | SDL_FRect |
Header file for SDL_rect definition and management functions.
Definition in file SDL_rect.h.
SDL_bool SDL_GetRectAndLineIntersection | ( | const SDL_Rect * | rect, |
int * | X1, | ||
int * | Y1, | ||
int * | X2, | ||
int * | Y2 | ||
) |
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.
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 |
SDL_bool SDL_GetRectAndLineIntersectionFloat | ( | const SDL_FRect * | rect, |
float * | X1, | ||
float * | Y1, | ||
float * | X2, | ||
float * | Y2 | ||
) |
Calculate the intersection of a rectangle and line segment with float precision.
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.
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 |
SDL_bool SDL_GetRectEnclosingPoints | ( | const SDL_Point * | points, |
int | count, | ||
const SDL_Rect * | clip, | ||
SDL_Rect * | result | ||
) |
Calculate a minimal rectangle enclosing a set of points.
If clip
is not NULL then only points inside of the clipping rectangle are considered.
points | an array of SDL_Point structures representing points to be enclosed |
count | the number of structures in the points array |
clip | an SDL_Rect used for clipping or NULL to enclose all points |
result | an SDL_Rect structure filled in with the minimal enclosing rectangle |
SDL_bool SDL_GetRectEnclosingPointsFloat | ( | const SDL_FPoint * | points, |
int | count, | ||
const SDL_FRect * | clip, | ||
SDL_FRect * | result | ||
) |
Calculate a minimal rectangle enclosing a set of points with float precision.
If clip
is not NULL then only points inside of the clipping rectangle are considered.
points | an array of SDL_FPoint structures representing points to be enclosed |
count | the number of structures in the points array |
clip | an SDL_FRect used for clipping or NULL to enclose all points |
result | an SDL_FRect structure filled in with the minimal enclosing rectangle |
Calculate the intersection of two rectangles.
If result
is NULL then this function will return SDL_FALSE.
A | an SDL_Rect structure representing the first rectangle |
B | an SDL_Rect structure representing the second rectangle |
result | an SDL_Rect structure filled in with the intersection of rectangles A and B |
SDL_bool SDL_GetRectIntersectionFloat | ( | const SDL_FRect * | A, |
const SDL_FRect * | B, | ||
SDL_FRect * | result | ||
) |
Calculate the intersection of two rectangles with float precision.
If result
is NULL then this function will return SDL_FALSE.
A | an SDL_FRect structure representing the first rectangle |
B | an SDL_FRect structure representing the second rectangle |
result | an SDL_FRect structure filled in with the intersection of rectangles A and B |
Calculate the union of two rectangles.
A | an SDL_Rect structure representing the first rectangle |
B | an SDL_Rect structure representing the second rectangle |
result | an SDL_Rect structure filled in with the union of rectangles A and B |
Calculate the union of two rectangles with float precision.
A | an SDL_FRect structure representing the first rectangle |
B | an SDL_FRect structure representing the second rectangle |
result | an SDL_FRect structure filled in with the union of rectangles A and B |
Determine whether two rectangles intersect.
If either pointer is NULL the function will return SDL_FALSE.
A | an SDL_Rect structure representing the first rectangle |
B | an SDL_Rect structure representing the second rectangle |
Determine whether two rectangles intersect with float precision.
If either pointer is NULL the function will return SDL_FALSE.
A | an SDL_FRect structure representing the first rectangle |
B | an SDL_FRect structure representing the second rectangle |
SDL_FORCE_INLINE SDL_bool SDL_PointInRect | ( | const SDL_Point * | p, |
const SDL_Rect * | r | ||
) |
Returns true if point resides inside a rectangle.
Definition at line 110 of file SDL_rect.h.
SDL_FORCE_INLINE SDL_bool SDL_PointInRectFloat | ( | const SDL_FPoint * | p, |
const SDL_FRect * | r | ||
) |
SDL_FORCE_INLINE SDL_bool SDL_RectEmpty | ( | const SDL_Rect * | r | ) |
SDL_FORCE_INLINE SDL_bool SDL_RectEmptyFloat | ( | const SDL_FRect * | r | ) |
SDL_FORCE_INLINE SDL_bool SDL_RectsEqual | ( | const SDL_Rect * | a, |
const SDL_Rect * | b | ||
) |
SDL_FORCE_INLINE SDL_bool SDL_RectsEqualEpsilon | ( | const SDL_FRect * | a, |
const SDL_FRect * | b, | ||
const float | epsilon | ||
) |
Returns true if the two rectangles are equal, within some given epsilon.
Definition at line 254 of file SDL_rect.h.
References SDL_fabsf(), SDL_FALSE, and SDL_TRUE.
Referenced by SDL_RectsEqualFloat().
SDL_FORCE_INLINE SDL_bool SDL_RectsEqualFloat | ( | const SDL_FRect * | a, |
const SDL_FRect * | b | ||
) |
Returns true if the two rectangles are equal, using a default epsilon.
Definition at line 269 of file SDL_rect.h.
References SDL_FLT_EPSILON, and SDL_RectsEqualEpsilon().