skiko/org.jetbrains.skia/Surface

Surface

class Surface : RefCnt

Types

Companion

object Companion

Properties

canvas

val canvas: Canvas

Returns Canvas that draws into Surface.

generationId

val generationId: Int

Returns unique value identifying the content of Surface.

height

val height: Int

Returns pixel row count; may be zero or greater.

imageInfo

val imageInfo: ImageInfo

Returns an ImageInfo describing the surface.

isClosed

expect open val isClosed: Boolean

Check if underlying resource is closed.

isUnique

val isUnique: Boolean

May return true if the caller is the only owner.

recordingContext

val recordingContext: DirectContext?

Returns the recording context being used by the Surface.

refCount

expect val refCount: Int

Number of references on underlying native object.

width

val width: Int

Returns pixel count in each row; may be zero or greater.

Functions

expect open fun close()

Free underlying native resource, peer is useless afterwards.

draw

fun draw(canvas: Canvas?, x: Int, y: Int, paint: Paint?)

fun draw(canvas: Canvas?, x: Int, y: Int, samplingMode: SamplingMode, paint: Paint?)

Draws Surface contents to canvas, with its top-left corner at (x, y).

flush

fun flush()

flushAndSubmit

fun flushAndSubmit()

fun flushAndSubmit(syncCpu: Boolean)

Call to ensure all reads/writes of the surface have been issued to the underlying 3D API.

makeImageSnapshot

fun makeImageSnapshot(): Image

Returns Image capturing Surface contents.

fun makeImageSnapshot(area: IRect): Image?

Like the no-parameter version, this returns an image of the current surface contents.

makeSurface

fun makeSurface(imageInfo: ImageInfo): Surface?

Returns a compatible Surface, or null.

fun makeSurface(width: Int, height: Int): Surface?

Calls makeSurface(ImageInfo) with the same ImageInfo as this surface, but with the specified width and height.

notifyContentWillChange

fun notifyContentWillChange(mode: ContentChangeMode)

Notifies that Surface contents will be changed by code outside of Skia.

peekPixels

fun peekPixels(pixmap: Pixmap): Boolean

readPixels

fun readPixels(bitmap: Bitmap?, srcX: Int, srcY: Int): Boolean

Copies Rect of pixels from Surface into bitmap.

fun readPixels(pixmap: Pixmap?, srcX: Int, srcY: Int): Boolean

toString

expect open override fun toString(): String

writePixels

fun writePixels(bitmap: Bitmap?, x: Int, y: Int)

Copies Rect of pixels from the src Bitmap to the Surface.

fun writePixels(pixmap: Pixmap?, x: Int, y: Int)