skiko/org.jetbrains.skiko.node/RenderNode

RenderNode

RenderNode is used to build hardware accelerated rendering hierarchies. Each RenderNode contains both a display list as well as a set of properties that affect the rendering of the display list. RenderNodes are used internally for all Views by default and are not typically used directly.

RenderNodes are used to divide up the rendering content of a complex scene into smaller pieces that can then be updated individually more cheaply. Updating part of the scene only needs to update the display list or properties of a small number of RenderNode instead of redrawing everything from scratch. A RenderNode only needs its display list re-recorded when its content alone should be changed. RenderNodes can also be transformed without re-recording the display list through the transform properties.

A tree of RenderNodes is owned by a single thread. Recording, changing a property and drawing all mutate the node they are called on, and changing a property of one node may also mutate the nodes drawing it, so none of them may run concurrently with each other. A picture recorded from a node is immutable and can be replayed on any thread.

Constructors

RenderNode

constructor(context: RenderNodeContext)

Properties

alpha

var alpha: Float

Alpha multiplier for this RenderNode.

ambientShadowColor

var ambientShadowColor: Int

bounds

var bounds: Rect

cameraDistance

var cameraDistance: Float

clip

var clip: Boolean

isClosed

expect open val isClosed: Boolean

Check if underlying resource is closed.

layerPaint

var layerPaint: Paint?

Optional paint used when compositing this RenderNode into an offscreen layer.

nativePtr

expect val nativePtr: NativePointer

pivot

var pivot: Point

refCount

expect val refCount: Int

Number of references on underlying native object.

var rotationX: Float

var rotationY: Float

var rotationZ: Float

var scaleX: Float

var scaleY: Float

var shadowElevation: Float

spotShadowColor

var spotShadowColor: Int

translationX

var translationX: Float

translationY

var translationY: Float

Functions

beginRecording

fun beginRecording(): Canvas

expect open fun close()

Free underlying native resource, peer is useless afterwards.

drawInto

fun drawInto(canvas: Canvas)

endRecording

fun endRecording()

setClipPath

fun setClipPath(p: Path?, mode: ClipMode = ClipMode.INTERSECT, antiAlias: Boolean = false)

setClipRect

fun setClipRect(r: Rect, mode: ClipMode = ClipMode.INTERSECT, antiAlias: Boolean = false)

fun setClipRect(left: Float, top: Float, right: Float, bottom: Float, mode: ClipMode = ClipMode.INTERSECT, antiAlias: Boolean = false)

setClipRRect

fun setClipRRect(r: RRect, mode: ClipMode = ClipMode.INTERSECT, antiAlias: Boolean = false)

fun setClipRRect(left: Float, top: Float, right: Float, bottom: Float, radii: FloatArray, mode: ClipMode = ClipMode.INTERSECT, antiAlias: Boolean = false)

toString

expect open override fun toString(): String