xref: /openbmc/linux/include/drm/drm_rect.h (revision 0894c96b)
1 /*
2  * Copyright (C) 2011-2013 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 
24 #ifndef DRM_RECT_H
25 #define DRM_RECT_H
26 
27 /**
28  * drm_rect - two dimensional rectangle
29  * @x1: horizontal starting coordinate (inclusive)
30  * @x2: horizontal ending coordinate (exclusive)
31  * @y1: vertical starting coordinate (inclusive)
32  * @y2: vertical ending coordinate (exclusive)
33  */
34 struct drm_rect {
35 	int x1, y1, x2, y2;
36 };
37 
38 /**
39  * drm_rect_adjust_size - adjust the size of the rectangle
40  * @r: rectangle to be adjusted
41  * @dw: horizontal adjustment
42  * @dh: vertical adjustment
43  *
44  * Change the size of rectangle @r by @dw in the horizontal direction,
45  * and by @dh in the vertical direction, while keeping the center
46  * of @r stationary.
47  *
48  * Positive @dw and @dh increase the size, negative values decrease it.
49  */
50 static inline void drm_rect_adjust_size(struct drm_rect *r, int dw, int dh)
51 {
52 	r->x1 -= dw >> 1;
53 	r->y1 -= dh >> 1;
54 	r->x2 += (dw + 1) >> 1;
55 	r->y2 += (dh + 1) >> 1;
56 }
57 
58 /**
59  * drm_rect_translate - translate the rectangle
60  * @r: rectangle to be tranlated
61  * @dx: horizontal translation
62  * @dy: vertical translation
63  *
64  * Move rectangle @r by @dx in the horizontal direction,
65  * and by @dy in the vertical direction.
66  */
67 static inline void drm_rect_translate(struct drm_rect *r, int dx, int dy)
68 {
69 	r->x1 += dx;
70 	r->y1 += dy;
71 	r->x2 += dx;
72 	r->y2 += dy;
73 }
74 
75 /**
76  * drm_rect_downscale - downscale a rectangle
77  * @r: rectangle to be downscaled
78  * @horz: horizontal downscale factor
79  * @vert: vertical downscale factor
80  *
81  * Divide the coordinates of rectangle @r by @horz and @vert.
82  */
83 static inline void drm_rect_downscale(struct drm_rect *r, int horz, int vert)
84 {
85 	r->x1 /= horz;
86 	r->y1 /= vert;
87 	r->x2 /= horz;
88 	r->y2 /= vert;
89 }
90 
91 /**
92  * drm_rect_width - determine the rectangle width
93  * @r: rectangle whose width is returned
94  *
95  * RETURNS:
96  * The width of the rectangle.
97  */
98 static inline int drm_rect_width(const struct drm_rect *r)
99 {
100 	return r->x2 - r->x1;
101 }
102 
103 /**
104  * drm_rect_height - determine the rectangle height
105  * @r: rectangle whose height is returned
106  *
107  * RETURNS:
108  * The height of the rectangle.
109  */
110 static inline int drm_rect_height(const struct drm_rect *r)
111 {
112 	return r->y2 - r->y1;
113 }
114 
115 /**
116  * drm_rect_visible - determine if the the rectangle is visible
117  * @r: rectangle whose visibility is returned
118  *
119  * RETURNS:
120  * %true if the rectangle is visible, %false otherwise.
121  */
122 static inline bool drm_rect_visible(const struct drm_rect *r)
123 {
124 	return drm_rect_width(r) > 0 && drm_rect_height(r) > 0;
125 }
126 
127 /**
128  * drm_rect_equals - determine if two rectangles are equal
129  * @r1: first rectangle
130  * @r2: second rectangle
131  *
132  * RETURNS:
133  * %true if the rectangles are equal, %false otherwise.
134  */
135 static inline bool drm_rect_equals(const struct drm_rect *r1,
136 				   const struct drm_rect *r2)
137 {
138 	return r1->x1 == r2->x1 && r1->x2 == r2->x2 &&
139 		r1->y1 == r2->y1 && r1->y2 == r2->y2;
140 }
141 
142 bool drm_rect_intersect(struct drm_rect *r, const struct drm_rect *clip);
143 bool drm_rect_clip_scaled(struct drm_rect *src, struct drm_rect *dst,
144 			  const struct drm_rect *clip,
145 			  int hscale, int vscale);
146 int drm_rect_calc_hscale(const struct drm_rect *src,
147 			 const struct drm_rect *dst,
148 			 int min_hscale, int max_hscale);
149 int drm_rect_calc_vscale(const struct drm_rect *src,
150 			 const struct drm_rect *dst,
151 			 int min_vscale, int max_vscale);
152 int drm_rect_calc_hscale_relaxed(struct drm_rect *src,
153 				 struct drm_rect *dst,
154 				 int min_hscale, int max_hscale);
155 int drm_rect_calc_vscale_relaxed(struct drm_rect *src,
156 				 struct drm_rect *dst,
157 				 int min_vscale, int max_vscale);
158 void drm_rect_debug_print(const struct drm_rect *r, bool fixed_point);
159 
160 #endif
161