BitmapDrawable

Kotlin |Java

open class BitmapDrawable : Drawable

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.BitmapDrawable

A Drawable that wraps a bitmap and can be tiled, stretched, or aligned. You can create a BitmapDrawable from a file path, an input stream, through XML inflation, or from a android.graphics.Bitmap object.

It can be defined in an XML file with the <bitmap> element. For more information, see the guide to Drawable Resources.

Also see the android.graphics.Bitmap class, which handles the management and transformation of raw bitmap graphics, and should be used when drawing to a android.graphics.Canvas.

Summary

XML attributes
`android:antialias`	Enables or disables antialiasing.
`android:dither`	Enables or disables dithering of the bitmap if the bitmap does not have the same pixel configuration as the screen (for instance: a ARGB 8888 bitmap with an RGB 565 screen).
`android:filter`	Enables or disables bitmap filtering.
`android:gravity`	Defines the gravity for the bitmap.
`android:mipMap`	Enables or disables the mipmap hint.
`android:src`	Identifier of the bitmap file.
`android:tileMode`	Defines the tile mode.

Public constructors
`BitmapDrawable()` Create an empty drawable, not dealing with density.
`BitmapDrawable(res: Resources!)` Create an empty drawable, setting initial target density based on the display metrics of the resources.
`BitmapDrawable(res: Resources!, bitmap: Bitmap!)` Create drawable from a bitmap, setting initial target density based on the display metrics of the resources.
`BitmapDrawable(res: Resources!, is: InputStream!)` Create a drawable by decoding a bitmap from the given input stream.
`BitmapDrawable(res: Resources!, filepath: String!)` Create a drawable by opening a given file path and decoding the bitmap.
`BitmapDrawable(bitmap: Bitmap!)` Create drawable from a bitmap, not dealing with density.
`BitmapDrawable(is: InputStream!)` Create a drawable by decoding a bitmap from the given input stream.
`BitmapDrawable(filepath: String!)` Create a drawable by opening a given file path and decoding the bitmap.

Public methods
open Unit	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Boolean	`canApplyTheme()`
open Unit	`draw(canvas: Canvas)` Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
open Int	`getAlpha()` Gets the current alpha value for the drawable.
Bitmap!	`getBitmap()` Returns the bitmap used by this drawable to render.
open Int	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open ColorFilter?	`getColorFilter()` Returns the current color filter, or `null` if none set.
Drawable.ConstantState?	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
open Int	`getGravity()` Get the gravity used to position/stretch the bitmap within its bounds.
open Int	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
open Int	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Insets	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
open Unit	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area.
Paint!	`getPaint()` Returns the paint used to render this drawable.
open Shader.TileMode!	`getTileModeX()` Indicates the repeat behavior of this drawable on the X axis.
open Shader.TileMode!	`getTileModeY()` Indicates the repeat behavior of this drawable on the Y axis.
open Boolean	`hasAntiAlias()` Indicates whether anti-aliasing is enabled for this drawable.
open Boolean	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`.
open Boolean	`hasMipMap()` Indicates whether the mipmap hint is enabled on this drawable's bitmap.
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.
Boolean	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
open Boolean	`isFilterBitmap()`
open Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Drawable	`mutate()` A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.
open Unit	`setAlpha(alpha: Int)` Specify an alpha value for the drawable.
open Unit	`setAntiAlias(aa: Boolean)` Enables or disables anti-aliasing for this drawable.
open Unit	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
open Unit	`setBitmap(bitmap: Bitmap?)` Switch to a new Bitmap object.
open Unit	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable.
open Unit	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
open Unit	`setFilterBitmap(filter: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
open Unit	`setGravity(gravity: Int)` Set the gravity used to position/stretch the bitmap within its bounds.
open Unit	`setMipMap(mipMap: Boolean)` Enables or disables the mipmap hint for this drawable's bitmap.
open Unit	`setTargetDensity(canvas: Canvas!)` Set the density scale at which this drawable will be rendered.
open Unit	`setTargetDensity(metrics: DisplayMetrics!)` Set the density scale at which this drawable will be rendered.
open Unit	`setTargetDensity(density: Int)` Set the density at which this drawable will be rendered.
open Unit	`setTileModeX(mode: Shader.TileMode!)` Sets the repeat behavior of this drawable on the X axis.
open Unit	`setTileModeXY(xmode: Shader.TileMode!, ymode: Shader.TileMode!)` Sets the repeat behavior of this drawable on both axis.
Unit	`setTileModeY(mode: Shader.TileMode!)` Sets the repeat behavior of this drawable on the Y axis.
open Unit	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable.
open Unit	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list.

Protected methods
open Unit	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.
open Boolean	`onStateChange(stateSet: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.

Inherited functions

From class Drawable

`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`Drawable.Callback?`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Boolean`	`getPadding(padding: Rect)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isProjected()` Whether this drawable requests projection. Indicates that the `android.graphics.RenderNode` this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
`Boolean`	`isVisible()`
`Unit`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `PorterDuff.Mode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:antialias

android:antialias

Enables or disables antialiasing. Antialiasing can be used to smooth the edges of a bitmap when rotated. Default value is false.

May be a boolean value, such as "true" or "false".

android:dither

android:dither

Enables or disables dithering of the bitmap if the bitmap does not have the same pixel configuration as the screen (for instance: a ARGB 8888 bitmap with an RGB 565 screen). Default value is true.

May be a boolean value, such as "true" or "false".

android:filter

android:filter

Enables or disables bitmap filtering. Filtering is used when the bitmap is shrunk or stretched to smooth its appearance. Default value is true.

May be a boolean value, such as "true" or "false".

android:gravity

android:gravity

Defines the gravity for the bitmap. The gravity indicates where to position the drawable in its container if the bitmap is smaller than the container.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
bottom	50	Push object to the bottom of its container, not changing its size.
center	11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal	1	Place object in the horizontal center of its container, not changing its size.
center_vertical	10	Place object in the vertical center of its container, not changing its size.
clip_horizontal	8	Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
clip_vertical	80	Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
end	800005	Push object to the end of its container, not changing its size.
fill	77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal	7	Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical	70	Grow the vertical size of the object if needed so it completely fills its container.
left	3	Push object to the left of its container, not changing its size.
right	5	Push object to the right of its container, not changing its size.
start	800003	Push object to the beginning of its container, not changing its size.
top	30	Push object to the top of its container, not changing its size.

android:mipMap

android:mipMap

Enables or disables the mipmap hint. See android.graphics.Bitmap#setHasMipMap(boolean) for more information. Default value is false.

May be a boolean value, such as "true" or "false".

android:src

android:src

Identifier of the bitmap file. This attribute is mandatory.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb".

android:tileMode

android:tileMode

Defines the tile mode. When the tile mode is enabled, the bitmap is repeated. Gravity is ignored when the tile mode is enabled. Default value is "disabled".

Must be one of the following constant values.

Constant	Value	Description
clamp	0	Replicates the edge color.
disabled	ffffffff	Do not tile the bitmap. This is the default value.
mirror	2	Repeats the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam.
repeat	1	Repeats the bitmap in both direction.

Parameters
`r`	Resources: Resources used to resolve attribute values. This value cannot be `null`.
`parser`	XmlPullParser: XML parser from which to inflate this Drawable. This value cannot be `null`.
`attrs`	AttributeSet: Base set of attribute values. This value cannot be `null`.
`theme`	Resources.Theme?: Theme to apply, may be null

Exceptions
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

Parameters
`xmode`	Shader.TileMode!: The X repeat mode for this drawable.
`ymode`	Shader.TileMode!: The Y repeat mode for this drawable.

BitmapDrawable

Summary

XML attributes

android:antialias

android:dither

android:filter

android:gravity

android:mipMap

android:src

android:tileMode

Public constructors

BitmapDrawable

BitmapDrawable

BitmapDrawable

BitmapDrawable

BitmapDrawable

BitmapDrawable

BitmapDrawable

BitmapDrawable

Public methods

applyTheme

canApplyTheme

draw

getAlpha

getBitmap

getChangingConfigurations

getColorFilter

getConstantState

getGravity

getIntrinsicHeight

getIntrinsicWidth

getOpacity

getOpticalInsets

getOutline

getPaint

getTileModeX

getTileModeY

hasAntiAlias

hasFocusStateSpecified

hasMipMap

inflate

isAutoMirrored

isFilterBitmap

isStateful

mutate

setAlpha

setAntiAlias

setAutoMirrored

setBitmap

setColorFilter

setDither

setFilterBitmap

setGravity

setMipMap

setTargetDensity

setTargetDensity

setTargetDensity

setTileModeX

setTileModeXY

setTileModeY

setTintBlendMode

setTintList

Protected methods

onBoundsChange

onStateChange