TileMode

  • Common/All
  • Android/JVM

Defines what happens at the edge of the gradient. A gradient is defined along a finite inner area. In the case of a linear gradient, it's between the parallel lines that are orthogonal to the line drawn between two points. In the case of radial gradients, it's the disc that covers the circle centered on a particular point up to a given radius.

This enum is used to define how the gradient should paint the regions outside that defined inner area.

See also: LinearGradientShader, RadialGradientShader which works in relative coordinates and can create a Shader representing the gradient for a particular Rect on demand.

Summary

Public companion properties

TileMode

Edge is clamped to the final color.

Cmn
TileMode

Render the shader's image pixels only within its original bounds.

Cmn
TileMode

Edge is mirrored from last color to first.

Cmn
TileMode

Edge is repeated from first color to last.

Cmn

Public functions

open String
Cmn

Extension functions

Shader.TileMode
android
Boolean

Capability query to determine if the particular platform supports the TileMode.

Cmn
android

Public companion properties

Clamp

val ClampTileMode

Edge is clamped to the final color.

The gradient will paint the all the regions outside the inner area with the color of the point closest to that region. TileMode.Clamp

Decal

val DecalTileMode

Render the shader's image pixels only within its original bounds. If the shader draws outside of its original bounds, transparent black is drawn instead. TileMode.Decal

Mirror

val MirrorTileMode

Edge is mirrored from last color to first. This is as if the stop points from 0.0 to 1.0 were then repeated backwards from 2.0 to 1.0, then forwards from 2.0 to 3.0, then backwards again from 4.0 to 3.0, and so forth (and for linear gradients, similarly from in the negative direction). TileMode.Mirror

Repeated

val RepeatedTileMode

Edge is repeated from first color to last.

This is as if the stop points from 0.0 to 1.0 were then repeated from 1.0 to 2.0, 2.0 to 3.0, and so forth (and for linear gradients, similarly from -1.0 to 0.0, -2.0 to -1.0, etc). TileMode.Repeated

Public functions

toString

open fun toString(): String

Extension functions

isSupported

fun TileMode.isSupported(): Boolean

Capability query to determine if the particular platform supports the TileMode. Not all platforms support all tile mode algorithms, however, TileMode.Clamp, TileMode.Repeated and TileMode.Mirror are guaranteed to be supported. If a TileMode that is not supported is used, the default of TileMode.Clamp is consumed instead.