BrushPaint.StampingTexture
public final class BrushPaint.StampingTexture extends BrushPaint.TextureLayer
| java.lang.Object | ||
| ↳ | 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 |
|---|
public final class BrushPaint.StampingTexture.BuilderBuilder for |
Public constructors |
|---|
StampingTexture(Creates a new |
StampingTexture(Creates a new |
Public methods |
|
|---|---|
static final @NonNull BrushPaint.StampingTexture.Builder |
builder()Returns a new |
final @NonNull BrushPaint.StampingTexture |
copy(Creates a copy of |
final @NonNull BrushPaint.StampingTexture |
copy(Creates a copy of |
boolean |
|
final @IntRange(from = 1, to = 4096) int |
|
final @IntRange(from = 0, to = 16777216) long |
|
final @IntRange(from = 1, to = 16777216) int |
|
final @NonNull BrushPaint.AnimationRepeatMode |
|
final @IntRange(from = 1, to = 4096) int |
|
final @NonNull String |
The client texture ID for this texture layer. |
int |
hashCode() |
final @NonNull BrushPaint.StampingTexture.Builder |
Returns a |
@NonNull String |
toString() |
Inherited methods |
||||
|---|---|---|---|---|
|
Public constructors
StampingTexture
public StampingTexture(
@NonNull String clientTextureId,
@NonNull BrushPaint.TextureLayer.BlendMode blendMode
)
Creates a new StampingTexture with the specified parameters.
| Parameters | |
|---|---|
@NonNull String clientTextureId |
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. |
@NonNull BrushPaint.TextureLayer.BlendMode blendMode |
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
public StampingTexture(
@NonNull String clientTextureId,
@NonNull BrushPaint.TextureLayer.BlendMode blendMode,
@IntRange(from = 1, to = 16777216) int animationFrames,
@IntRange(from = 1, to = 4096) int animationRows,
@IntRange(from = 1, to = 4096) int animationColumns,
@IntRange(from = 0, to = 16777216) long animationDurationMillis,
@NonNull BrushPaint.AnimationRepeatMode animationRepeatMode
)
Creates a new StampingTexture with the specified parameters.
Java callers should use the Builder class instead.
| Parameters | |
|---|---|
@NonNull String clientTextureId |
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. |
@NonNull BrushPaint.TextureLayer.BlendMode blendMode |
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). |
@IntRange(from = 1, to = 16777216) int animationFrames |
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 |
@IntRange(from = 1, to = 4096) int animationRows |
The number of frame rows in this texture. See |
@IntRange(from = 1, to = 4096) int animationColumns |
Like |
@IntRange(from = 0, to = 16777216) long animationDurationMillis |
The duration of one complete animation loop for this texture (either passing through each frame once if |
@NonNull BrushPaint.AnimationRepeatMode animationRepeatMode |
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 methods
builder
public static final @NonNull BrushPaint.StampingTexture.Builder builder()
Returns a new StampingTexture.Builder.
copy
public final @NonNull BrushPaint.StampingTexture copy(
@NonNull String clientTextureId,
@NonNull BrushPaint.TextureLayer.BlendMode blendMode
)
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
copy
public final @NonNull BrushPaint.StampingTexture copy(
@NonNull String clientTextureId,
@NonNull BrushPaint.TextureLayer.BlendMode blendMode,
@IntRange(from = 1, to = 16777216) int animationFrames,
@IntRange(from = 1, to = 4096) int animationRows,
@IntRange(from = 1, to = 4096) int animationColumns,
@IntRange(from = 0, to = 16777216) long animationDurationMillis,
@NonNull BrushPaint.AnimationRepeatMode animationRepeatMode
)
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
getAnimationColumns
public final @IntRange(from = 1, to = 4096) int getAnimationColumns()
getAnimationDurationMillis
public final @IntRange(from = 0, to = 16777216) long getAnimationDurationMillis()
getAnimationFrames
public final @IntRange(from = 1, to = 16777216) int getAnimationFrames()
getAnimationRepeatMode
public final @NonNull BrushPaint.AnimationRepeatMode getAnimationRepeatMode()
getAnimationRows
public final @IntRange(from = 1, to = 4096) int getAnimationRows()
getClientTextureId
public final @NonNull String getClientTextureId()
The client texture ID for this texture layer.
toBuilder
public final @NonNull BrushPaint.StampingTexture.Builder toBuilder()
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.