Skip to content

Gdk.Rectangle

record (struct)

Represents a rectangle.

GdkRectangle is identical to cairo_rectangle_t. Together with Cairo’s cairo_region_t data type, these are the central types for representing sets of pixels.

The intersection of two rectangles can be computed with Rectangle.intersect; to find the union of two rectangles use Rectangle.union.

The cairo_region_t type provided by Cairo is usually used for managing non-rectangular clipping of graphical operations.

The Graphene library has a number of other data types for regions and volumes in 2D and 3D.

Methods

contains_point

def contains_point(self, x: int, y: int) -> bool

Returns True if rect contains the point described by x and y.

Parameters:

  • x — X coordinate
  • y — Y coordinate

equal

def equal(self, rect2: Rectangle) -> bool

Checks if the two given rectangles are equal.

Parameters:

  • rect2 — a GdkRectangle

intersect

def intersect(self, src2: Rectangle) -> tuple[bool, Rectangle]

Calculates the intersection of two rectangles.

It is allowed for dest to be the same as either src1 or src2. If the rectangles do not intersect, dest’s width and height is set to 0 and its x and y values are undefined. If you are only interested in whether the rectangles intersect, but not in the intersecting area itself, pass None for dest.

Parameters:

  • src2 — a GdkRectangle

union

def union(self, src2: Rectangle) -> Rectangle

Calculates the union of two rectangles.

The union of rectangles src1 and src2 is the smallest rectangle which includes both src1 and src2 within it. It is allowed for dest to be the same as either src1 or src2.

Note that this function does not ignore 'empty' rectangles (ie. with zero width or height).

Parameters:

  • src2 — a GdkRectangle

Properties

x

x: int  # read/write

y

y: int  # read/write

width

width: int  # read/write

height

height: int  # read/write