Added in API level 1

Region

Kotlin |Java

public class Region
extends Object implements Parcelable

java.lang.Object
↳	android.graphics.Region

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<Region>`	`CREATOR`

Public constructors
`Region()` Create an empty region
`Region(Rect r)` Return a region set to the specified rectangle
`Region(Region region)` Return a copy of the specified region
`Region(int left, int top, int right, int bottom)` Return a region set to the specified rectangle

Public methods
`boolean`	`contains(int x, int y)` Return true if the region contains the specified point
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`boolean`	`getBoundaryPath(Path path)` Set the path to the boundary of the region.
`Path`	`getBoundaryPath()` Return the boundary of the region as a new Path.
`Rect`	`getBounds()` Return a new Rect set to the bounds of the region.
`boolean`	`getBounds(Rect r)` Set the Rect to the bounds of the region.
`boolean`	`isComplex()` Return true if the region contains more than one rectangle
`boolean`	`isEmpty()` Return true if this region is empty
`boolean`	`isRect()` Return true if the region contains a single rectangle
`boolean`	`op(Region region1, Region region2, Region.Op op)` Set this region to the result of performing the Op on the specified regions.
`boolean`	`op(Rect r, Region.Op op)` Perform the specified Op on this region and the specified rect.
`boolean`	`op(Rect rect, Region region, Region.Op op)` Set this region to the result of performing the Op on the specified rect and region.
`boolean`	`op(Region region, Region.Op op)` Perform the specified Op on this region and the specified region.
`boolean`	`op(int left, int top, int right, int bottom, Region.Op op)` Perform the specified Op on this region and the specified rect.
`boolean`	`quickContains(Rect r)` Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
`boolean`	`quickContains(int left, int top, int right, int bottom)` Return true if the region is a single rectangle (not complex) and it contains the specified rectangle.
`boolean`	`quickReject(Region rgn)` Return true if the region is empty, or if the specified region does not intersect the region.
`boolean`	`quickReject(Rect r)` Return true if the region is empty, or if the specified rectangle does not intersect the region.
`boolean`	`quickReject(int left, int top, int right, int bottom)` Return true if the region is empty, or if the specified rectangle does not intersect the region.
`boolean`	`set(int left, int top, int right, int bottom)` Set the region to the specified rectangle
`boolean`	`set(Region region)` Set the region to the specified region.
`boolean`	`set(Rect r)` Set the region to the specified rectangle
`void`	`setEmpty()` Set the region to the empty region
`boolean`	`setPath(Path path, Region clip)` Set the region to the area described by the path and clip.
`String`	`toString()` Returns a string representation of the object.
`void`	`translate(int dx, int dy, Region dst)` Set the dst region to the result of translating this region by [dx, dy].
`void`	`translate(int dx, int dy)` Translate the region by [dx, dy].
`final boolean`	`union(Rect r)`
`void`	`writeToParcel(Parcel p, int flags)` Write the region and its pixels to the parcel.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 1

public static final Creator<Region> CREATOR

Public constructors

Region

Added in API level 1

public Region ()

Create an empty region

Region

Added in API level 1

public Region (Rect r)

Return a region set to the specified rectangle

Parameters
`r`	`Rect`: This value cannot be `null`.

Region

Added in API level 1

public Region (Region region)

Return a copy of the specified region

Parameters
`region`	`Region`: This value cannot be `null`.

Region

Added in API level 1

public Region (int left, 
                int top, 
                int right, 
                int bottom)

Return a region set to the specified rectangle

Parameters
`left`	`int`
`top`	`int`
`right`	`int`
`bottom`	`int`

Public methods

contains

Added in API level 1

public boolean contains (int x, 
                int y)

Return true if the region contains the specified point

Parameters
`x`	`int`
`y`	`int`

Returns
`boolean`

describeContents

Added in API level 1

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 1

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getBoundaryPath

Added in API level 1

public boolean getBoundaryPath (Path path)

Set the path to the boundary of the region. If the region is empty, the path will also be empty.

Parameters
`path`	`Path`: This value cannot be `null`.

Returns
`boolean`

getBoundaryPath

Added in API level 1

public Path getBoundaryPath ()

Return the boundary of the region as a new Path. If the region is empty, the path will also be empty.

Returns
`Path`	This value cannot be `null`.

getBounds

Added in API level 1

public Rect getBounds ()

Return a new Rect set to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

Returns
`Rect`	This value cannot be `null`.

getBounds

Added in API level 1

public boolean getBounds (Rect r)

Set the Rect to the bounds of the region. If the region is empty, the Rect will be set to [0, 0, 0, 0]

Parameters
`r`	`Rect`: This value cannot be `null`.

Returns
`boolean`

isComplex

Added in API level 1

public boolean isComplex ()

Return true if the region contains more than one rectangle

Returns
`boolean`

isEmpty

Added in API level 1

public boolean isEmpty ()

Return true if this region is empty

Returns
`boolean`

isRect

Added in API level 1

public boolean isRect ()

Return true if the region contains a single rectangle

Returns
`boolean`

op

Added in API level 1

public boolean op (Region region1, 
                Region region2, 
                Region.Op op)

Set this region to the result of performing the Op on the specified regions. Return true if the result is not empty.

Parameters
`region1`	`Region`: This value cannot be `null`.
`region2`	`Region`: This value cannot be `null`.
`op`	`Region.Op`: This value cannot be `null`.

Returns
`boolean`

op

Added in API level 1

public boolean op (Rect r, 
                Region.Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

Parameters
`r`	`Rect`: This value cannot be `null`.
`op`	`Region.Op`: This value cannot be `null`.

Returns
`boolean`

op

Added in API level 1

public boolean op (Rect rect, 
                Region region, 
                Region.Op op)

Set this region to the result of performing the Op on the specified rect and region. Return true if the result is not empty.

Parameters
`rect`	`Rect`: This value cannot be `null`.
`region`	`Region`: This value cannot be `null`.
`op`	`Region.Op`: This value cannot be `null`.

Returns
`boolean`

op

Added in API level 1

public boolean op (Region region, 
                Region.Op op)

Perform the specified Op on this region and the specified region. Return true if the result of the op is not empty.

Parameters
`region`	`Region`: This value cannot be `null`.
`op`	`Region.Op`: This value cannot be `null`.

Returns
`boolean`

op

Added in API level 1

public boolean op (int left, 
                int top, 
                int right, 
                int bottom, 
                Region.Op op)

Perform the specified Op on this region and the specified rect. Return true if the result of the op is not empty.

Parameters
`left`	`int`
`top`	`int`
`right`	`int`
`bottom`	`int`
`op`	`Region.Op`: This value cannot be `null`.

Returns
`boolean`

quickContains

Added in API level 1

public boolean quickContains (Rect r)

Return true if the region is a single rectangle (not complex) and it contains the specified rectangle. Returning false is not a guarantee that the rectangle is not contained by this region, but return true is a guarantee that the rectangle is contained by this region.

Parameters
`r`	`Rect`: This value cannot be `null`.

Returns
`boolean`

quickContains

Added in API level 1

public boolean quickContains (int left, 
                int top, 
                int right, 
                int bottom)

Parameters
`left`	`int`
`top`	`int`
`right`	`int`
`bottom`	`int`

Returns
`boolean`

quickReject

Added in API level 1

public boolean quickReject (Region rgn)

Return true if the region is empty, or if the specified region does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

Parameters
`rgn`	`Region`

Returns
`boolean`

quickReject

Added in API level 1

public boolean quickReject (Rect r)

Return true if the region is empty, or if the specified rectangle does not intersect the region. Returning false is not a guarantee that they intersect, but returning true is a guarantee that they do not.

Parameters
`r`	`Rect`: This value cannot be `null`.

Returns
`boolean`

quickReject

Added in API level 1

public boolean quickReject (int left, 
                int top, 
                int right, 
                int bottom)

Parameters
`left`	`int`
`top`	`int`
`right`	`int`
`bottom`	`int`

Returns
`boolean`

set

Added in API level 1

public boolean set (int left, 
                int top, 
                int right, 
                int bottom)

Set the region to the specified rectangle

Parameters
`left`	`int`
`top`	`int`
`right`	`int`
`bottom`	`int`

Returns
`boolean`

set

Added in API level 1

public boolean set (Region region)

Set the region to the specified region.

Parameters
`region`	`Region`: This value cannot be `null`.

Returns
`boolean`

set

Added in API level 1

public boolean set (Rect r)

Set the region to the specified rectangle

Parameters
`r`	`Rect`: This value cannot be `null`.

Returns
`boolean`

setEmpty

Added in API level 1

public void setEmpty ()

Set the region to the empty region

setPath

Added in API level 1

public boolean setPath (Path path, 
                Region clip)

Set the region to the area described by the path and clip. Return true if the resulting region is non-empty. This produces a region that is identical to the pixels that would be drawn by the path (with no antialiasing).

Parameters
`path`	`Path`: This value cannot be `null`.
`clip`	`Region`: This value cannot be `null`.

Returns
`boolean`

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

translate

Added in API level 1

public void translate (int dx, 
                int dy, 
                Region dst)

Set the dst region to the result of translating this region by [dx, dy]. If this region is empty, then dst will be set to empty.

Parameters
`dx`	`int`
`dy`	`int`
`dst`	`Region`

translate

Added in API level 1

public void translate (int dx, 
                int dy)

Translate the region by [dx, dy]. If the region is empty, do nothing.

Parameters
`dx`	`int`
`dy`	`int`

union

Added in API level 1

public final boolean union (Rect r)

Parameters
`r`	`Rect`: This value cannot be `null`.

Returns
`boolean`

writeToParcel

Added in API level 1

public void writeToParcel (Parcel p, 
                int flags)

Write the region and its pixels to the parcel. The region can be rebuilt from the parcel by calling CREATOR.createFromParcel().

Parameters
`p`	`Parcel`: Parcel object to write the region data into
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Protected methods

finalize

Added in API level 1

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
`Throwable`