SDL 2.0
SDL_rect.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 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
22/**
23 * \file SDL_rect.h
24 *
25 * Header file for SDL_rect definition and management functions.
26 */
27
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
39extern "C" {
40#endif
41
42/**
43 * \brief The structure that defines a point (integer)
44 *
45 * \sa SDL_EnclosePoints
46 * \sa SDL_PointInRect
47 */
48typedef struct SDL_Point
49{
50 int x;
51 int y;
52} SDL_Point;
53
54/**
55 * \brief The structure that defines a point (floating point)
56 *
57 * \sa SDL_EnclosePoints
58 * \sa SDL_PointInRect
59 */
60typedef struct SDL_FPoint
61{
62 float x;
63 float y;
65
66
67/**
68 * \brief A rectangle, with the origin at the upper left (integer).
69 *
70 * \sa SDL_RectEmpty
71 * \sa SDL_RectEquals
72 * \sa SDL_HasIntersection
73 * \sa SDL_IntersectRect
74 * \sa SDL_UnionRect
75 * \sa SDL_EnclosePoints
76 */
77typedef struct SDL_Rect
78{
79 int x, y;
80 int w, h;
81} SDL_Rect;
82
83
84/**
85 * \brief A rectangle, with the origin at the upper left (floating point).
86 */
87typedef struct SDL_FRect
88{
89 float x;
90 float y;
91 float w;
92 float h;
93} SDL_FRect;
94
95
96/**
97 * \brief Returns true if point resides inside a rectangle.
98 */
100{
101 return ( (p->x >= r->x) && (p->x < (r->x + r->w)) &&
102 (p->y >= r->y) && (p->y < (r->y + r->h)) ) ? SDL_TRUE : SDL_FALSE;
103}
104
105/**
106 * \brief Returns true if the rectangle has no area.
107 */
109{
110 return ((!r) || (r->w <= 0) || (r->h <= 0)) ? SDL_TRUE : SDL_FALSE;
111}
112
113/**
114 * \brief Returns true if the two rectangles are equal.
115 */
117{
118 return (a && b && (a->x == b->x) && (a->y == b->y) &&
119 (a->w == b->w) && (a->h == b->h)) ? SDL_TRUE : SDL_FALSE;
120}
121
122/**
123 * \brief Determine whether two rectangles intersect.
124 *
125 * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
126 */
128 const SDL_Rect * B);
129
130/**
131 * \brief Calculate the intersection of two rectangles.
132 *
133 * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
134 */
136 const SDL_Rect * B,
137 SDL_Rect * result);
138
139/**
140 * \brief Calculate the union of two rectangles.
141 */
142extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
143 const SDL_Rect * B,
144 SDL_Rect * result);
145
146/**
147 * \brief Calculate a minimal rectangle enclosing a set of points
148 *
149 * \return SDL_TRUE if any points were within the clipping rect
150 */
152 int count,
153 const SDL_Rect * clip,
154 SDL_Rect * result);
155
156/**
157 * \brief Calculate the intersection of a rectangle and line segment.
158 *
159 * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
160 */
162 rect, int *X1,
163 int *Y1, int *X2,
164 int *Y2);
165
166/* Ends C function definitions when using C++ */
167#ifdef __cplusplus
168}
169#endif
170#include "close_code.h"
171
172#endif /* SDL_rect_h_ */
173
174/* vi: set ts=4 sw=4 expandtab: */
#define SDLCALL
Definition: SDL_internal.h:49
#define DECLSPEC
Definition: SDL_internal.h:48
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
GLdouble GLdouble GLdouble r
Definition: SDL_opengl.h:2079
GLboolean GLboolean GLboolean b
GLfixed GLfixed GLint GLint GLfixed points
GLuint64EXT * result
GLboolean GLboolean GLboolean GLboolean a
GLfloat GLfloat p
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:116
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:99
SDL_bool SDL_IntersectRect(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
Calculate the intersection of two rectangles.
Definition: SDL_rect.c:75
SDL_bool SDL_EnclosePoints(const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result)
Calculate a minimal rectangle enclosing a set of points.
Definition: SDL_rect.c:192
SDL_bool SDL_HasIntersection(const SDL_Rect *A, const SDL_Rect *B)
Determine whether two rectangles intersect.
Definition: SDL_rect.c:28
void SDL_UnionRect(const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
Calculate the union of two rectangles.
Definition: SDL_rect.c:129
SDL_bool SDL_IntersectRectAndLine(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2)
Calculate the intersection of a rectangle and line segment.
Definition: SDL_rect.c:317
SDL_FORCE_INLINE SDL_bool SDL_RectEmpty(const SDL_Rect *r)
Returns true if the rectangle has no area.
Definition: SDL_rect.h:108
SDL_bool
Definition: SDL_stdinc.h:162
@ SDL_TRUE
Definition: SDL_stdinc.h:164
@ SDL_FALSE
Definition: SDL_stdinc.h:163
#define SDL_FORCE_INLINE
Definition: begin_code.h:147
The structure that defines a point (floating point)
Definition: SDL_rect.h:61
float x
Definition: SDL_rect.h:62
float y
Definition: SDL_rect.h:63
A rectangle, with the origin at the upper left (floating point).
Definition: SDL_rect.h:88
float h
Definition: SDL_rect.h:92
float x
Definition: SDL_rect.h:89
float w
Definition: SDL_rect.h:91
float y
Definition: SDL_rect.h:90
The structure that defines a point (integer)
Definition: SDL_rect.h:49
int x
Definition: SDL_rect.h:50
int y
Definition: SDL_rect.h:51
A rectangle, with the origin at the upper left (integer).
Definition: SDL_rect.h:78
int h
Definition: SDL_rect.h:80
int w
Definition: SDL_rect.h:80
int y
Definition: SDL_rect.h:79
int x
Definition: SDL_rect.h:79
SDL_Rect rect
Definition: testrelative.c:27