BlurRegion
abstract class BlurRegion
| kotlin.Any | |
| ↳ | android.view.BlurRegion |
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. |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Float |
getAlpha()Returns the alpha for this region. |
| open Float |
Returns the blur radius for this region. |
| open Int |
hashCode()Returns a hash code value for the object. |
| open Unit |
Sets the alpha for this region. |
| open Unit |
setBlurRadius(blurRadius: Float)Sets the blur radius for this region. |
Public methods
copy
abstract fun copy(): BlurRegion
Returns a deep copy of this blur region.
| Return | |
|---|---|
BlurRegion |
deep copy of this blur region. This value cannot be null. |
equals
open fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAlpha
open fun getAlpha(): Float
Returns the alpha for this region.
| Return | |
|---|---|
Float |
alpha value of the region |
getBlurRadius
open fun getBlurRadius(): Float
Returns the blur radius for this region.
| Return | |
|---|---|
Float |
blur radius in pixels |
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
setAlpha
open fun setAlpha(alpha: Float): Unit
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
open fun setBlurRadius(blurRadius: Float): Unit
Sets the blur radius for this region.
The default value for blur radius is 0.0f.
| Parameters | |
|---|---|
blurRadius |
Float: blur radius in pixels |