forked from enlightenment/efl
598 lines
20 KiB
C
598 lines
20 KiB
C
/* EINA - EFL data type library
|
|
* Copyright (C) 2007-2008 Jorge Luis Zapata Muga
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library;
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef EINA_RECTANGLE_H_
|
|
#define EINA_RECTANGLE_H_
|
|
|
|
#include "eina_types.h"
|
|
|
|
/**
|
|
* @addtogroup Eina_Rectangle_Group Rectangle
|
|
*
|
|
* @brief These functions provide rectangle management.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Tools_Group Tools
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Rectangle_Group Rectangle
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#define EINA_RECTANGLE_INIT { 0, 0, 0, 0}
|
|
#define EINA_RECTANGLE_FORMAT "dx%d - %dx%d"
|
|
#define EINA_RECTANGLE_ARGS(r) (r)->x, (r)->y, (r)->w, (r)->h
|
|
|
|
#define EINA_RECT(x, y, w, h) ((Eina_Rect) { { (x), (y), (w), (h) } })
|
|
#define EINA_RECT_ZERO() { EINA_RECTANGLE_INIT }
|
|
#define EINA_RECT_EMPTY() ((Eina_Rect) EINA_RECT_ZERO())
|
|
|
|
#define EINA_POSITION2D(x, y) ((Eina_Position2D) { (x), (y) })
|
|
#define EINA_SIZE2D(x, y) ((Eina_Size2D) { (x), (y) })
|
|
|
|
/** @brief A 2D position in pixel coordinates */
|
|
typedef struct _Eina_Position2D
|
|
{
|
|
int x, y;
|
|
} Eina_Position2D;
|
|
|
|
/** @brief A 2D size in pixel coordinates */
|
|
typedef struct _Eina_Size2D
|
|
{
|
|
int w, h;
|
|
} Eina_Size2D;
|
|
|
|
|
|
/**
|
|
* @brief convenience macro for comparing two Eina_Size2D structs
|
|
* @param[in] a An Eina_Size2D
|
|
* @param[in] b An Eina_Size2D
|
|
* @return 1 if the structs are equal, 0 if they are not
|
|
* @since 1.24
|
|
*/
|
|
#define EINA_SIZE2D_EQ(a, b) \
|
|
(((a).w == (b).w) && ((a).h == (b).h))
|
|
|
|
/**
|
|
* @brief convenience macro for comparing two Eina_Position2D structs
|
|
* @param[in] a An Eina_Position2D
|
|
* @param[in] b An Eina_Position2D
|
|
* @return 1 if the structs are equal, 0 if they are not
|
|
* @since 1.24
|
|
*/
|
|
#define EINA_POSITION2D_EQ(a, b) \
|
|
(((a).x == (b).x) && ((a).y == (b).y))
|
|
|
|
/**
|
|
* @typedef Eina_Rectangle
|
|
* Simple rectangle structure.
|
|
*/
|
|
typedef struct _Eina_Rectangle
|
|
{
|
|
int x; /**< top-left x coordinate of rectangle */
|
|
int y; /**< top-left y coordinate of rectangle */
|
|
int w; /**< width of rectangle */
|
|
int h; /**< height of rectangle */
|
|
} Eina_Rectangle;
|
|
|
|
typedef union _Eina_Rect
|
|
{
|
|
Eina_Rectangle rect;
|
|
struct {
|
|
Eina_Position2D pos;
|
|
Eina_Size2D size;
|
|
};
|
|
struct {
|
|
int x, y, w, h;
|
|
};
|
|
} Eina_Rect;
|
|
|
|
/**
|
|
* @typedef Eina_Rectangle_Pool
|
|
* Type for an opaque pool of rectangles.
|
|
*/
|
|
typedef struct _Eina_Rectangle_Pool Eina_Rectangle_Pool;
|
|
|
|
/**
|
|
* @typedef Eina_Rectangle_Packing
|
|
* Type for an Eina Pool based on a packing algorithm.
|
|
* @since 1.11
|
|
*/
|
|
typedef enum {
|
|
Eina_Packing_Descending, /**< Current */
|
|
Eina_Packing_Ascending, /**< sorting in ascending order */
|
|
Eina_Packing_Bottom_Left, /**< sorting in bottom left fashion */
|
|
Eina_Packing_Bottom_Left_Skyline, /**< bottom left skyline */
|
|
Eina_Packing_Bottom_Left_Skyline_Improved /**< optimized bottom left skyline */
|
|
} Eina_Rectangle_Packing;
|
|
|
|
/**
|
|
* @typedef Eina_Rectangle_Outside
|
|
* Enumeration of the positions around a rectangle.
|
|
* @since 1.19
|
|
*/
|
|
typedef enum {
|
|
EINA_RECTANGLE_OUTSIDE_TOP = 1,
|
|
EINA_RECTANGLE_OUTSIDE_LEFT = 2,
|
|
EINA_RECTANGLE_OUTSIDE_BOTTOM = 4,
|
|
EINA_RECTANGLE_OUTSIDE_RIGHT = 8
|
|
} Eina_Rectangle_Outside;
|
|
|
|
|
|
/**
|
|
* @brief Checks if the given spans intersect.
|
|
*
|
|
* @param[in] c1 The column of the first span.
|
|
* @param[in] l1 The length of the first span.
|
|
* @param[in] c2 The column of the second span.
|
|
* @param[in] l2 The length of the second span.
|
|
* @return #EINA_TRUE if the given spans intersect, #EINA_FALSE otherwise.
|
|
*/
|
|
static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Checks if the given rectangle is empty.
|
|
*
|
|
* @param[in] rect The rectangle to check.
|
|
* @return #EINA_TRUE if the rectangle @p r is empty, #EINA_FALSE
|
|
* otherwise.
|
|
*
|
|
* No check is done on @p r, so it must be a valid rectangle.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_is_empty(const Eina_Rectangle *rect) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Sets the coordinates and size of a rectangle.
|
|
*
|
|
* @param[out] rect The rectangle.
|
|
* @param[in] x The X coordinate of the rectangle's top-left corner.
|
|
* @param[in] y The Y coordinate of the rectangle's top-left corner.
|
|
* @param[in] w The width of the rectangle.
|
|
* @param[in] h The height of the rectangle.
|
|
*
|
|
* This function sets its top-left X coordinate to @p x, its top-left
|
|
* Y coordinate to @p y, its width to @p w and its height to @p h.
|
|
*
|
|
* No check is done on @p r, so it must be a valid rectangle.
|
|
*/
|
|
static inline void eina_rectangle_coords_from(Eina_Rectangle *rect, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Checks if two rectangles intersect.
|
|
*
|
|
* @param[in] rect1 The first rectangle.
|
|
* @param[in] rect2 The second rectangle.
|
|
* @return #EINA_TRUE if the rectangles @p rect1 and @p rect2 intersect,
|
|
* #EINA_FALSE otherwise.
|
|
*
|
|
* No check is done on @p rect1 and @p rect2, so they must be valid
|
|
* rectangles.
|
|
*/
|
|
static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *rect1, const Eina_Rectangle *rect2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Checks if the given X-coordinate is in the rectangle.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @param[in] x The X coordinate.
|
|
* @return #EINA_TRUE if @p x is between the rectangle's left and right
|
|
* edges, #EINA_FALSE otherwise.
|
|
*
|
|
* No check is done on @p r, so it must be a valid rectangle.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *rect, int x) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Checks if the given Y-coordinate is in the rectangle.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @param[in] y The Y coordinate.
|
|
* @return #EINA_TRUE if @p y is between the rectangle's top and bottom
|
|
* edges, #EINA_FALSE otherwise.
|
|
*
|
|
* No check is done on @p r, so it must be a valid rectangle.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_ycoord_inside(const Eina_Rectangle *rect, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Checks if the given point is inside the rectangle.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @param[in] x The x coordinate of the point.
|
|
* @param[in] y The y coordinate of the point.
|
|
* @return #EINA_TRUE if the point (@p x, @p y) is within the edges of
|
|
* @p r, #EINA_FALSE otherwise.
|
|
*
|
|
* No check is done on @p r, so it must be a valid rectangle.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_coords_inside(const Eina_Rectangle *rect, int x, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Gets the union of two rectangles.
|
|
*
|
|
* @param[in,out] dst The first rectangle.
|
|
* @param[in] src The second rectangle.
|
|
*
|
|
* Changes @p dst to be the bounding box of both rectangles @p dst and
|
|
* @p src.
|
|
*
|
|
* No check is done on @p dst or @p src, so they must be valid
|
|
* rectangles.
|
|
*/
|
|
static inline void eina_rectangle_union(Eina_Rectangle *dst, const Eina_Rectangle *src) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* @brief Gets the intersection of two rectangles.
|
|
*
|
|
* @param[in,out] dst The first rectangle.
|
|
* @param[in] src The second rectangle.
|
|
* @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE
|
|
* otherwise.
|
|
*
|
|
* Changes @p dst to be the rectangle represented by the intersection of
|
|
* @p dst and @p src. @p dst is unchanged if the two rectangles do not
|
|
* intersect.
|
|
*
|
|
* No check is done on @p dst or @p src, so they must be valid
|
|
* rectangles.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_intersection(Eina_Rectangle *dst, const Eina_Rectangle *src) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief FIXME I am useless and used by no one
|
|
*
|
|
* @param in The inner rectangle.
|
|
* @param out The outer rectangle.
|
|
* @param res The resulting rectangle.
|
|
*
|
|
*/
|
|
static inline void eina_rectangle_rescale_in(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* @brief FIXME I am useless and used by no one
|
|
*
|
|
* @param in The inner rectangle.
|
|
* @param out The outer rectangle.
|
|
* @param res The resulting rectangle.
|
|
*
|
|
*/
|
|
static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* @brief Tells whether a rectangle is valid.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @return #EINA_TRUE if the rectangle is valid, #EINA_FALSE otherwise.
|
|
*
|
|
* This function checks if both width and height attributes of the rectangle are
|
|
* positive integers. If so, the rectangle is considered valid, else the
|
|
* rectangle is invalid.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Gets the rectangle's maximum X coordinate.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @return The maximum X coordinate.
|
|
*
|
|
* This function calculates the maximum X coordinate of the rectangle by summing
|
|
* the @p width with the current @p x coordinate of the rectangle.
|
|
*/
|
|
static inline int eina_rectangle_max_x(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Gets the rectangle maximum Y coordinate.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @return The maximum Y coordinate.
|
|
*
|
|
* This function calculates the maximum Y coordinate of the rectangle by summing
|
|
* the @p height with the current @p y coordinate of the rectangle.
|
|
*/
|
|
static inline int eina_rectangle_max_y(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Slices a rectangle vertically into two subrectangles.
|
|
*
|
|
* @param[in] rect The rectangle to slice.
|
|
* @param[out] slice The sliced part of the rectangle.
|
|
* @param[out] remainder The left over part of the rectangle after slicing.
|
|
* @param[in] amount The slice location's horizontal distance from the left.
|
|
* @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise.
|
|
*
|
|
* Cut a rectangle vertically at a distance @p amount from the
|
|
* rectangle's left edge. If the @p amount value is greater than the
|
|
* rectangle's width, no cut is performed and #EINA_FALSE is returned.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *rect, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Slices a rectangle horizontally into two subrectangles.
|
|
*
|
|
* @param[in] rect The rectangle to slice.
|
|
* @param[out] slice The sliced part of the rectangle.
|
|
* @param[out] remainder The left over part of the rectangle after slicing.
|
|
* @param[in] amount The slice location's vertical distance from the bottom.
|
|
* @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
|
|
*
|
|
* Cut a rectangle horizontally at a distance @p amount from the
|
|
* rectangle's bottom edge. If the @p amount value is greater than the
|
|
* rectangle's height, no cut is performed and #EINA_FALSE is returned.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *rect, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Slices a rectangle vertically starting from right edge.
|
|
*
|
|
* @param[in] rect The rectangle to slice.
|
|
* @param[out] slice The sliced part of the rectangle.
|
|
* @param[out] remainder The left over part of the rectangle after slicing.
|
|
* @param[in] amount The slice location's horizontal distance from the right.
|
|
* @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
|
|
*
|
|
* Cut a rectangle vertically at a distance @p amount from the
|
|
* rectangle's right edge. If the @p amount value is greater than the
|
|
* rectangle's width, no cut is performed and #EINA_FALSE is returned.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *rect, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Slices a rectangle horizontally starting from top edge.
|
|
*
|
|
* @param[in] rect The rectangle to slice.
|
|
* @param[out] slice The sliced part of the rectangle.
|
|
* @param[out] remainder The left over part of the rectangle after slicing.
|
|
* @param[in] amount The slice location's vertical distance from the top.
|
|
* @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise.
|
|
*
|
|
* Cut a rectangle horizontally at a distance @p amount from the
|
|
* rectangle's top edge. If the @p amount value is greater than the
|
|
* rectangle width, no cut is performed and #EINA_FALSE is returned.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_height_cut(Eina_Rectangle *rect, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Subtracts two rectangles and returns the differences.
|
|
*
|
|
* @param[in] rect The minuend rectangle.
|
|
* @param[in] other The subtrahend rectangle.
|
|
* @param[out] out An array of differences between the two rectangles.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
|
*
|
|
* This function subtracts two rectangles and stores the resulting
|
|
* differences into the @p out array. There will be at most four
|
|
* differences; use eina_rectangle_is_valid to confirm the exact number.
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_subtract(Eina_Rectangle *rect, Eina_Rectangle *other, Eina_Rectangle out[4]) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Adds a rectangle in a new pool.
|
|
*
|
|
* @param[in] w The width of the rectangle.
|
|
* @param[in] h The height of the rectangle.
|
|
* @return A newly allocated pool on success, @c NULL otherwise.
|
|
*
|
|
* This function adds the rectangle of size (@p width, @p height) to a
|
|
* new pool. If the pool can not be created, @c NULL is
|
|
* returned. Otherwise the newly allocated pool is returned.
|
|
*/
|
|
EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Returns the pool of the given rectangle.
|
|
*
|
|
* @param[in] rect The rectangle.
|
|
* @return The pool of the given rectangle.
|
|
*
|
|
* This function returns the pool in which @p rect is. If @p rect is
|
|
* @c NULL, @c NULL is returned.
|
|
*/
|
|
EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Returns the width and height of the given pool.
|
|
*
|
|
* @param[in] pool The pool.
|
|
* @param[out] w The returned width.
|
|
* @param[out] h The returned height.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
|
*
|
|
* This function returns the width and height of @p pool and store
|
|
* them in respectively @p w and @p h if they are not @c NULL. If
|
|
* @p pool is @c NULL, #EINA_FALSE is returned. Otherwise #EINA_TRUE is
|
|
* returned.
|
|
*/
|
|
EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *pool, int *w, int *h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Gets the data from the given pool.
|
|
*
|
|
* @param[in] pool The pool.
|
|
* @return The returned data.
|
|
*
|
|
* This function gets the data from @p pool set by
|
|
* eina_rectangle_pool_data_set(). If @p pool is @c NULL, this
|
|
* function returns @c NULL.
|
|
*/
|
|
EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Sets the data to the given pool.
|
|
*
|
|
* @param[in,out] pool The pool.
|
|
* @param[in] data The data to set.
|
|
*
|
|
* This function sets @p data to @p pool. If @p pool is @c NULL, this
|
|
* function does nothing.
|
|
*/
|
|
EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool, const void *data) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Frees the given pool.
|
|
*
|
|
* @param[in] pool The pool to free.
|
|
*
|
|
* This function frees the allocated data of @p pool. If @p pool is
|
|
* @c NULL, this function returned immediately.
|
|
*/
|
|
EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Returns the number of rectangles in the given pool.
|
|
*
|
|
* @param[in] pool The pool.
|
|
* @return The number of rectangles in the pool.
|
|
*
|
|
* This function returns the number of rectangles in @p pool.
|
|
*/
|
|
EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Requests a rectangle of given size in the given pool.
|
|
*
|
|
* @param[in,out] pool The pool.
|
|
* @param[in] w The width of the rectangle to request.
|
|
* @param[in] h The height of the rectangle to request.
|
|
* @return The requested rectangle on success, @c NULL otherwise.
|
|
*
|
|
* This function retrieves from @p pool the rectangle of width @p w and
|
|
* height @p h. If @p pool is @c NULL, or @p w or @p h are non-positive,
|
|
* the function returns @c NULL. If @p w or @p h are greater than the
|
|
* pool size, the function returns @c NULL. On success, the function
|
|
* returns the rectangle which matches the size (@p w, @p h).
|
|
* Otherwise it returns @c NULL.
|
|
*/
|
|
EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool, int w, int h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Removes the given rectangle from the pool.
|
|
*
|
|
* @param[in,out] rect The rectangle to remove from the pool.
|
|
*
|
|
* This function removes @p rect from the pool. If @p rect is
|
|
* @c NULL, the function returns immediately. Otherwise it removes @p
|
|
* rect from the pool.
|
|
*/
|
|
EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @def EINA_RECTANGLE_SET
|
|
* @brief Definition for the macro to set the values of a #Eina_Rectangle.
|
|
*
|
|
* @param[out] Rectangle The rectangle.
|
|
* @param[in] X The X coordinate of the top left corner of the rectangle.
|
|
* @param[in] Y The Y coordinate of the top left corner of the rectangle.
|
|
* @param[in] W The width of the rectangle.
|
|
* @param[in] H The height of the rectangle.
|
|
*
|
|
* This macro set the values of @p Rectangle. @p X and @p Y are the
|
|
* coordinates of the top left corner of @p Rectangle, @p W is its
|
|
* width and @p H is its height.
|
|
*/
|
|
#define EINA_RECTANGLE_SET(Rectangle, X, Y, W, H) \
|
|
{ \
|
|
(Rectangle)->x = X; \
|
|
(Rectangle)->y = Y; \
|
|
(Rectangle)->w = W; \
|
|
(Rectangle)->h = H; \
|
|
}
|
|
|
|
#define EINA_RECT_SET(rect, x, y, w, h) do { EINA_RECTANGLE_SET((&rect), x, y, w, h) } while (0)
|
|
|
|
|
|
/**
|
|
* @brief Creates a new rectangle.
|
|
*
|
|
* @param[in] x The X coordinate of the top left corner of the rectangle.
|
|
* @param[in] y The Y coordinate of the top left corner of the rectangle.
|
|
* @param[in] w The width of the rectangle.
|
|
* @param[in] h The height of the rectangle.
|
|
* @return The new rectangle on success, @ NULL otherwise.
|
|
*
|
|
* This function creates a rectangle whose top left corner has the
|
|
* coordinates (@p x, @p y), with height @p w and height @p h and adds
|
|
* it to the rectangles pool.
|
|
*
|
|
* No check is done on @p w and @p h.
|
|
*/
|
|
EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Frees the given rectangle.
|
|
*
|
|
* @param[iin] rect The rectangle to free.
|
|
*
|
|
* This function removes @p rect from the rectangles pool.
|
|
*/
|
|
EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Sets the type of given rectangle pool.
|
|
*
|
|
* @param[in,out] pool The rectangle pool for which type is to be set.
|
|
* @param[in] type Type of Eina Pool based on packing algorithm.
|
|
*
|
|
* This function sets @p type of @p pool.
|
|
* @see Eina_Rectangle_Packing
|
|
* @since 1.11
|
|
*/
|
|
EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,Eina_Rectangle_Packing type) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief calculates where rect2 is outside of rect1.
|
|
*
|
|
* @param[in] rect1 The rect to use as anchor
|
|
* @param[in] rect2 The rect to look for outside positions
|
|
*
|
|
* @return An OR'd map of Eina_Rectangle_Outside values
|
|
* @since 1.19
|
|
*/
|
|
EAPI Eina_Rectangle_Outside eina_rectangle_outside_position(Eina_Rectangle *rect1, Eina_Rectangle *rect2);
|
|
|
|
/**
|
|
* @brief Compares two rectangles for equality
|
|
*
|
|
* @param[in] rect1 First rectangle. Must not be NULL.
|
|
* @param[in] rect2 Second rectangle. Must not be NULL.
|
|
* @return EINA_TRUE if the rectangles are equal (x, y, w and h are all equal).
|
|
*
|
|
* No check is made on the rectangles, so they should be valid and non
|
|
* NULL for this function to be meaningful.
|
|
*
|
|
* @since 1.21
|
|
*/
|
|
static inline Eina_Bool eina_rectangle_equal(const Eina_Rectangle *rect1, const Eina_Rectangle *rect2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
|
|
|
#include "eina_inline_rectangle.x"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /*_EINA_RECTANGLE_H_*/
|