Added in API level 1

Summary: Constants | Ctors | Methods | Inherited Methods

BitmapShader

Kotlin |Java

public class BitmapShader
extends Shader

java.lang.Object
↳	android.graphics.Shader
	↳	android.graphics.BitmapShader

Shader used to draw a bitmap as a texture. The bitmap can be repeated or mirrored by setting the tiling mode.

Summary

Constants
`int`	`FILTER_MODE_DEFAULT` This FilterMode value will respect the value of the Paint#isFilterBitmap flag while the shader is attached to the Paint.
`int`	`FILTER_MODE_LINEAR` This FilterMode value will cause the shader to interpolate the output of the shader from a 2x2 grid of pixels nearest to the sample point (i.e.
`int`	`FILTER_MODE_NEAREST` This FilterMode value will cause the shader to sample from the nearest pixel to the requested sample point.

Public constructors
`BitmapShader(Bitmap bitmap, Shader.TileMode tileX, Shader.TileMode tileY)` Call this to create a new shader that will draw with a bitmap.

Public methods
`int`	`getFilterMode()` Returns the filter mode used when sampling from this shader
`void`	`setFilterMode(int mode)` Set the filter mode to be used when sampling from this shader

Inherited methods

From class


        
          android.graphics.Shader

`boolean`	`getLocalMatrix(Matrix localM)` Return true if the shader has a non-identity local matrix.
`void`	`setLocalMatrix(Matrix localM)` Set the shader's local matrix.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

FILTER_MODE_DEFAULT

Added in API level 33

public static final int FILTER_MODE_DEFAULT

This FilterMode value will respect the value of the Paint#isFilterBitmap flag while the shader is attached to the Paint.

The exception to this rule is when a Shader is attached as input to a RuntimeShader. In that case this mode will default to FILTER_MODE_NEAREST.

See also:

setFilterMode(int)

Constant Value: 0 (0x00000000)

FILTER_MODE_LINEAR

Added in API level 33

public static final int FILTER_MODE_LINEAR

This FilterMode value will cause the shader to interpolate the output of the shader from a 2x2 grid of pixels nearest to the sample point (i.e. bilinear interpolation).

This value will override the effect of Paint#isFilterBitmap.

See also:

setFilterMode(int)

Constant Value: 2 (0x00000002)

FILTER_MODE_NEAREST

Added in API level 33

public static final int FILTER_MODE_NEAREST

This FilterMode value will cause the shader to sample from the nearest pixel to the requested sample point.

This value will override the effect of Paint#isFilterBitmap.

See also:

setFilterMode(int)

Constant Value: 1 (0x00000001)

Public constructors

BitmapShader

Added in API level 1

public BitmapShader (Bitmap bitmap, 
                Shader.TileMode tileX, 
                Shader.TileMode tileY)

Call this to create a new shader that will draw with a bitmap.

Parameters
`bitmap`	`Bitmap`: The bitmap to use inside the shader This value cannot be `null`.
`tileX`	`Shader.TileMode`: The tiling mode for x to draw the bitmap in. This value cannot be `null`.
`tileY`	`Shader.TileMode`: The tiling mode for y to draw the bitmap in. This value cannot be `null`.

Public methods

getFilterMode

Added in API level 33

public int getFilterMode ()

Returns the filter mode used when sampling from this shader

Returns
`int`	Value is `FILTER_MODE_DEFAULT`, `FILTER_MODE_NEAREST`, or `FILTER_MODE_LINEAR`

setFilterMode

Added in API level 33

public void setFilterMode (int mode)

Set the filter mode to be used when sampling from this shader

Parameters
`mode`	`int`: Value is `FILTER_MODE_DEFAULT`, `FILTER_MODE_NEAREST`, or `FILTER_MODE_LINEAR`