My Project
SDL_rect.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
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.
8 
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:
12 
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.
20 */
21 
28 #ifndef SDL_rect_h_
29 #define SDL_rect_h_
30 
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_pixels.h"
34 #include "SDL_rwops.h"
35 
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
48 typedef struct SDL_Point
49 {
50  int x;
51  int y;
52 } SDL_Point;
53 
64 typedef struct SDL_Rect
65 {
66  int x, y;
67  int w, h;
68 } SDL_Rect;
69 
73 SDL_FORCE_INLINE SDL_bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r)
74 {
75  return ( (p->x >= r->x) && (p->x < (r->x + r->w)) &&
76  (p->y >= r->y) && (p->y < (r->y + r->h)) ) ? SDL_TRUE : SDL_FALSE;
77 }
78 
82 SDL_FORCE_INLINE SDL_bool SDL_RectEmpty(const SDL_Rect *r)
83 {
84  return ((!r) || (r->w <= 0) || (r->h <= 0)) ? SDL_TRUE : SDL_FALSE;
85 }
86 
90 SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b)
91 {
92  return (a && b && (a->x == b->x) && (a->y == b->y) &&
93  (a->w == b->w) && (a->h == b->h)) ? SDL_TRUE : SDL_FALSE;
94 }
95 
101 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
102  const SDL_Rect * B);
103 
109 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
110  const SDL_Rect * B,
111  SDL_Rect * result);
112 
116 extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
117  const SDL_Rect * B,
118  SDL_Rect * result);
119 
125 extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
126  int count,
127  const SDL_Rect * clip,
128  SDL_Rect * result);
129 
135 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
136  rect, int *X1,
137  int *Y1, int *X2,
138  int *Y2);
139 
140 /* Ends C function definitions when using C++ */
141 #ifdef __cplusplus
142 }
143 #endif
144 #include "close_code.h"
145 
146 #endif /* SDL_rect_h_ */
147 
148 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
Calculate the intersection of two rectangles.
struct SDL_Point SDL_Point
The structure that defines a point.
SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b)
Returns true if the two rectangles are equal.
Definition: SDL_rect.h:90
A rectangle, with the origin at the upper left.
Definition: SDL_rect.h:64
struct SDL_Rect SDL_Rect
A rectangle, with the origin at the upper left.
SDL_FORCE_INLINE SDL_bool SDL_RectEmpty(const SDL_Rect *r)
Returns true if the rectangle has no area.
Definition: SDL_rect.h:82
SDL_FORCE_INLINE SDL_bool SDL_PointInRect(const SDL_Point *p, const SDL_Rect *r)
Returns true if point resides inside a rectangle.
Definition: SDL_rect.h:73
The structure that defines a point.
Definition: SDL_rect.h:48
DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
Calculate the union of two rectangles.
DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect *A, const SDL_Rect *B)
Determine whether two rectangles intersect.
DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result)
Calculate a minimal rectangle enclosing a set of points.
DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2)
Calculate the intersection of a rectangle and line segment.