BrushPaint.TilingTexture
public final class BrushPaint.TilingTexture extends BrushPaint.TextureLayer
| java.lang.Object | ||
| ↳ | androidx.ink.brush.BrushPaint.TextureLayer | |
| ↳ | androidx.ink.brush.BrushPaint.TilingTexture | |
A texture layer that will repeat according to a 2D affine transformation of vertex positions. Each copy of the texture will have the same size and shape, modulo reflections.
Summary
Nested types |
|---|
public final class BrushPaint.TilingTexture.BuilderBuilder for |
public final class BrushPaint.TilingTexture.OriginSpecification of the origin point to use for the texture. |
Public constructors |
|---|
TilingTexture(Creates a new |
Public methods |
|
|---|---|
static final @NonNull BrushPaint.TilingTexture.Builder |
builder()Returns a new |
final @NonNull BrushPaint.TilingTexture |
copy(Creates a copy of |
boolean |
|
final @NonNull String |
|
final float |
The horizontal offset for the texture, specified as a fraction of the texture width. |
final float |
The vertical offset for the texture, specified as a fraction of the texture height. |
final @NonNull BrushPaint.TilingTexture.Origin |
The origin that will be used for positioning this texture layer. |
final float |
Angle specifying the rotation of the texture. |
final @NonNull BrushPaint.TextureLayer.SizeUnit |
The units in which this texture layer's width and height are measured. |
final float |
getSizeX()The width of the texture, specified in |
final float |
getSizeY()The height of the texture, specified in |
final @NonNull BrushPaint.TextureLayer.Wrap |
getWrapX()The horizontal wrapping mode for this texture layer. |
final @NonNull BrushPaint.TextureLayer.Wrap |
getWrapY()The vertical wrapping mode for this texture layer. |
int |
hashCode() |
final @NonNull BrushPaint.TilingTexture.Builder |
Returns a |
@NonNull String |
toString() |
Inherited methods |
||
|---|---|---|
|
Public constructors
TilingTexture
public TilingTexture(
@NonNull String clientTextureId,
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeX,
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeY,
float offsetX,
float offsetY,
@AngleDegreesFloat float rotationDegrees,
@NonNull BrushPaint.TextureLayer.SizeUnit sizeUnit,
@NonNull BrushPaint.TilingTexture.Origin origin,
@NonNull BrushPaint.TextureLayer.Wrap wrapX,
@NonNull BrushPaint.TextureLayer.Wrap wrapY,
@NonNull BrushPaint.TextureLayer.BlendMode blendMode
)
Creates a new TilingTexture 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. |
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeX |
The X size in |
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeY |
The Y size in |
float offsetX |
An offset into the texture, specified as fractions of the texture |
float offsetY |
An offset into the texture, specified as fractions of the texture |
@AngleDegreesFloat float rotationDegrees |
Angle in degrees specifying the rotation of the texture. The rotation is carried out about the center of the texture's first repetition along both axes. |
@NonNull BrushPaint.TextureLayer.SizeUnit sizeUnit |
|
@NonNull BrushPaint.TilingTexture.Origin origin |
The origin point to be used for texture space. |
@NonNull BrushPaint.TextureLayer.Wrap wrapX |
The wrap mode along the horizontal texture axis. |
@NonNull BrushPaint.TextureLayer.Wrap wrapY |
The wrap mode along the vertical texture axis. |
@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). |
Public methods
builder
public static final @NonNull BrushPaint.TilingTexture.Builder builder()
Returns a new TilingTexture.Builder.
copy
public final @NonNull BrushPaint.TilingTexture copy(
@NonNull String clientTextureId,
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeX,
@FloatRange(from = 0.0, fromInclusive = false, toInclusive = false) float sizeY,
float offsetX,
float offsetY,
@AngleDegreesFloat float rotationDegrees,
@NonNull BrushPaint.TextureLayer.SizeUnit sizeUnit,
@NonNull BrushPaint.TilingTexture.Origin origin,
@NonNull BrushPaint.TextureLayer.Wrap wrapX,
@NonNull BrushPaint.TextureLayer.Wrap wrapY,
@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.
getOffsetX
public final float getOffsetX()
The horizontal offset for the texture, specified as a fraction of the texture width.
getOffsetY
public final float getOffsetY()
The vertical offset for the texture, specified as a fraction of the texture height.
getOrigin
public final @NonNull BrushPaint.TilingTexture.Origin getOrigin()
The origin that will be used for positioning this texture layer.
getRotationDegrees
public final float getRotationDegrees()
Angle specifying the rotation of the texture. The rotation is carried out about the center of the texture's first repetition along both axes.
getSizeUnit
public final @NonNull BrushPaint.TextureLayer.SizeUnit getSizeUnit()
The units in which this texture layer's width and height are measured.
getSizeX
public final float getSizeX()
The width of the texture, specified in sizeUnits.
getSizeY
public final float getSizeY()
The height of the texture, specified in sizeUnits.
getWrapX
public final @NonNull BrushPaint.TextureLayer.Wrap getWrapX()
The horizontal wrapping mode for this texture layer.
getWrapY
public final @NonNull BrushPaint.TextureLayer.Wrap getWrapY()
The vertical wrapping mode for this texture layer.
toBuilder
public final @NonNull BrushPaint.TilingTexture.Builder toBuilder()
Returns a Builder with values set equivalent to this. Java developers, use the returned builder to build a copy of a TilingTexture. Kotlin developers, see copy method.