Added in API level 37

Summary: Methods | Inherited Methods

BlurRegion

---

Kotlin |Java

public abstract class BlurRegion
extends Object

java.lang.Object
↳	android.view.BlurRegion

Known direct subclasses RoundedRectBlurRegion RoundedRectBlurRegion Defines a rounded rectangular blur region on the SurfaceView.

---

The abstract base class defining a region on the SurfaceView that should have a blur applied.

Summary

Public methods
abstract BlurRegion	copy() Returns a deep copy of this blur region.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
float	getAlpha() Returns the alpha for this region.
float	getBlurRadius() Returns the blur radius for this region.
int	hashCode() Returns a hash code value for the object.
void	setAlpha(float alpha) Sets the alpha for this region.
void	setBlurRadius(float blurRadius) Sets the blur radius for this region.

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.

Public methods

copy

Added in API level 37

public abstract BlurRegion copy ()

Returns a deep copy of this blur region.

Returns
BlurRegion	deep copy of this blur region. This value cannot be null.

equals

Added in API level 37

public boolean equals (Object o)

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
o	Object: the reference object with which to compare.

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

getAlpha

Added in API level 37

public float getAlpha ()

Returns the alpha for this region.

Returns
float	alpha value of the region

getBlurRadius

Added in API level 37

public float getBlurRadius ()

Returns the blur radius for this region.

Returns
float	blur radius in pixels

hashCode

Added in API level 37

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

setAlpha

Added in API level 37

public void setAlpha (float alpha)

Sets the alpha for this region.

The default value for alpha is 1.0f.

Parameters
alpha	float: alpha value of the region [0.0 - 1.0]. Value is between 0.0f and 1.0f inclusive

setBlurRadius

Added in API level 37

public void setBlurRadius (float blurRadius)

Sets the blur radius for this region.

The default value for blur radius is 0.0f.

Parameters
blurRadius	float: blur radius in pixels