Picture
open class Picture
| kotlin.Any | |
| ↳ | android.graphics.Picture |
A Picture records drawing calls (via the canvas returned by beginRecording) and can then play them back into Canvas (via Picture.draw(Canvas) or Canvas.drawPicture(Picture)).For most content (e.g. text, lines, rectangles), drawing a sequence from a picture can be faster than the equivalent API calls, since the picture performs its playback without incurring any method-call overhead.
Note: Prior to API level 23 a picture cannot be replayed on a hardware accelerated canvas.
Summary
| Public constructors | |
|---|---|
Picture()Creates an empty picture that is ready to record. |
|
|
Create a picture by making a copy of what has already been recorded in src. |
|
| Public methods | |
|---|---|
| open Canvas |
beginRecording(width: Int, height: Int)To record a picture, call beginRecording() and then draw into the Canvas that is returned. |
| open Unit |
Draw this picture on the canvas. |
| open Unit |
Call endRecording when the picture is built. |
| open Int |
Get the height of the picture as passed to beginRecording. |
| open Int |
getWidth()Get the width of the picture as passed to beginRecording. |
| open Boolean |
Indicates whether or not this Picture contains recorded commands that only work when drawn to a hardware-accelerated canvas. |
| Protected methods | |
|---|---|
| open Unit |
finalize() |
Public constructors
Picture
Picture(src: Picture!)
Create a picture by making a copy of what has already been recorded in src. The contents of src are unchanged, and if src changes later, those changes will not be reflected in this picture.
Public methods
beginRecording
open fun beginRecording(
width: Int,
height: Int
): Canvas
To record a picture, call beginRecording() and then draw into the Canvas that is returned. Nothing we appear on screen, but all of the draw commands (e.g. Canvas.drawRect(Rect, Paint)) will be recorded. To stop recording, call endRecording(). After endRecording() the Canvas that was returned must no longer be used, and nothing should be drawn into it.
| Return | |
|---|---|
Canvas |
This value cannot be null. |
draw
open fun draw(canvas: Canvas): Unit
Draw this picture on the canvas.
Prior to android.os.Build.VERSION_CODES#LOLLIPOP, this call could have the side effect of changing the matrix and clip of the canvas if this picture had imbalanced saves/restores.
Note: This forces the picture to internally call Picture.endRecording() in order to prepare for playback.
| Parameters | |
|---|---|
canvas |
Canvas: The picture is drawn to this canvas This value cannot be null. |
endRecording
open fun endRecording(): Unit
Call endRecording when the picture is built. After this call, the picture may be drawn, but the canvas that was returned by beginRecording must not be used anymore. This is automatically called if Picture.draw or Canvas.drawPicture(Picture) is called.
getHeight
open fun getHeight(): Int
Get the height of the picture as passed to beginRecording. This does not reflect (per se) the content of the picture.
getWidth
open fun getWidth(): Int
Get the width of the picture as passed to beginRecording. This does not reflect (per se) the content of the picture.
requiresHardwareAcceleration
open fun requiresHardwareAcceleration(): Boolean
Indicates whether or not this Picture contains recorded commands that only work when drawn to a hardware-accelerated canvas. If this returns true then this Picture can only be drawn to another Picture or to a Canvas where canvas.isHardwareAccelerated() is true. Note this value is only updated after recording has finished by a call to endRecording(). Prior to that it will be the default value of false.
| Return | |
|---|---|
Boolean |
true if the Picture can only be drawn to a hardware-accelerated canvas, false otherwise. |
Protected methods
finalize
protected open fun finalize(): Unit
| Exceptions | |
|---|---|
java.lang.Throwable |
the Exception raised by this method |