Class Rectangle

All Implemented Interfaces:
PointerInterface

public class Rectangle extends Record
A `GdkRectangle` data type for representing rectangles.

`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
[method@Gdk.Rectangle.intersect]; to find the union of two rectangles use
[method@Gdk.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.

https://docs.gtk.org/gdk4/struct.Rectangle.html

  • Field Details

  • Constructor Details

    • Rectangle

      public Rectangle(PointerContainer pointer)
    • Rectangle

      public Rectangle()
  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()
    • setFieldX

      public void setFieldX(int x)
      the x coordinate of the top left corner
    • getFieldX

      public int getFieldX()
      the x coordinate of the top left corner
    • setFieldY

      public void setFieldY(int y)
      the y coordinate of the top left corner
    • getFieldY

      public int getFieldY()
      the y coordinate of the top left corner
    • setFieldWidth

      public void setFieldWidth(int width)
      the width of the rectangle
    • getFieldWidth

      public int getFieldWidth()
      the width of the rectangle
    • setFieldHeight

      public void setFieldHeight(int height)
      the height of the rectangle
    • getFieldHeight

      public int getFieldHeight()
      the height of the rectangle
    • containsPoint

      public boolean containsPoint(int x, int y)
      Returns %TRUE if @rect contains the point described by @x and @y.
      Parameters:
      x - X coordinate
      y - Y coordinate
      Returns:
      %TRUE if @rect contains the point
    • equal

      public boolean equal(@Nonnull Rectangle rect2)
      Checks if the two given rectangles are equal.
      Parameters:
      rect2 - a `GdkRectangle`
      Returns:
      %TRUE if the rectangles are equal.
    • intersect

      public boolean intersect(@Nonnull Rectangle src2, @Nullable Rectangle dest)
      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 %NULL for @dest.
      Parameters:
      src2 - a `GdkRectangle`
      dest - return location for the intersection of @src1 and @src2
      Returns:
      %TRUE if the rectangles intersect.
    • union

      public void union(@Nonnull Rectangle src2, @Nonnull Rectangle dest)
      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`
      dest - return location for the union of @src1 and @src2
    • getTypeID

      public static long getTypeID()
    • getParentTypeID

      public static long getParentTypeID()
    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()
    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()
    • getInstanceSize

      public static int getInstanceSize()