mirror of https://github.com/libsdl-org/SDL
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
508 lines
18 KiB
C
508 lines
18 KiB
C
/*
|
|
Simple DirectMedia Layer
|
|
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
/**
|
|
* # CategoryRect
|
|
*
|
|
* Some helper functions for managing rectangles and 2D points, in both
|
|
* integer and floating point versions.
|
|
*/
|
|
|
|
#ifndef SDL_rect_h_
|
|
#define SDL_rect_h_
|
|
|
|
#include <SDL3/SDL_stdinc.h>
|
|
#include <SDL3/SDL_error.h>
|
|
|
|
#include <SDL3/SDL_begin_code.h>
|
|
/* Set up for C function definitions, even when using C++ */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* The structure that defines a point (using integers).
|
|
*
|
|
* \since This struct is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_GetRectEnclosingPoints
|
|
* \sa SDL_PointInRect
|
|
*/
|
|
typedef struct SDL_Point
|
|
{
|
|
int x;
|
|
int y;
|
|
} SDL_Point;
|
|
|
|
/**
|
|
* The structure that defines a point (using floating point values).
|
|
*
|
|
* \since This struct is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_GetRectEnclosingPointsFloat
|
|
* \sa SDL_PointInRectFloat
|
|
*/
|
|
typedef struct SDL_FPoint
|
|
{
|
|
float x;
|
|
float y;
|
|
} SDL_FPoint;
|
|
|
|
|
|
/**
|
|
* A rectangle, with the origin at the upper left (using integers).
|
|
*
|
|
* \since This struct is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_RectEmpty
|
|
* \sa SDL_RectsEqual
|
|
* \sa SDL_HasRectIntersection
|
|
* \sa SDL_GetRectIntersection
|
|
* \sa SDL_GetRectAndLineIntersection
|
|
* \sa SDL_GetRectUnion
|
|
* \sa SDL_GetRectEnclosingPoints
|
|
*/
|
|
typedef struct SDL_Rect
|
|
{
|
|
int x, y;
|
|
int w, h;
|
|
} SDL_Rect;
|
|
|
|
|
|
/**
|
|
* A rectangle, with the origin at the upper left (using floating point
|
|
* values).
|
|
*
|
|
* \since This struct is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_RectEmptyFloat
|
|
* \sa SDL_RectsEqualFloat
|
|
* \sa SDL_RectsEqualEpsilon
|
|
* \sa SDL_HasRectIntersectionFloat
|
|
* \sa SDL_GetRectIntersectionFloat
|
|
* \sa SDL_GetRectAndLineIntersectionFloat
|
|
* \sa SDL_GetRectUnionFloat
|
|
* \sa SDL_GetRectEnclosingPointsFloat
|
|
* \sa SDL_PointInRectFloat
|
|
*/
|
|
typedef struct SDL_FRect
|
|
{
|
|
float x;
|
|
float y;
|
|
float w;
|
|
float h;
|
|
} SDL_FRect;
|
|
|
|
|
|
/**
|
|
* Convert an SDL_Rect to SDL_FRect
|
|
*
|
|
* \param rect a pointer to an SDL_Rect.
|
|
* \param frect a pointer filled in with the floating point representation of
|
|
* `rect`.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE void SDL_RectToFRect(const SDL_Rect *rect, SDL_FRect *frect)
|
|
{
|
|
frect->x = (float)rect->x;
|
|
frect->y = (float)rect->y;
|
|
frect->w = (float)rect->w;
|
|
frect->h = (float)rect->h;
|
|
}
|
|
|
|
/**
|
|
* Determine whether a point resides inside a rectangle.
|
|
*
|
|
* A point is considered part of a rectangle if both `p` and `r` are not NULL,
|
|
* and `p`'s x and y coordinates are >= to the rectangle's top left corner,
|
|
* and < the rectangle's x+w and y+h. So a 1x1 rectangle considers point (0,0)
|
|
* as "inside" and (0,1) as not.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param p the point to test.
|
|
* \param r the rectangle to test.
|
|
* \returns true if `p` is contained by `r`, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r)
|
|
{
|
|
return ( p && r && (p->x >= r->x) && (p->x < (r->x + r->w)) &&
|
|
(p->y >= r->y) && (p->y < (r->y + r->h)) ) ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether a rectangle has no area.
|
|
*
|
|
* A rectangle is considered "empty" for this function if `r` is NULL, or if
|
|
* `r`'s width and/or height are <= 0.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param r the rectangle to test.
|
|
* \returns true if the rectangle is "empty", false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_RectEmpty(const SDL_Rect *r)
|
|
{
|
|
return ((!r) || (r->w <= 0) || (r->h <= 0)) ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether two rectangles are equal.
|
|
*
|
|
* Rectangles are considered equal if both are not NULL and each of their x,
|
|
* y, width and height match.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param a the first rectangle to test.
|
|
* \param b the second rectangle to test.
|
|
* \returns true if the rectangles are equal, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_RectsEqual(const SDL_Rect *a, const SDL_Rect *b)
|
|
{
|
|
return (a && b && (a->x == b->x) && (a->y == b->y) &&
|
|
(a->w == b->w) && (a->h == b->h)) ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether two rectangles intersect.
|
|
*
|
|
* If either pointer is NULL the function will return false.
|
|
*
|
|
* \param A an SDL_Rect structure representing the first rectangle.
|
|
* \param B an SDL_Rect structure representing the second rectangle.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_GetRectIntersection
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersection(const SDL_Rect *A, const SDL_Rect *B);
|
|
|
|
/**
|
|
* Calculate the intersection of two rectangles.
|
|
*
|
|
* If `result` is NULL then this function will return false.
|
|
*
|
|
* \param A an SDL_Rect structure representing the first rectangle.
|
|
* \param B an SDL_Rect structure representing the second rectangle.
|
|
* \param result an SDL_Rect structure filled in with the intersection of
|
|
* rectangles `A` and `B`.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_HasRectIntersection
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectIntersection(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result);
|
|
|
|
/**
|
|
* Calculate the union of two rectangles.
|
|
*
|
|
* \param A an SDL_Rect structure representing the first rectangle.
|
|
* \param B an SDL_Rect structure representing the second rectangle.
|
|
* \param result an SDL_Rect structure filled in with the union of rectangles
|
|
* `A` and `B`.
|
|
* \returns true on success or false on failure; call SDL_GetError() for more
|
|
* information.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnion(const SDL_Rect *A, const SDL_Rect *B, 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.
|
|
*
|
|
* \param points an array of SDL_Point structures representing points to be
|
|
* enclosed.
|
|
* \param count the number of structures in the `points` array.
|
|
* \param clip an SDL_Rect used for clipping or NULL to enclose all points.
|
|
* \param result an SDL_Rect structure filled in with the minimal enclosing
|
|
* rectangle.
|
|
* \returns true if any points were enclosed or false if all the points were
|
|
* outside of the clipping rectangle.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPoints(const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param rect an SDL_Rect structure representing the rectangle to intersect.
|
|
* \param X1 a pointer to the starting X-coordinate of the line.
|
|
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
|
* \param X2 a pointer to the ending X-coordinate of the line.
|
|
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersection(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2);
|
|
|
|
|
|
/* SDL_FRect versions... */
|
|
|
|
/**
|
|
* Determine whether a point resides inside a floating point rectangle.
|
|
*
|
|
* A point is considered part of a rectangle if both `p` and `r` are not NULL,
|
|
* and `p`'s x and y coordinates are >= to the rectangle's top left corner,
|
|
* and <= the rectangle's x+w and y+h. So a 1x1 rectangle considers point
|
|
* (0,0) and (0,1) as "inside" and (0,2) as not.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param p the point to test.
|
|
* \param r the rectangle to test.
|
|
* \returns true if `p` is contained by `r`, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_PointInRectFloat(const SDL_FPoint *p, const SDL_FRect *r)
|
|
{
|
|
return ( p && r && (p->x >= r->x) && (p->x <= (r->x + r->w)) &&
|
|
(p->y >= r->y) && (p->y <= (r->y + r->h)) ) ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether a floating point rectangle can contain any point.
|
|
*
|
|
* A rectangle is considered "empty" for this function if `r` is NULL, or if
|
|
* `r`'s width and/or height are < 0.0f.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param r the rectangle to test.
|
|
* \returns true if the rectangle is "empty", false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_RectEmptyFloat(const SDL_FRect *r)
|
|
{
|
|
return ((!r) || (r->w < 0.0f) || (r->h < 0.0f)) ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether two floating point rectangles are equal, within some
|
|
* given epsilon.
|
|
*
|
|
* Rectangles are considered equal if both are not NULL and each of their x,
|
|
* y, width and height are within `epsilon` of each other. If you don't know
|
|
* what value to use for `epsilon`, you should call the SDL_RectsEqualFloat
|
|
* function instead.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param a the first rectangle to test.
|
|
* \param b the second rectangle to test.
|
|
* \param epsilon the epsilon value for comparison.
|
|
* \returns true if the rectangles are equal, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_RectsEqualFloat
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_RectsEqualEpsilon(const SDL_FRect *a, const SDL_FRect *b, const float epsilon)
|
|
{
|
|
return (a && b && ((a == b) ||
|
|
((SDL_fabsf(a->x - b->x) <= epsilon) &&
|
|
(SDL_fabsf(a->y - b->y) <= epsilon) &&
|
|
(SDL_fabsf(a->w - b->w) <= epsilon) &&
|
|
(SDL_fabsf(a->h - b->h) <= epsilon))))
|
|
? true : false;
|
|
}
|
|
|
|
/**
|
|
* Determine whether two floating point rectangles are equal, within a default
|
|
* epsilon.
|
|
*
|
|
* Rectangles are considered equal if both are not NULL and each of their x,
|
|
* y, width and height are within SDL_FLT_EPSILON of each other. This is often
|
|
* a reasonable way to compare two floating point rectangles and deal with the
|
|
* slight precision variations in floating point calculations that tend to pop
|
|
* up.
|
|
*
|
|
* Note that this is a forced-inline function in a header, and not a public
|
|
* API function available in the SDL library (which is to say, the code is
|
|
* embedded in the calling program and the linker and dynamic loader will not
|
|
* be able to find this function inside SDL itself).
|
|
*
|
|
* \param a the first rectangle to test.
|
|
* \param b the second rectangle to test.
|
|
* \returns true if the rectangles are equal, false otherwise.
|
|
*
|
|
* \threadsafety It is safe to call this function from any thread.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_RectsEqualEpsilon
|
|
*/
|
|
SDL_FORCE_INLINE bool SDL_RectsEqualFloat(const SDL_FRect *a, const SDL_FRect *b)
|
|
{
|
|
return SDL_RectsEqualEpsilon(a, b, SDL_FLT_EPSILON);
|
|
}
|
|
|
|
/**
|
|
* Determine whether two rectangles intersect with float precision.
|
|
*
|
|
* If either pointer is NULL the function will return false.
|
|
*
|
|
* \param A an SDL_FRect structure representing the first rectangle.
|
|
* \param B an SDL_FRect structure representing the second rectangle.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_GetRectIntersection
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_HasRectIntersectionFloat(const SDL_FRect *A, const SDL_FRect *B);
|
|
|
|
/**
|
|
* Calculate the intersection of two rectangles with float precision.
|
|
*
|
|
* If `result` is NULL then this function will return false.
|
|
*
|
|
* \param A an SDL_FRect structure representing the first rectangle.
|
|
* \param B an SDL_FRect structure representing the second rectangle.
|
|
* \param result an SDL_FRect structure filled in with the intersection of
|
|
* rectangles `A` and `B`.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*
|
|
* \sa SDL_HasRectIntersectionFloat
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectIntersectionFloat(const SDL_FRect *A, const SDL_FRect *B, SDL_FRect *result);
|
|
|
|
/**
|
|
* Calculate the union of two rectangles with float precision.
|
|
*
|
|
* \param A an SDL_FRect structure representing the first rectangle.
|
|
* \param B an SDL_FRect structure representing the second rectangle.
|
|
* \param result an SDL_FRect structure filled in with the union of rectangles
|
|
* `A` and `B`.
|
|
* \returns true on success or false on failure; call SDL_GetError() for more
|
|
* information.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectUnionFloat(const SDL_FRect *A, const SDL_FRect *B, 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.
|
|
*
|
|
* \param points an array of SDL_FPoint structures representing points to be
|
|
* enclosed.
|
|
* \param count the number of structures in the `points` array.
|
|
* \param clip an SDL_FRect used for clipping or NULL to enclose all points.
|
|
* \param result an SDL_FRect structure filled in with the minimal enclosing
|
|
* rectangle.
|
|
* \returns true if any points were enclosed or false if all the points were
|
|
* outside of the clipping rectangle.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectEnclosingPointsFloat(const SDL_FPoint *points, int count, const SDL_FRect *clip, SDL_FRect *result);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param rect an SDL_FRect structure representing the rectangle to intersect.
|
|
* \param X1 a pointer to the starting X-coordinate of the line.
|
|
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
|
* \param X2 a pointer to the ending X-coordinate of the line.
|
|
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
|
* \returns true if there is an intersection, false otherwise.
|
|
*
|
|
* \since This function is available since SDL 3.1.3.
|
|
*/
|
|
extern SDL_DECLSPEC bool SDLCALL SDL_GetRectAndLineIntersectionFloat(const SDL_FRect *rect, float *X1, float *Y1, float *X2, float *Y2);
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#include <SDL3/SDL_close_code.h>
|
|
|
|
#endif /* SDL_rect_h_ */
|