Gsk-4.0 ▶ Gsk ▶ RoundedRect

constructor

• new RoundedRect(
      properties?: Partial<{ bounds: Graphene.Rect; corner: Size[] }>,
  ): RoundedRect

  Parameters

  • Optionalproperties: Partial<{ bounds: Graphene.Rect; corner: Size[] }>

  Returns RoundedRect

bounds

corner

Static$gtype

contains_point

• contains_point(point: Graphene.Point): boolean

  Checks if the given point is inside the rounded rectangle.

  Parameters

  • point: Graphene.Point

    the point to check

  Returns boolean

  true if the point is inside the rounded rectangle

contains_rect

• contains_rect(rect: Graphene.Rect): boolean

  Checks if the given rectangle is contained inside the rounded rectangle.

  Parameters

  • rect: Graphene.Rect

    the rectangle to check

  Returns boolean

  true if the rect is fully contained inside the rounded rectangle

init

• init(
      bounds: Graphene.Rect,
      top_left: Size,
      top_right: Size,
      bottom_right: Size,
      bottom_left: Size,
  ): RoundedRect

  Initializes a rounded rectangle with the given values.

  This function will implicitly normalize the rounded rectangle before returning.

  Parameters

  • bounds: Graphene.Rect

    a graphene_rect_t describing the bounds

  • top_left: Size

    the rounding radius of the top left corner

  • top_right: Size

    the rounding radius of the top right corner

  • bottom_right: Size

    the rounding radius of the bottom right corner

  • bottom_left: Size

    the rounding radius of the bottom left corner

  Returns RoundedRect

  the initialized rounded rectangle

init_copy

• init_copy(src: RoundedRect): RoundedRect

  Initializes a rounded rectangle with a copy.

  This function will not normalize the rounded rectangle, so make sure the source is normalized.

  Parameters

  • src: RoundedRect

    another rounded rectangle

  Returns RoundedRect

  the initialized rounded rectangle

init_from_rect

• init_from_rect(bounds: Graphene.Rect, radius: number): RoundedRect

  Initializes a rounded rectangle to the given bounds and sets the radius of all four corners equally.

  Parameters

  • bounds: Graphene.Rect

    a graphene_rect_t

  • radius: number

    the border radius

  Returns RoundedRect

  the initialized rounded rectangle

intersects_rect

• intersects_rect(rect: Graphene.Rect): boolean

  Checks if part a rectangle is contained inside the rounded rectangle.

  Parameters

  • rect: Graphene.Rect

    the rectangle to check

  Returns boolean

  true if the rect intersects with the rounded rectangle

is_rectilinear

• is_rectilinear(): boolean

  Checks if all corners of a rounded rectangle are right angles and the rectangle covers all of its bounds.

  This information can be used to decide if Gsk.ClipNode.new or Gsk.RoundedClipNode.new should be called.

  Returns boolean

  true if the rounded rectangle is rectilinear

normalize

• normalize(): RoundedRect

  Normalizes a rounded rectangle.

  This function will ensure that the bounds of the rounded rectangle are normalized and ensure that the corner values are positive and the corners do not overlap.

  Returns RoundedRect

  the normalized rounded rectangle

offset

• offset(dx: number, dy: number): RoundedRect

  Offsets the rounded rectangle's origin by dx and dy.

  The size and corners of the rounded rectangle are unchanged.

  Parameters

  • dx: number

    the horizontal offset

  • dy: number

    the vertical offset

  Returns RoundedRect

  the offset rounded rectangle

shrink

• shrink(top: number, right: number, bottom: number, left: number): RoundedRect

  Shrinks (or grows) a rounded rectangle by moving the 4 sides according to the offsets given.

  The corner radii will be changed in a way that tries to keep the center of the corner circle intact. This emulates CSS behavior.

  This function also works for growing rounded rectangles if you pass negative values for the top, right, bottom or left.

  Parameters

  • top: number

    how far to move the top side downwards

  • right: number

    how far to move the right side to the left

  • bottom: number

    how far to move the bottom side upwards

  • left: number

    how far to move the left side to the right

  Returns RoundedRect

  the resized rounded rectangle