2 Simple DirectMedia Layer
3 Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
25 * Header file for SDL_rect definition and management functions.
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_pixels.h"
34 #include "SDL_rwops.h"
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
43 * The structure that defines a point (integer)
45 * \sa SDL_EnclosePoints
48 typedef struct SDL_Point
55 * The structure that defines a point (floating point)
57 * \sa SDL_EncloseFPoints
58 * \sa SDL_PointInFRect
60 typedef struct SDL_FPoint
68 * A rectangle, with the origin at the upper left (integer).
72 * \sa SDL_HasIntersection
73 * \sa SDL_IntersectRect
74 * \sa SDL_IntersectRectAndLine
76 * \sa SDL_EnclosePoints
78 typedef struct SDL_Rect
86 * A rectangle, with the origin at the upper left (floating point).
90 * \sa SDL_FRectEqualsEpsilon
91 * \sa SDL_HasIntersectionF
92 * \sa SDL_IntersectFRect
93 * \sa SDL_IntersectFRectAndLine
95 * \sa SDL_EncloseFPoints
96 * \sa SDL_PointInFRect
98 typedef struct SDL_FRect
108 * Returns true if point resides inside a rectangle.
110 SDL_FORCE_INLINE SDL_bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r)
112 return ( (p->x >= r->x) && (p->x < (r->x + r->w)) &&
113 (p->y >= r->y) && (p->y < (r->y + r->h)) ) ? SDL_TRUE : SDL_FALSE;
117 * Returns true if the rectangle has no area.
119 SDL_FORCE_INLINE SDL_bool SDL_RectEmpty(const SDL_Rect *r)
121 return ((!r) || (r->w <= 0) || (r->h <= 0)) ? SDL_TRUE : SDL_FALSE;
125 * Returns true if the two rectangles are equal.
127 SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b)
129 return (a && b && (a->x == b->x) && (a->y == b->y) &&
130 (a->w == b->w) && (a->h == b->h)) ? SDL_TRUE : SDL_FALSE;
134 * Determine whether two rectangles intersect.
136 * If either pointer is NULL the function will return SDL_FALSE.
138 * \param A an SDL_Rect structure representing the first rectangle
139 * \param B an SDL_Rect structure representing the second rectangle
140 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
142 * \since This function is available since SDL 2.0.0.
144 * \sa SDL_IntersectRect
146 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
150 * Calculate the intersection of two rectangles.
152 * If `result` is NULL then this function will return SDL_FALSE.
154 * \param A an SDL_Rect structure representing the first rectangle
155 * \param B an SDL_Rect structure representing the second rectangle
156 * \param result an SDL_Rect structure filled in with the intersection of
157 * rectangles `A` and `B`
158 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
160 * \since This function is available since SDL 2.0.0.
162 * \sa SDL_HasIntersection
164 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
169 * Calculate the union of two rectangles.
171 * \param A an SDL_Rect structure representing the first rectangle
172 * \param B an SDL_Rect structure representing the second rectangle
173 * \param result an SDL_Rect structure filled in with the union of rectangles
176 * \since This function is available since SDL 2.0.0.
178 extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
183 * Calculate a minimal rectangle enclosing a set of points.
185 * If `clip` is not NULL then only points inside of the clipping rectangle are
188 * \param points an array of SDL_Point structures representing points to be
190 * \param count the number of structures in the `points` array
191 * \param clip an SDL_Rect used for clipping or NULL to enclose all points
192 * \param result an SDL_Rect structure filled in with the minimal enclosing
194 * \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
195 * points were outside of the clipping rectangle.
197 * \since This function is available since SDL 2.0.0.
199 extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
201 const SDL_Rect * clip,
205 * Calculate the intersection of a rectangle and line segment.
207 * This function is used to clip a line segment to a rectangle. A line segment
208 * contained entirely within the rectangle or that does not intersect will
209 * remain unchanged. A line segment that crosses the rectangle at either or
210 * both ends will be clipped to the boundary of the rectangle and the new
211 * coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
213 * \param rect an SDL_Rect structure representing the rectangle to intersect
214 * \param X1 a pointer to the starting X-coordinate of the line
215 * \param Y1 a pointer to the starting Y-coordinate of the line
216 * \param X2 a pointer to the ending X-coordinate of the line
217 * \param Y2 a pointer to the ending Y-coordinate of the line
218 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
220 * \since This function is available since SDL 2.0.0.
222 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
228 /* SDL_FRect versions... */
231 * Returns true if point resides inside a rectangle.
233 SDL_FORCE_INLINE SDL_bool SDL_PointInFRect(const SDL_FPoint *p, const SDL_FRect *r)
235 return ( (p->x >= r->x) && (p->x < (r->x + r->w)) &&
236 (p->y >= r->y) && (p->y < (r->y + r->h)) ) ? SDL_TRUE : SDL_FALSE;
240 * Returns true if the rectangle has no area.
242 SDL_FORCE_INLINE SDL_bool SDL_FRectEmpty(const SDL_FRect *r)
244 return ((!r) || (r->w <= 0.0f) || (r->h <= 0.0f)) ? SDL_TRUE : SDL_FALSE;
248 * Returns true if the two rectangles are equal, within some given epsilon.
250 * \since This function is available since SDL 2.0.22.
252 SDL_FORCE_INLINE SDL_bool SDL_FRectEqualsEpsilon(const SDL_FRect *a, const SDL_FRect *b, const float epsilon)
254 return (a && b && ((a == b) ||
255 ((SDL_fabs(a->x - b->x) <= epsilon) &&
256 (SDL_fabs(a->y - b->y) <= epsilon) &&
257 (SDL_fabs(a->w - b->w) <= epsilon) &&
258 (SDL_fabs(a->h - b->h) <= epsilon))))
259 ? SDL_TRUE : SDL_FALSE;
263 * Returns true if the two rectangles are equal, using a default epsilon.
265 * \since This function is available since SDL 2.0.22.
267 SDL_FORCE_INLINE SDL_bool SDL_FRectEquals(const SDL_FRect *a, const SDL_FRect *b)
269 return SDL_FRectEqualsEpsilon(a, b, SDL_FLT_EPSILON);
273 * Determine whether two rectangles intersect with float precision.
275 * If either pointer is NULL the function will return SDL_FALSE.
277 * \param A an SDL_FRect structure representing the first rectangle
278 * \param B an SDL_FRect structure representing the second rectangle
279 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
281 * \since This function is available since SDL 2.0.22.
283 * \sa SDL_IntersectRect
285 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersectionF(const SDL_FRect * A,
286 const SDL_FRect * B);
289 * Calculate the intersection of two rectangles with float precision.
291 * If `result` is NULL then this function will return SDL_FALSE.
293 * \param A an SDL_FRect structure representing the first rectangle
294 * \param B an SDL_FRect structure representing the second rectangle
295 * \param result an SDL_FRect structure filled in with the intersection of
296 * rectangles `A` and `B`
297 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
299 * \since This function is available since SDL 2.0.22.
301 * \sa SDL_HasIntersectionF
303 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectFRect(const SDL_FRect * A,
308 * Calculate the union of two rectangles with float precision.
310 * \param A an SDL_FRect structure representing the first rectangle
311 * \param B an SDL_FRect structure representing the second rectangle
312 * \param result an SDL_FRect structure filled in with the union of rectangles
315 * \since This function is available since SDL 2.0.22.
317 extern DECLSPEC void SDLCALL SDL_UnionFRect(const SDL_FRect * A,
322 * Calculate a minimal rectangle enclosing a set of points with float
325 * If `clip` is not NULL then only points inside of the clipping rectangle are
328 * \param points an array of SDL_FPoint structures representing points to be
330 * \param count the number of structures in the `points` array
331 * \param clip an SDL_FRect used for clipping or NULL to enclose all points
332 * \param result an SDL_FRect structure filled in with the minimal enclosing
334 * \returns SDL_TRUE if any points were enclosed or SDL_FALSE if all the
335 * points were outside of the clipping rectangle.
337 * \since This function is available since SDL 2.0.22.
339 extern DECLSPEC SDL_bool SDLCALL SDL_EncloseFPoints(const SDL_FPoint * points,
341 const SDL_FRect * clip,
345 * Calculate the intersection of a rectangle and line segment with float
348 * This function is used to clip a line segment to a rectangle. A line segment
349 * contained entirely within the rectangle or that does not intersect will
350 * remain unchanged. A line segment that crosses the rectangle at either or
351 * both ends will be clipped to the boundary of the rectangle and the new
352 * coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
354 * \param rect an SDL_FRect structure representing the rectangle to intersect
355 * \param X1 a pointer to the starting X-coordinate of the line
356 * \param Y1 a pointer to the starting Y-coordinate of the line
357 * \param X2 a pointer to the ending X-coordinate of the line
358 * \param Y2 a pointer to the ending Y-coordinate of the line
359 * \returns SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
361 * \since This function is available since SDL 2.0.22.
363 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectFRectAndLine(const SDL_FRect *
365 float *Y1, float *X2,
368 /* Ends C function definitions when using C++ */
372 #include "close_code.h"
374 #endif /* SDL_rect_h_ */
376 /* vi: set ts=4 sw=4 expandtab: */