BrushPaint.StampingTexture
-
Cmn
class BrushPaint.StampingTexture : BrushPaint.TextureLayer
| kotlin.Any | ||
| ↳ | androidx.ink.brush.BrushPaint.TextureLayer | |
| ↳ | androidx.ink.brush.BrushPaint.StampingTexture | |
A texture that is "stamped" onto each particle of the stroke, scaled or rotated appropriately to cover the whole particle.
Summary
Nested types |
|---|
|
Builder for |
Public companion functions |
||
|---|---|---|
BrushPaint.StampingTexture.Builder |
builder()Returns a new |
Cmn
|
Public constructors |
|
|---|---|
StampingTexture(Creates a new |
Cmn
|
StampingTexture(Creates a new |
Cmn
|
Public functions |
||
|---|---|---|
BrushPaint.StampingTexture |
copy(Creates a copy of |
Cmn
|
BrushPaint.StampingTexture |
copy(Creates a copy of |
Cmn
|
open operator Boolean |
Cmn
|
|
open Int |
hashCode() |
Cmn
|
BrushPaint.StampingTexture.Builder |
Returns a |
Cmn
|
open String |
toString() |
Cmn
|
Public properties |
||
|---|---|---|
Int |
Cmn
|
|
Long |
Cmn
|
|
Int |
Cmn
|
|
BrushPaint.AnimationRepeatMode |
Cmn
|
|
Int |
Cmn
|
|
String |
The client texture ID for this texture layer. |
Cmn
|
Inherited functions |
|||
|---|---|---|---|
|
Inherited properties |
|||
|---|---|---|---|
|
Public companion functions
Public constructors
StampingTexture
StampingTexture(
clientTextureId: String,
blendMode: BrushPaint.TextureLayer.BlendMode = BlendMode.MODULATE
)
Creates a new StampingTexture with the specified parameters.
| Parameters | |
|---|---|
clientTextureId: String |
A string identifier of an image that provides the color for a particular pixel for this layer. The coordinates within this image that will be used are determined by the other parameters. |
blendMode: BrushPaint.TextureLayer.BlendMode = BlendMode.MODULATE |
The method by which the texture layers up to this one (index <= i) are combined with the subsequent texture layer (index == i+1). For the last texture layer, this defines the method by which the texture layer is combined with the brush color (possibly after that color gets per-vertex adjustments). |
StampingTexture
StampingTexture(
clientTextureId: String,
blendMode: BrushPaint.TextureLayer.BlendMode = BlendMode.MODULATE,
animationFrames: @IntRange(from = 1, to = 16777216) Int = 1,
animationRows: @IntRange(from = 1, to = 4096) Int = 1,
animationColumns: @IntRange(from = 1, to = 4096) Int = 1,
animationDurationMillis: @IntRange(from = 0, to = 16777216) Long = 1000,
animationRepeatMode: BrushPaint.AnimationRepeatMode = AnimationRepeatMode.RESTART
)
Creates a new StampingTexture with the specified parameters.
Java callers should use the Builder class instead.
| Parameters | |
|---|---|
clientTextureId: String |
A string identifier of an image that provides the color for a particular pixel for this layer. The coordinates within this image that will be used are determined by the other parameters. |
blendMode: BrushPaint.TextureLayer.BlendMode = BlendMode.MODULATE |
The method by which the texture layers up to this one (index <= i) are combined with the subsequent texture layer (index == i+1). For the last texture layer, this defines the method by which the texture layer is combined with the brush color (possibly after that color gets per-vertex adjustments). |
animationFrames: @IntRange(from = 1, to = 16777216) Int = 1 |
The number of animation frames in this texture, or 1 for no animation. If greater than 1, then the texture image is treated as a grid of animation frame images, with dimensions of |
animationRows: @IntRange(from = 1, to = 4096) Int = 1 |
The number of frame rows in this texture. See |
animationColumns: @IntRange(from = 1, to = 4096) Int = 1 |
Like |
animationDurationMillis: @IntRange(from = 0, to = 16777216) Long = 1000 |
The duration of one complete animation loop for this texture (either passing through each frame once if |
animationRepeatMode: BrushPaint.AnimationRepeatMode = AnimationRepeatMode.RESTART |
Specifies what should happen when the animation reaches the last frame: either it can immediately restart back at the first frame, or it can reverse direction. Ignored if |
Public functions
copy
fun copy(
clientTextureId: String = this.clientTextureId,
blendMode: BrushPaint.TextureLayer.BlendMode = this.blendMode
): BrushPaint.StampingTexture
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
copy
fun copy(
clientTextureId: String = this.clientTextureId,
blendMode: BrushPaint.TextureLayer.BlendMode = this.blendMode,
animationFrames: @IntRange(from = 1, to = 16777216) Int = this.animationFrames,
animationRows: @IntRange(from = 1, to = 4096) Int = this.animationRows,
animationColumns: @IntRange(from = 1, to = 4096) Int = this.animationColumns,
animationDurationMillis: @IntRange(from = 0, to = 16777216) Long = this.animationDurationMillis,
animationRepeatMode: BrushPaint.AnimationRepeatMode = this.animationRepeatMode
): BrushPaint.StampingTexture
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
toBuilder
fun toBuilder(): BrushPaint.StampingTexture.Builder
Returns a Builder with values set equivalent to this. Java developers, use the returned builder to build a copy of a StampingTexture. Kotlin developers, see copy method.