gtk/gsk/gskroundedrect.h
Matthias Clasen 4c150d8eb5 The big versioning cleanup
Remove all the old 2.x and 3.x version annotations.
GTK+ 4 is a new start, and from the perspective of a
GTK+ 4 developer all these APIs have been around since
the beginning.
2018-02-06 01:16:32 -05:00

119 lines
5.4 KiB
C

/* GSK - The GTK Scene Kit
*
* Copyright 2016 Endless
*
* 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 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 __GSK_ROUNDED_RECT_H__
#define __GSK_ROUNDED_RECT_H__
#if !defined (__GSK_H_INSIDE__) && !defined (GSK_COMPILATION)
#error "Only <gsk/gsk.h> can be included directly."
#endif
#include <gsk/gsktypes.h>
G_BEGIN_DECLS
/**
* GSK_ROUNDED_RECT_INIT:
* @_x: the X coordinate of the origin
* @_y: the Y coordinate of the origin
* @_w: the width
* @_h: the height
*
* Initializes a #GskRoundedRect when declaring it.
* All corner sizes will be initialized to 0.
*
* Since: 3.90
*/
#define GSK_ROUNDED_RECT_INIT(_x,_y,_w,_h) (GskRoundedRect) { .bounds = GRAPHENE_RECT_INIT(_x,_y,_w,_h), \
.corner = { \
GRAPHENE_SIZE_INIT(0, 0),\
GRAPHENE_SIZE_INIT(0, 0),\
GRAPHENE_SIZE_INIT(0, 0),\
GRAPHENE_SIZE_INIT(0, 0),\
}}
/**
* GskRoundedRect:
* @bounds: the bounds of the rectangle
* @corner: the size of the 4 rounded corners
*
* A rectanglular region with rounded corners.
*
* Application code should normalize rectangles using gsk_rounded_rect_normalize();
* this function will ensure that the bounds of the rectanlge are normalized
* and ensure that the corner values are positive and the corners do not overlap.
* All functions taking a #GskRoundedRect as an argument will internally operate on
* a normalized copy; all functions returning a #GskRoundedRect will always return
* a normalized one.
*
* Since: 3.90
*/
typedef struct _GskRoundedRect GskRoundedRect;
struct _GskRoundedRect
{
graphene_rect_t bounds;
graphene_size_t corner[4];
};
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_init (GskRoundedRect *self,
const graphene_rect_t *bounds,
const graphene_size_t *top_left,
const graphene_size_t *top_right,
const graphene_size_t *bottom_right,
const graphene_size_t *bottom_left);
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_init_copy (GskRoundedRect *self,
const GskRoundedRect *src);
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_init_from_rect (GskRoundedRect *self,
const graphene_rect_t *bounds,
float radius);
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_normalize (GskRoundedRect *self);
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_offset (GskRoundedRect *self,
float dx,
float dy);
GDK_AVAILABLE_IN_ALL
GskRoundedRect * gsk_rounded_rect_shrink (GskRoundedRect *self,
float top,
float right,
float bottom,
float left);
GDK_AVAILABLE_IN_ALL
gboolean gsk_rounded_rect_is_rectilinear (const GskRoundedRect *self);
GDK_AVAILABLE_IN_ALL
gboolean gsk_rounded_rect_contains_point (const GskRoundedRect *self,
const graphene_point_t *point);
GDK_AVAILABLE_IN_ALL
gboolean gsk_rounded_rect_contains_rect (const GskRoundedRect *self,
const graphene_rect_t *rect);
GDK_AVAILABLE_IN_ALL
gboolean gsk_rounded_rect_intersects_rect (const GskRoundedRect *self,
const graphene_rect_t *rect);
G_END_DECLS
#endif /* __GSK_ROUNDED_RECT_H__ */