RippleDrawable

Kotlin |Java

open class RippleDrawable : LayerDrawable

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.LayerDrawable
		↳	android.graphics.drawable.RippleDrawable

Drawable that shows a ripple effect in response to state changes. The anchoring position of the ripple for a given state may be specified by calling #setHotspot(float,float) with the corresponding state attribute identifier.

A touch feedback drawable may contain multiple child layers, including a special mask layer that is not drawn to the screen. A single layer may be set as the mask from XML by specifying its android:id value as android.R.id#mask. At run time, a single layer may be set as the mask using setId(..., android.R.id.mask) or an existing mask layer may be replaced using setDrawableByLayerId(android.R.id.mask, ...).

<code>&lt;!-- A red ripple masked against an opaque rectangle. --&gt;
  &lt;ripple android:color="#ffff0000"&gt;
    &lt;item android:id="@android:id/mask"
          android:drawable="@android:color/white" /&gt;
  &lt;/ripple&gt;</code>

If a mask layer is set, the ripple effect will be masked against that layer before it is drawn over the composite of the remaining child layers.

If no mask layer is set, the ripple effect is masked against the composite of the child layers.

<code>&lt;!-- A green ripple drawn atop a black rectangle. --&gt;
  &lt;ripple android:color="#ff00ff00"&gt;
    &lt;item android:drawable="@android:color/black" /&gt;
  &lt;/ripple&gt;
 
  &lt;!-- A blue ripple drawn atop a drawable resource. --&gt;
  &lt;ripple android:color="#ff0000ff"&gt;
    &lt;item android:drawable="@drawable/my_drawable" /&gt;
  &lt;/ripple&gt;</code>

If no child layers or mask is specified and the ripple is set as a View background, the ripple will be drawn atop the first available parent background within the View's hierarchy. In this case, the drawing region may extend outside of the Drawable bounds.

<code>&lt;!-- An unbounded red ripple. --&gt;
  &lt;ripple android:color="#ffff0000" /&gt;</code>

Summary

XML attributes
`android:color`	The color to use for ripple effects.

Inherited XML attributes

From class LayerDrawable

android:bottom

Bottom inset to apply to the layer.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:drawable

Drawable used to render the layer.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:end

End inset to apply to the layer. Overrides left or right depending on layout direction.

android:gravity

Gravity used to align the layer within its container. If no value is specified, the default behavior depends on whether an explicit width or height has been set, If no dimension is set, gravity in that direction defaults to fill_horizontal or fill_vertical; otherwise, it defaults to left or top.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
bottom	50	Push object to the bottom of its container, not changing its size.
center	11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal	1	Place object in the horizontal center of its container, not changing its size.
center_vertical	10	Place object in the vertical center of its container, not changing its size.
clip_horizontal	8	Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
clip_vertical	80	Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
end	800005	Push object to the end of its container, not changing its size.
fill	77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal	7	Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical	70	Grow the vertical size of the object if needed so it completely fills its container.
left	3	Push object to the left of its container, not changing its size.
right	5	Push object to the right of its container, not changing its size.
start	800003	Push object to the beginning of its container, not changing its size.
top	30	Push object to the top of its container, not changing its size.

android:height

Height of the layer. Defaults to the layer's intrinsic height.

android:id

Identifier of the layer. This can be used to retrieve the layer from a drawable container.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:left

Left inset to apply to the layer.

android:paddingMode

Indicates how layer padding should affect the bounds of subsequent layers. The default padding mode value is nest.

Must be one of the following constant values.

Constant	Value	Description
nest	0	Nest each layer inside the padding of the previous layer.
stack	1	Stack each layer directly atop the previous layer.

android:right

Right inset to apply to the layer.

android:start

Start inset to apply to the layer. Overrides left or right depending on layout direction.

android:top

Top inset to apply to the layer.

android:width

Width of the layer. Defaults to the layer's intrinsic width.

Constants
static Int	`RADIUS_AUTO` Radius value that specifies the ripple radius should be computed based on the size of the ripple's container.

Inherited constants

From class LayerDrawable

Int

INSET_UNDEFINED

Value used for undefined start and end insets.

Int

PADDING_MODE_NEST

Padding mode used to nest each layer inside the padding of the previous layer.

Int

PADDING_MODE_STACK

Padding mode used to stack each layer directly atop the previous layer.

Public constructors
`RippleDrawable(color: ColorStateList, content: Drawable?, mask: Drawable?)` Creates a new ripple drawable with the specified ripple color and optional content and mask drawables.

Public methods
open Unit	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Boolean	`canApplyTheme()`
open Unit	`draw(canvas: Canvas)` Optimized for drawing ripples with a mask layer and optional content.
open Drawable.ConstantState?	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
open Rect	`getDirtyBounds()` Return the drawable's dirty bounds Rect.
open ColorStateList	`getEffectColor()`
open Unit	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Unit	`getOutline(outline: Outline)` Populates `outline` with the first available layer outline, excluding the mask layer.
open Int	`getRadius()`
open Boolean	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`.
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.
open Unit	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn.
open Boolean	`isProjected()`
open Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Unit	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
open Drawable	`mutate()` Make this drawable mutable.
open Unit	`setColor(color: ColorStateList)` Sets the ripple color.
open Boolean	`setDrawableByLayerId(id: Int, drawable: Drawable!)` Replaces the `Drawable` for the layer with the given id.
open Unit	`setEffectColor(color: ColorStateList)` Sets the ripple effect color.
open Unit	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
open Unit	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
open Unit	`setPaddingMode(mode: Int)` Specifies how layer padding should affect the bounds of subsequent layers.
open Unit	`setRadius(radius: Int)` Sets the radius in pixels of the fully expanded ripple.
open Boolean	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible.

Protected methods
open Unit	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.
open Boolean	`onStateChange(stateSet: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.

Inherited functions

From class LayerDrawable

`Int`	`addLayer(dr: Drawable!)` Adds a new layer containing the specified `drawable` to the end of the layer list and returns its index.
`Drawable!`	`findDrawableByLayerId(id: Int)` Looks for a layer with the given ID and returns its `Drawable`. If multiple layers are found for the given ID, returns the `Drawable` for the matching layer at the highest index.
`Int`	`findIndexByLayerId(id: Int)` Returns the layer with the specified `id`. If multiple layers have the same ID, returns the layer with the lowest index.
`Int`	`getAlpha()` Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.
`Int`	`getBottomPadding()` Returns the bottom padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Int`	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through `setChangingConfigurations(int)` or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
`Drawable!`	`getDrawable(index: Int)` Returns the drawable for the layer at the specified index.
`Int`	`getEndPadding()` Returns the end padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Int`	`getId(index: Int)` Returns the ID of the specified layer.
`Int`	`getIntrinsicHeight()` Returns the drawable's intrinsic height. Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.
`Int`	`getIntrinsicWidth()` Returns the drawable's intrinsic width. Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.
`Int`	`getLayerGravity(index: Int)`
`Int`	`getLayerHeight(index: Int)`
`Int`	`getLayerInsetBottom(index: Int)`
`Int`	`getLayerInsetEnd(index: Int)`
`Int`	`getLayerInsetLeft(index: Int)`
`Int`	`getLayerInsetRight(index: Int)`
`Int`	`getLayerInsetStart(index: Int)`
`Int`	`getLayerInsetTop(index: Int)`
`Int`	`getLayerWidth(index: Int)`
`Int`	`getLeftPadding()` Returns the left padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Int`	`getNumberOfLayers()` Returns the number of layers contained within this layer drawable.
`Boolean`	`getPadding(padding: Rect)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).
`Int`	`getPaddingMode()`
`Int`	`getRightPadding()` Returns the right padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Int`	`getStartPadding()` Returns the start padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Int`	`getTopPadding()` Returns the top padding in pixels. A return value of `-1` means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by `getPadding(android.graphics.Rect)` will be computed from the child layers according to the padding mode (see `getPaddingMode()`.
`Unit`	`invalidateDrawable(who: Drawable)` Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).
`Boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See `android.util.LayoutDirection`.
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)` A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call `android.os.Handler#postAtTime(Runnable, Object, long)` with the parameters (what, who, when) to perform the scheduling.
`Unit`	`setAlpha(alpha: Int)` Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
`Unit`	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See `android.util.LayoutDirection`.
`Unit`	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable. If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas. Pass `null` to remove any existing color filter. Note: Setting a non-`null` color filter disables `tint`.
`Unit`	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
`Unit`	`setDrawable(index: Int, drawable: Drawable!)` Sets the drawable for the layer at the specified index.
`Unit`	`setId(index: Int, id: Int)` Sets the ID of a layer.
`Unit`	`setLayerGravity(index: Int, gravity: Int)` Sets the gravity used to position or stretch the specified layer within its container. Gravity is applied after any layer insets (see `setLayerInset(int,int,int,int,int)`) or padding (see `setPaddingMode(int)`). If gravity is specified as `Gravity.NO_GRAVITY`, the default behavior depends on whether an explicit width or height has been set (see `setLayerSize(int,int,int)`), If a dimension is not set, gravity in that direction defaults to `Gravity.FILL_HORIZONTAL` or `Gravity.FILL_VERTICAL`; otherwise, gravity in that direction defaults to `Gravity.LEFT` or `Gravity.TOP`.
`Unit`	`setLayerHeight(index: Int, h: Int)`
`Unit`	`setLayerInset(index: Int, l: Int, t: Int, r: Int, b: Int)` Specifies the insets in pixels for the drawable at the specified index.
`Unit`	`setLayerInsetBottom(index: Int, b: Int)`
`Unit`	`setLayerInsetEnd(index: Int, e: Int)`
`Unit`	`setLayerInsetLeft(index: Int, l: Int)`
`Unit`	`setLayerInsetRelative(index: Int, s: Int, t: Int, e: Int, b: Int)` Specifies the relative insets in pixels for the drawable at the specified index.
`Unit`	`setLayerInsetRight(index: Int, r: Int)`
`Unit`	`setLayerInsetStart(index: Int, s: Int)`
`Unit`	`setLayerInsetTop(index: Int, t: Int)`
`Unit`	`setLayerSize(index: Int, w: Int, h: Int)` Sets an explicit size for the specified layer. Note: Setting an explicit layer size changes the default layer gravity behavior. See `setLayerGravity(int,int)` for more information.
`Unit`	`setLayerWidth(index: Int, w: Int)`
`Unit`	`setOpacity(opacity: Int)` Sets the opacity of this drawable directly instead of collecting the states from the layers.
`Unit`	`setPadding(left: Int, top: Int, right: Int, bottom: Int)` Sets the absolute padding. If padding in a dimension is specified as `-1`, the resolved padding will use the value computed according to the padding mode (see `setPaddingMode(int)`). Calling this method clears any relative padding values previously set using `setPaddingRelative(int,int,int,int)`.
`Unit`	`setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)` Sets the relative padding. If padding in a dimension is specified as `-1`, the resolved padding will use the value computed according to the padding mode (see `setPaddingMode(int)`). Calling this method clears any absolute padding values previously set using `setPadding(int,int,int,int)`.
`Unit`	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `BlendMode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)`
`Unit`	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)` A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable`. An implementation can generally simply call `android.os.Handler#removeCallbacks(Runnable, Object)` with the parameters (what, who) to unschedule the drawable.

From class Drawable

`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`Drawable.Callback?`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`ColorFilter?`	`getColorFilter()` Returns the current color filter, or `null` if none set.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isFilterBitmap()`
`Boolean`	`isVisible()`
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setFilterBitmap(filter: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `PorterDuff.Mode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:color

android:color

The color to use for ripple effects. This attribute is required.

May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb".

Constants

RADIUS_AUTO

Added in API level 23

static val RADIUS_AUTO: Int

Radius value that specifies the ripple radius should be computed based on the size of the ripple's container.

Value: -1

Parameters
`color`	ColorStateList: The ripple color. This value cannot be `null`.
`content`	Drawable?: The content drawable, may be `null`
`mask`	Drawable?: The mask drawable, may be `null`

Parameters
`r`	Resources: This value cannot be `null`.
`parser`	XmlPullParser: This value cannot be `null`.
`attrs`	AttributeSet: This value cannot be `null`.
`theme`	Resources.Theme?: This value may be `null`.

Exceptions
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

Parameters
`id`	Int: The layer ID to search for.
`drawable`	Drawable!: The replacement `Drawable`.

Parameters
`x`	Float: The X coordinate of the center of the hotspot
`y`	Float: The Y coordinate of the center of the hotspot

Parameters
`left`	Int: position in pixels of the left bound
`top`	Int: position in pixels of the top bound
`right`	Int: position in pixels of the right bound
`bottom`	Int: position in pixels of the bottom bound

Parameters
`visible`	Boolean: Set to true if visible, false if not.
`restart`	Boolean: You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.

RippleDrawable

Summary

XML attributes

android:color

Constants

RADIUS_AUTO

Public constructors

RippleDrawable

Public methods

applyTheme

canApplyTheme

draw

getConstantState

getDirtyBounds

getEffectColor

getHotspotBounds

getOpacity

getOutline

getRadius

hasFocusStateSpecified

inflate

invalidateSelf

isProjected

isStateful

jumpToCurrentState

mutate

setColor

setDrawableByLayerId

setEffectColor

setHotspot

setHotspotBounds

setPaddingMode

setRadius

setVisible

Protected methods

onBoundsChange

onStateChange