Graphene.Rect
Description
The location and size of a rectangle region.
The width and height of a Graphene.Rect.Graphene_Rect_T can be negative; for instance, a Graphene.Rect.Graphene_Rect_T with an origin of [ 0, 0 ] and a size of [ 10, 10 ] is equivalent to a Graphene.Rect.Graphene_Rect_T with an origin of [ 10, 10 ] and a size of [ -10, -10 ].
Application code can normalize rectangles using Graphene.Rect.Normalize; this function will ensure that the width and height of a rectangle are positive values. All functions taking a Graphene.Rect.Graphene_Rect_T as an argument will internally operate on a normalized copy; all functions returning a Graphene.Rect.Graphene_Rect_T will always return a normalized rectangle.
Contains_Point
function Contains_Point
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
return Boolean
Checks whether a Graphene.Rect.Graphene_Rect_T contains the given coordinates. Since: gtk+ 1.0
Parameters
- Self
- P
a Graphene.Point.Graphene_Point_T
Return Value
trueif the rectangle contains the point
Contains_Rect
function Contains_Rect
(Self : not null access Graphene_Rect_T;
B : not null access Graphene_Rect_T) return Boolean
Checks whether a Graphene.Rect.Graphene_Rect_T fully contains the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- B
a Graphene.Rect.Graphene_Rect_T
Return Value
trueif the rectangle A fully contains B
Equal
function Equal
(Self : not null access Graphene_Rect_T;
B : not null access Graphene_Rect_T) return Boolean
Checks whether the two given rectangle are equal. Since: gtk+ 1.0
Parameters
- Self
- B
a Graphene.Rect.Graphene_Rect_T
Return Value
trueif the rectangles are equal
Expand
procedure Expand
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T;
Res : not null access Graphene_Rect_T)
Expands a Graphene.Rect.Graphene_Rect_T to contain the given Graphene.Point.Graphene_Point_T. Since: gtk+ 1.4
Parameters
- Self
- P
a Graphene.Point.Graphene_Point_T
- Res
return location for the expanded rectangle
Free
procedure Free (Self : not null access Graphene_Rect_T)
Frees the resources allocated by graphene_rect_alloc. Since: gtk+ 1.0
Parameters
- Self
From_Object_Free
function From_Object_Free
(B : not null access Graphene_Rect_T) return Graphene_Rect_T
Return the underlying object and free the pointer. This is meant to be used internally by GtkAda, and should not in general be called by user code.
Parameters
- B
Return Value
Get_Area
function Get_Area
(Self : not null access Graphene_Rect_T) return Interfaces.C.C_float
Compute the area of given normalized rectangle. Since: gtk+ 1.10
Parameters
- Self
Return Value
the area of the normalized rectangle
Get_Bottom_Left
procedure Get_Bottom_Left
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
Retrieves the coordinates of the bottom-left corner of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- P
return location for a Graphene.Point.Graphene_Point_T
Get_Bottom_Right
procedure Get_Bottom_Right
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
Retrieves the coordinates of the bottom-right corner of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- P
return location for a Graphene.Point.Graphene_Point_T
Get_Center
procedure Get_Center
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
Retrieves the coordinates of the center of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- P
return location for a Graphene.Point.Graphene_Point_T
Get_Height
function Get_Height
(Self : not null access Graphene_Rect_T) return Interfaces.C.C_float
Retrieves the normalized height of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
Return Value
the normalized height of the rectangle
Get_Top_Left
procedure Get_Top_Left
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
Retrieves the coordinates of the top-left corner of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- P
return location for a Graphene.Point.Graphene_Point_T
Get_Top_Right
procedure Get_Top_Right
(Self : not null access Graphene_Rect_T;
P : not null access Graphene.Point.Graphene_Point_T)
Retrieves the coordinates of the top-right corner of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
- P
return location for a Graphene.Point.Graphene_Point_T
Get_Type
function Get_Type return Glib.GType
Return Value
Get_Vertices
procedure Get_Vertices
(Self : not null access Graphene_Rect_T;
Vertices : out Graphene_Vec2_Array4)
Computes the four vertices of a Graphene.Rect.Graphene_Rect_T. Since: gtk+ 1.4
Parameters
- Self
- Vertices
return location for an array of 4 Graphene.Vec2.Graphene_Vec2_T
Get_Width
function Get_Width
(Self : not null access Graphene_Rect_T) return Interfaces.C.C_float
Retrieves the normalized width of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
Return Value
the normalized width of the rectangle
Get_X
function Get_X
(Self : not null access Graphene_Rect_T) return Interfaces.C.C_float
Retrieves the normalized X coordinate of the origin of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
Return Value
the normalized X coordinate of the rectangle
Get_Y
function Get_Y
(Self : not null access Graphene_Rect_T) return Interfaces.C.C_float
Retrieves the normalized Y coordinate of the origin of the given rectangle. Since: gtk+ 1.0
Parameters
- Self
Return Value
the normalized Y coordinate of the rectangle
Graphene_Rect_T
type Graphene_Rect_T is record
Origin : Graphene.Point.Graphene_Point_T;
Size : Graphene.Size.Graphene_Size_T;
end record;
The location and size of a rectangle region.
The width and height of a Graphene.Rect.Graphene_Rect_T can be negative; for instance, a Graphene.Rect.Graphene_Rect_T with an origin of [ 0, 0 ] and a size of [ 10, 10 ] is equivalent to a Graphene.Rect.Graphene_Rect_T with an origin of [ 10, 10 ] and a size of [ -10, -10 ].
Application code can normalize rectangles using Graphene.Rect.Normalize; this function will ensure that the width and height of a rectangle are positive values. All functions taking a Graphene.Rect.Graphene_Rect_T as an argument will internally operate on a normalized copy; all functions returning a Graphene.Rect.Graphene_Rect_T will always return a normalized rectangle.
Record components
- Origin
- Size
Graphene_Vec2_Array4
type Graphene_Vec2_Array4 is array (1 .. 4) of Graphene.Vec2.Graphene_Vec2_T;
Init
function Init
(Self : not null access Graphene_Rect_T;
X : Interfaces.C.C_float;
Y : Interfaces.C.C_float;
Width : Interfaces.C.C_float;
Height : Interfaces.C.C_float) return access Graphene_Rect_T
Initializes the given Graphene.Rect.Graphene_Rect_T with the given values. This function will implicitly normalize the Graphene.Rect.Graphene_Rect_T before returning. Since: gtk+ 1.0
Parameters
- Self
- X
the X coordinate of the Graphene_Rect_T.origin
- Y
the Y coordinate of the Graphene_Rect_T.origin
- Width
the width of the Graphene_Rect_T.size
- Height
the height of the Graphene_Rect_T.size
Return Value
the initialized rectangle
Init_From_Rect
function Init_From_Rect
(Self : not null access Graphene_Rect_T;
Src : not null access Graphene_Rect_T) return access Graphene_Rect_T
Initializes R using the given Src rectangle. This function will implicitly normalize the Graphene.Rect.Graphene_Rect_T before returning. Since: gtk+ 1.0
Parameters
- Self
- Src
a Graphene.Rect.Graphene_Rect_T
Return Value
the initialized rectangle
Inset
function Inset
(Self : not null access Graphene_Rect_T;
D_X : Interfaces.C.C_float;
D_Y : Interfaces.C.C_float) return access Graphene_Rect_T
Changes the given rectangle to be smaller, or larger depending on the given inset parameters. To create an inset rectangle, use positive D_X or D_Y values; to create a larger, encompassing rectangle, use negative D_X or D_Y values. The origin of the rectangle is offset by D_X and D_Y, while the size is adjusted by (2 * D_X, 2 * D_Y). If D_X and D_Y are positive values, the size of the rectangle is decreased; if D_X and D_Y are negative values, the size of the rectangle is increased. If the size of the resulting inset rectangle has a negative width or height then the size will be set to zero. Since: gtk+ 1.0
Parameters
- Self
- D_X
the horizontal inset
- D_Y
the vertical inset
Return Value
the inset rectangle
Inset_R
procedure Inset_R
(Self : not null access Graphene_Rect_T;
D_X : Interfaces.C.C_float;
D_Y : Interfaces.C.C_float;
Res : not null access Graphene_Rect_T)
Changes the given rectangle to be smaller, or larger depending on the given inset parameters. To create an inset rectangle, use positive D_X or D_Y values; to create a larger, encompassing rectangle, use negative D_X or D_Y values. The origin of the rectangle is offset by D_X and D_Y, while the size is adjusted by (2 * D_X, 2 * D_Y). If D_X and D_Y are positive values, the size of the rectangle is decreased; if D_X and D_Y are negative values, the size of the rectangle is increased. If the size of the resulting inset rectangle has a negative width or height then the size will be set to zero. Since: gtk+ 1.4
Parameters
- Self
- D_X
the horizontal inset
- D_Y
the vertical inset
- Res
return location for the inset rectangle
Interpolate
procedure Interpolate
(Self : not null access Graphene_Rect_T;
B : not null access Graphene_Rect_T;
Factor : Gdouble;
Res : not null access Graphene_Rect_T)
Linearly interpolates the origin and size of the two given rectangles. Since: gtk+ 1.0
Parameters
- Self
- B
a Graphene.Rect.Graphene_Rect_T
- Factor
the linear interpolation factor
- Res
return location for the interpolated rectangle
Intersection
function Intersection
(Self : not null access Graphene_Rect_T;
B : not null access Graphene_Rect_T;
Res : access Graphene_Rect_T := null) return Boolean
Computes the intersection of the two given rectangles. 
The intersection in the image above is the blue outline. If the two rectangles do not intersect, Res will contain a degenerate rectangle with origin in (0, 0) and a size of 0. Since: gtk+ 1.0
Parameters
- Self
- B
a Graphene.Rect.Graphene_Rect_T
- Res
return location for a Graphene.Rect.Graphene_Rect_T
Return Value
trueif the two rectangles intersect
Normalize
function Normalize
(Self : not null access Graphene_Rect_T) return access Graphene_Rect_T
Normalizes the passed rectangle. This function ensures that the size of the rectangle is made of positive values, and that the origin is the top-left corner of the rectangle. Since: gtk+ 1.0
Parameters
- Self
Return Value
the normalized rectangle
Normalize_R
procedure Normalize_R
(Self : not null access Graphene_Rect_T;
Res : not null access Graphene_Rect_T)
Normalizes the passed rectangle. This function ensures that the size of the rectangle is made of positive values, and that the origin is in the top-left corner of the rectangle. Since: gtk+ 1.4
Parameters
- Self
- Res
the return location for the normalized rectangle
Offset
function Offset
(Self : not null access Graphene_Rect_T;
D_X : Interfaces.C.C_float;
D_Y : Interfaces.C.C_float) return access Graphene_Rect_T
Offsets the origin by D_X and D_Y. The size of the rectangle is unchanged. Since: gtk+ 1.0
Parameters
- Self
- D_X
the horizontal offset
- D_Y
the vertical offset
Return Value
the offset rectangle
Offset_R
procedure Offset_R
(Self : not null access Graphene_Rect_T;
D_X : Interfaces.C.C_float;
D_Y : Interfaces.C.C_float;
Res : not null access Graphene_Rect_T)
Offsets the origin of the given rectangle by D_X and D_Y. The size of the rectangle is left unchanged. Since: gtk+ 1.4
Parameters
- Self
- D_X
the horizontal offset
- D_Y
the vertical offset
- Res
return location for the offset rectangle
Round_Extents
procedure Round_Extents
(Self : not null access Graphene_Rect_T;
Res : not null access Graphene_Rect_T)
Rounds the origin of the given rectangle to its nearest integer value and and recompute the size so that the rectangle is large enough to contain all the conrners of the original rectangle. This function is the equivalent of calling floor on the coordinates of the origin, and recomputing the size calling ceil on the bottom-right coordinates. If you want to be sure that the rounded rectangle completely covers the area that was covered by the original rectangle â i.e. you want to cover the area including all its corners â this function will make sure that the size is recomputed taking into account the ceiling of the coordinates of the bottom-right corner. If the difference between the original coordinates and the coordinates of the rounded rectangle is greater than the difference between the original size and and the rounded size, then the move of the origin would not be compensated by a move in the anti-origin, leaving the corners of the original rectangle outside the rounded one. Since: gtk+ 1.10
Parameters
- Self
- Res
return location for the rectangle with rounded extents
Scale
procedure Scale
(Self : not null access Graphene_Rect_T;
S_H : Interfaces.C.C_float;
S_V : Interfaces.C.C_float;
Res : not null access Graphene_Rect_T)
Scales the size and origin of a rectangle horizontaly by S_H, and vertically by S_V. The result Res is normalized. Since: gtk+ 1.10
Parameters
- Self
- S_H
horizontal scale factor
- S_V
vertical scale factor
- Res
return location for the scaled rectangle
Union
procedure Union
(Self : not null access Graphene_Rect_T;
B : not null access Graphene_Rect_T;
Res : not null access Graphene_Rect_T)
Computes the union of the two given rectangles. 
The union in the image above is the blue outline. Since: gtk+ 1.0
Parameters
- Self
- B
a Graphene.Rect.Graphene_Rect_T
- Res
return location for a Graphene.Rect.Graphene_Rect_T
Zero
function Zero return access constant Graphene_Rect_T
Returns a degenerate rectangle with origin fixed at (0, 0) and a size of 0, 0. Since: gtk+ 1.4
Return Value
a fixed rectangle