skiko/org.jetbrains.skiko/SkiaLayer

SkiaLayer

expect open class SkiaLayer

Generic layer for Skiko rendering.

actual open class SkiaLayer
actual open class SkiaLayer

SkiaLayer implementation for macOS. Supports only GraphicsApi.METAL

actual open class SkiaLayer
actual open class SkiaLayer

Provides a way to render the content and to receive the input events. Rendering and events processing should be implemented in renderDelegate.

SkikoLayer needs to be initialized with HTMLCanvasElement instance using attachTo method.

Constructors

Link copied to clipboard
constructor()
constructor()
constructor()
constructor()

Properties

Link copied to clipboard
expect val component: Any?

Underlying platform component.

actual val component: Any?
actual val component: Any?
actual val component: Any?
actual val component: Any?
Link copied to clipboard
expect val contentScale: Float

Current content scale.

actual val contentScale: Float
actual val contentScale: Float

The scale factor of NSWindow https://developer.apple.com/documentation/appkit/nswindow/1419459-backingscalefactor

actual val contentScale: Float
actual val contentScale: Float

See https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio

Link copied to clipboard
expect var fullscreen: Boolean

If rendering is full screen.

actual var fullscreen: Boolean
actual var fullscreen: Boolean

Fullscreen is not supported

actual var fullscreen: Boolean
actual var fullscreen: Boolean

Fullscreen is not supported

Link copied to clipboard
val height: Float
Link copied to clipboard
lateinit var nsView: <Error class: unknown class>

Underlying NSView

Link copied to clipboard
expect val pixelGeometry: PixelGeometry

Pixel geometry corresponding to graphics device which renders this layer

actual val pixelGeometry: PixelGeometry
actual val pixelGeometry: PixelGeometry
actual val pixelGeometry: PixelGeometry
actual val pixelGeometry: PixelGeometry
Link copied to clipboard
expect var renderApi: GraphicsApi

Current graphics API used for rendering.

actual var renderApi: GraphicsApi
actual var renderApi: GraphicsApi

GraphicsApi.METAL is the only GraphicsApi supported for macOS. Setter throws an IllegalArgumentException if the value is not GraphicsApi.METAL.

actual var renderApi: GraphicsApi
actual var renderApi: GraphicsApi

GraphicsApi.WEBGL is the only supported renderApi for k/js (browser).

Link copied to clipboard
expect var renderDelegate: SkikoRenderDelegate?

Current view used for rendering.

actual var renderDelegate: SkikoRenderDelegate?
actual var renderDelegate: SkikoRenderDelegate?

Implements rendering logic and events processing.

actual var renderDelegate: SkikoRenderDelegate?
actual var renderDelegate: SkikoRenderDelegate?

An implementation of SkikoRenderDelegate with content rendering and event processing logic.

Link copied to clipboard
expect var transparency: Boolean

If transparency is enabled.

actual var transparency: Boolean
actual var transparency: Boolean

Transparency is not supported on macOS native.

actual var transparency: Boolean
actual var transparency: Boolean

Transparency is not supported

Link copied to clipboard
val width: Float

Functions

Link copied to clipboard
expect fun attachTo(container: Any)

Attach this SkikoRenderDelegate to platform container. Actual type of attach container is platform-specific.

actual fun attachTo(container: Any)
actual fun attachTo(container: Any)
actual fun attachTo(container: Any)
actual fun attachTo(container: Any)
Link copied to clipboard
expect fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()
actual fun detach()
actual fun detach()
actual fun detach()
Link copied to clipboard
fun SkiaLayer.disableTitleBar(customHeaderHeight: Float)

Disable showing window title bar.

Link copied to clipboard
fun isShowing(): Boolean
Link copied to clipboard
expect fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
Link copied to clipboard
expect fun needRender(throttledToVsync: Boolean = true)

Request redrawing of the content; The renderDelegate will be asked to re-render, and the result will be drawn on the screen.

actual fun needRender(throttledToVsync: Boolean)
actual fun needRender(throttledToVsync: Boolean)

Schedules a frame to an appropriate moment.

actual fun needRender(throttledToVsync: Boolean)
actual fun needRender(throttledToVsync: Boolean)

Schedules a drawFrame to the appropriate moment.