Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class Region

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.Region

public class Region
extends Proxy

A Region represents a set of integer-aligned rectangles.

Regions are a simple graphical data type representing an area of integer-aligned rectangles. They are often used on raster surfaces to track areas of interest, such as change or clip areas.

It allows set-theoretical operations like union(org.freedesktop.cairo.Region) and intersect(org.freedesktop.cairo.Region) to be performed on them.

Since:

1.10

Constructor Summary

Constructors

Constructor	Description
Region(MemorySegment address)	Constructor used internally to instantiate a java Region object for a native cairo_region_t instance

Method Summary

Modifier and Type	Method	Description
boolean	containsPoint(int x, int y)	Checks whether (x, y) is contained in this region.
RegionOverlap	containsRectangle(RectangleInt rectangle)	Checks whether rectangle is inside, outside or partially contained in this region
Region	copy()	Allocates a new region object copying the area from this region.
static Region	create()	Allocates a new empty region object.
static Region	create(RectangleInt rectangle)	Allocates a new region object containing rectangle.
static Region	create(RectangleInt[] rects)	Allocates a new region object containing the union of all given rects.
void	destroy()	Invokes the cleanup action that is normally invoked during garbage collection.
boolean	equal(Region other)	Compares whether this region is equivalent to other.
void	getExtents(RectangleInt extents)	Gets the bounding rectangle of region as a RectangleInt
void	getRectangle(int nth, RectangleInt rectangle)	Returns the nth rectangle from this region.
static org.gnome.glib.Type	getType()	Get the CairoRegion GType
void	intersect(RectangleInt rectangle)	Computes the intersection of this region with rectangle and places the result in this region
void	intersect(Region other)	Computes the intersection of this region with other and places the result in this region
boolean	isEmpty()	Checks whether this region is empty.
int	numRectangles()	Returns the number of rectangles contained in this region.
Status	status()	Checks whether an error has previous occurred for this region object.
void	subtract(RectangleInt rectangle)	Subtracts rectangle from this region and places the result in this region
void	subtract(Region other)	Subtracts other from this region and places the result in this region
void	translate(int dx, int dy)	Translates this region by (dx, dy).
void	union(RectangleInt rectangle)	Computes the union of this region with rectangle and places the result in this region
void	union(Region other)	Computes the union of this region with other and places the result in this region
void	xor(RectangleInt rectangle)	Computes the exclusive difference of this region with rectangle and places the result in this region.
void	xor(Region other)	Computes the exclusive difference of this region with other and places the result in this region.

Methods inherited from class io.github.jwharm.cairobindings.Proxy

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Region

public Region(MemorySegment address)

Constructor used internally to instantiate a java Region object for a native cairo_region_t instance

Parameters:

address - the memory address of the native cairo_region_t instance

Method Details

destroy

public void destroy()

Invokes the cleanup action that is normally invoked during garbage collection. If the instance is "owned" by the user, the destroy() function is run to dispose the native instance.

create

public static Region create()

Allocates a new empty region object.

Returns:

A newly allocated Region

Since:

1.10

create

public static Region create(RectangleInt rectangle)

Allocates a new region object containing rectangle.

Parameters:

rectangle - a RectangleInt

Returns:

A newly allocated Region

Since:

1.10

create

public static Region create(RectangleInt[] rects)

Allocates a new region object containing the union of all given rects.

Parameters:

rects - an array of rectangles

Returns:

A newly allocated Region

Since:

1.10

copy

public Region copy()

Allocates a new region object copying the area from this region.

Returns:

A newly allocated Region

Since:

1.10

status

public Status status()

Checks whether an error has previous occurred for this region object.

Returns:

Status.SUCCESS or Status.NO_MEMORY

Since:

1.10

getExtents

public void getExtents(RectangleInt extents)

Gets the bounding rectangle of region as a RectangleInt

Parameters:

extents - rectangle into which to store the extents

Since:

1.10

numRectangles

public int numRectangles()

Returns the number of rectangles contained in this region.

Returns:

The number of rectangles contained in this region.

Since:

1.10

getRectangle

public void getRectangle(int nth,
 RectangleInt rectangle)

Returns the nth rectangle from this region.

Parameters:

nth - a number indicating which rectangle should be returned

rectangle - a RectangleInt

Since:

1.10

isEmpty

public boolean isEmpty()

Checks whether this region is empty.

Returns:

true if region is empty, false if it isn't.

Since:

1.10

containsPoint

public boolean containsPoint(int x,
 int y)

Checks whether (x, y) is contained in this region.

Parameters:

x - the x coordinate of a point

y - the y coordinate of a point

Returns:

true if (x, y) is contained in this region, false if it is not.

Since:

1.10

containsRectangle

public RegionOverlap containsRectangle(RectangleInt rectangle)

Checks whether rectangle is inside, outside or partially contained in this region

Parameters:

rectangle - a RectangleInt

Returns:

RegionOverlap.IN if rectangle is entirely inside this region, RegionOverlap.OUT if rectangle is entirely outside this region, or RegionOverlap.PART if rectangle is partially inside and partially outside this region.

Since:

1.10

equal

public boolean equal(Region other)

Compares whether this region is equivalent to other. null as an argument is equal to itself, but not to any non-null region.

Parameters:

other - a Region or null

Returns:

true if both regions contained the same coverage, false if it is not or any region is in an error status.

Since:

1.10

translate

public void translate(int dx,
 int dy)

Translates this region by (dx, dy).

Parameters:

dx - Amount to translate in the x direction

dy - Amount to translate in the y direction

Since:

1.10

intersect

public void intersect(Region other)

Computes the intersection of this region with other and places the result in this region

Parameters:

other - another Region

Since:

1.10

intersect

public void intersect(RectangleInt rectangle)

Computes the intersection of this region with rectangle and places the result in this region

Parameters:

rectangle - a Rectangle

Since:

1.10

subtract

public void subtract(Region other)

Subtracts other from this region and places the result in this region

Parameters:

other - another Region

Since:

1.10

subtract

public void subtract(RectangleInt rectangle)

Subtracts rectangle from this region and places the result in this region

Parameters:

rectangle - a Rectangle

Since:

1.10

union

public void union(Region other)

Computes the union of this region with other and places the result in this region

Parameters:

other - another Region

Since:

1.10

union

public void union(RectangleInt rectangle)

Computes the union of this region with rectangle and places the result in this region

Parameters:

rectangle - a Rectangle

Since:

1.10

xor

public void xor(Region other)

Computes the exclusive difference of this region with other and places the result in this region. That is, this region will be set to contain all areas that are either in this region or in other, but not in both.

Parameters:

other - another Region

Since:

1.10

xor

public void xor(RectangleInt rectangle)

Computes the exclusive difference of this region with rectangle and places the result in this region. That is, this region will be set to contain all areas that are either in this region or in rectangle, but not in both.

Parameters:

rectangle - a Rectangle

Since:

1.10

getType

public static org.gnome.glib.Type getType()

Get the CairoRegion GType

Returns:

the GType