SkiaLayer

actual open class SkiaLayer

Generic layer for Skiko rendering.

actual open class SkiaLayer : JComponent, Accessible

Generic layer for Skiko rendering.

expect open class SkiaLayer

Generic layer for Skiko rendering.

actual open class SkiaLayer

Generic layer for Skiko rendering.

actual open class SkiaLayer

SkiaLayer implementation for macOS. Supports only GraphicsApi.METAL

actual open class SkiaLayer

Generic layer for Skiko rendering.

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(accessibleContextProvider: (Component) -> AccessibleContext? = null, isVsyncEnabled: Boolean = SkikoProperties.vsyncEnabled, isVsyncFramelimitFallbackEnabled: Boolean = SkikoProperties.vsyncFramelimitFallbackEnabled, frameBuffering: FrameBuffering = SkikoProperties.frameBuffering, renderApi: GraphicsApi = SkikoProperties.renderApi, analytics: SkiaLayerAnalytics = SkiaLayerAnalytics.Empty, pixelGeometry: PixelGeometry = PixelGeometry.UNKNOWN, fillsWindow: Boolean = false)
constructor(accessibleContextProvider: (Component) -> AccessibleContext? = null, properties: SkiaLayerProperties, analytics: SkiaLayerAnalytics = SkiaLayerAnalytics.Empty, pixelGeometry: PixelGeometry = PixelGeometry.UNKNOWN, fillsWindow: Boolean = false)
constructor()
constructor()
constructor()
constructor()

Types

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(description = "The preferred horizontal alignment of the component.")
open var alignmentX: Float
Link copied to clipboard
@set:BeanProperty(description = "The preferred vertical alignment of the component.")
open var alignmentY: Float
Link copied to clipboard
@get:BeanProperty(bound = false)
open val ancestorListeners: Array<out AncestorListener?>?
Link copied to clipboard
@set:BeanProperty(bound = false, expert = true, description = "Determines if this component automatically scrolls its contents when dragged.")
open var autoscrolls: Boolean
Link copied to clipboard
open var background: Color?
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(preferred = true, visualUpdate = true, description = "The component's border.")
open var border: Border?
Link copied to clipboard
open var bounds: Rectangle?
Link copied to clipboard
Link copied to clipboard

A list of rectangles to cut out from the rendered content; No content will be drawn inside them.

Link copied to clipboard
Link copied to clipboard
actual val component: Any?

Underlying platform component.

actual val component: Any?

Underlying platform component.

expect val component: Any?

Underlying platform component.

actual val component: Any?

Underlying platform component.

actual val component: Any?

Underlying platform component.

actual val component: Any?

Underlying platform component.

actual val component: Any?

Underlying platform component.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(preferred = true, description = "Popup to show")
open var componentPopupMenu: JPopupMenu?
Link copied to clipboard
open val components: Array<out Component?>?
Link copied to clipboard
Link copied to clipboard

Returns the pointer to an OS specific handle (native resource) of the SkiaLayer.

Link copied to clipboard
actual val contentScale: Float

Current content scale.

actual val contentScale: Float

Current content scale.

expect val contentScale: Float

Current content scale.

actual val contentScale: Float

Current content scale.

actual val contentScale: Float

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

actual val contentScale: Float

Current content scale.

actual val contentScale: Float

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

Link copied to clipboard

Returns the physical DPI value (number of dots per inch) of the current monitor.

Link copied to clipboard
open var cursor: Cursor?
Link copied to clipboard
@set:BeanProperty(bound = false, preferred = true, enumerationValues = ["DebugGraphics.NONE_OPTION", "DebugGraphics.LOG_OPTION", "DebugGraphics.FLASH_OPTION", "DebugGraphics.BUFFERED_OPTION"], description = "Diagnostic options for graphics operations.")
open var debugGraphicsOptions: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(preferred = true, visualUpdate = true, description = "The font for the component.")
open var font: Font?
Link copied to clipboard
@set:BeanProperty(preferred = true, visualUpdate = true, description = "The foreground color of the component.")
open var foreground: Color?
Link copied to clipboard
actual var fullscreen: Boolean

If rendering is full screen.

actual var fullscreen: Boolean

If rendering is full screen.

expect var fullscreen: Boolean

If rendering is full screen.

actual var fullscreen: Boolean

If rendering is full screen.

actual var fullscreen: Boolean

Fullscreen is not supported

actual var fullscreen: Boolean

If rendering is full screen.

actual var fullscreen: Boolean

Fullscreen is not supported

Link copied to clipboard
@get:BeanProperty(bound = false)
open val graphics: Graphics?
Link copied to clipboard
height
Link copied to clipboard
@get:BeanProperty(bound = false)
open val height: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(description = "Whether or not the JPopupMenu is inherited")
open var inheritsPopupMenu: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(description = "The component's input verifier.")
open var inputVerifier: InputVerifier?
Link copied to clipboard
@get:BeanProperty(expert = true)
open val insets: Insets?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(expert = true, preferred = true, visualUpdate = true, description = "The enabled state of the component.")
open var isEnabled: Boolean
Link copied to clipboard
open override var isFocusable: Boolean
Link copied to clipboard
Link copied to clipboard
open override val isFocusOwner: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val isFontSet: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:BeanProperty(bound = false)
open val isManagingFocus: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(expert = true, description = "The component's opacity")
open var isOpaque: Boolean
Link copied to clipboard
@get:BeanProperty(bound = false)
open val isOptimizedDrawingEnabled: Boolean
Link copied to clipboard
@get:BeanProperty(bound = false)
val isPaintingForPrint: Boolean
Link copied to clipboard
@get:BeanProperty(bound = false)
open val isPaintingTile: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val isShowing: Boolean
Link copied to clipboard
open val isValid: Boolean
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(hidden = true, visualUpdate = true)
open var isVisible: Boolean
Link copied to clipboard
open val keyListeners: Array<out KeyListener?>?
Link copied to clipboard
Link copied to clipboard
open var locale: Locale?
Link copied to clipboard
open var location: Point?
Link copied to clipboard
Link copied to clipboard
@set:BeanProperty(description = "The maximum size of the component.")
open var maximumSize: Dimension?
Link copied to clipboard
@set:BeanProperty(description = "The minimum size of the component.")
open var minimumSize: Dimension?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val mousePosition: Point?
Link copied to clipboard
Link copied to clipboard
open var name: String?
Link copied to clipboard
Link copied to clipboard
lateinit var nsView: NSView

Underlying NSView

Link copied to clipboard
open val parent: Container?
Link copied to clipboard

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Pixel geometry corresponding to graphics device which renders this layer

Link copied to clipboard
@set:BeanProperty(preferred = true, description = "The preferred size of the component.")
open var preferredSize: Dimension?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:BeanProperty(bound = false)
open val registeredKeyStrokes: Array<out KeyStroke?>?
Link copied to clipboard

Current graphics API used for rendering.

Current graphics API used for rendering.

Current graphics API used for rendering.

Current graphics API used for rendering.

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

Current graphics API used for rendering.

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

Link copied to clipboard

Current view used for rendering.

Current view used for rendering.

Current view used for rendering.

Current view used for rendering.

Implements rendering logic and events processing.

Current view used for rendering.

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

Link copied to clipboard
Link copied to clipboard
@get:BeanProperty(bound = false)
open val rootPane: JRootPane?
Link copied to clipboard
open var size: Dimension?
Link copied to clipboard
open val toolkit: Toolkit?
Link copied to clipboard
@set:BeanProperty(bound = false, preferred = true, description = "The text to display in a tool tip.")
open var toolTipText: String?
Link copied to clipboard
@get:BeanProperty(bound = false)
open val topLevelAncestor: Container?
Link copied to clipboard
@set:BeanProperty(hidden = true, description = "Mechanism for transfer of data to and from the component")
open var transferHandler: TransferHandler?
Link copied to clipboard

Whether transparency is enabled.

Link copied to clipboard
Link copied to clipboard
open var ui: ComponentUI?
Link copied to clipboard
@get:BeanProperty(bound = false, expert = true, description = "UIClassID")
open val uiClassID: String?
Link copied to clipboard
@set:BeanProperty(description = "Whether the Component verifies input before accepting focus.")
open var verifyInputWhenFocusTarget: Boolean
Link copied to clipboard
Link copied to clipboard
@get:BeanProperty(bound = false)
open val visibleRect: Rectangle?
width
Link copied to clipboard
@get:BeanProperty(bound = false)
open val width: Int
Link copied to clipboard

Returns the pointer to an OS specific window handle (native resource) which the current SkiaLayer is attached.

Link copied to clipboard
@get:BeanProperty(bound = false)
open val x: Int
Link copied to clipboard
@get:BeanProperty(bound = false)
open val y: Int

Functions

Link copied to clipboard
open fun action(evt: Event?, what: Any?): Boolean
Link copied to clipboard
open fun add(popup: PopupMenu?)
open fun add(comp: Component?): Component?
open fun add(comp: Component?, constraints: Any?)
open fun add(comp: Component?, index: Int): Component?
open fun add(name: String?, comp: Component?): Component?
open fun add(comp: Component?, constraints: Any?, index: Int)
Link copied to clipboard
override fun addAncestorListener(listener: AncestorListener?)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun addFocusListener(l: FocusListener?)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun addKeyListener(l: KeyListener)
Link copied to clipboard
open override fun addMouseListener(l: MouseListener)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun addNotify()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun attachTo(container: ViewGroup)

actual fun attachTo(container: Any)

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

fun attachTo(jComponent: JComponent)

actual fun attachTo(container: Any)

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

expect fun attachTo(container: Any)

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

actual 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)

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

actual fun attachTo(container: Any)
Link copied to clipboard
open fun bounds(): Rectangle?
Link copied to clipboard
Link copied to clipboard
open fun checkImage(image: Image?, observer: ImageObserver?): Int
open fun checkImage(image: Image?, width: Int, height: Int, observer: ImageObserver?): Int
Link copied to clipboard
open fun computeVisibleRect(visibleRect: Rectangle?)
Link copied to clipboard
open operator fun contains(p: Point?): Boolean
open fun contains(x: Int, y: Int): Boolean
Link copied to clipboard
open fun countComponents(): Int
Link copied to clipboard
open fun createImage(producer: ImageProducer?): Image?
open fun createImage(width: Int, height: Int): Image?
Link copied to clipboard
open fun createToolTip(): JToolTip?
Link copied to clipboard
open fun createVolatileImage(width: Int, height: Int): VolatileImage?
open fun createVolatileImage(width: Int, height: Int, caps: ImageCapabilities?): VolatileImage?
Link copied to clipboard
open fun deliverEvent(e: Event?)
Link copied to clipboard
actual fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()

Detach this SkikoRenderDelegate from platform container.

expect fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()

Detach this SkikoRenderDelegate from platform container.

actual fun detach()

Detach this SkikoRenderDelegate from platform container.

Link copied to clipboard
open fun disable()
Link copied to clipboard
fun SkiaLayer.disableTitleBar(customHeaderHeight: Float)

Disable showing the window title bar.

Link copied to clipboard
Link copied to clipboard
open fun dispose()
Link copied to clipboard
open override fun doLayout()
Link copied to clipboard
open fun enable()
open fun enable(b: Boolean)
Link copied to clipboard
open override fun enableInputMethods(enable: Boolean)
Link copied to clipboard
open fun findComponentAt(x: Int, y: Int): Component?
Link copied to clipboard
open fun firePropertyChange(propertyName: String?, oldValue: Boolean, newValue: Boolean)
open fun firePropertyChange(propertyName: String?, oldValue: Byte, newValue: Byte)
open fun firePropertyChange(propertyName: String?, oldValue: Char, newValue: Char)
open fun firePropertyChange(propertyName: String?, oldValue: Double, newValue: Double)
open fun firePropertyChange(propertyName: String?, oldValue: Float, newValue: Float)
open fun firePropertyChange(propertyName: String?, oldValue: Int, newValue: Int)
open fun firePropertyChange(propertyName: String?, oldValue: Long, newValue: Long)
open fun firePropertyChange(propertyName: String?, oldValue: Short, newValue: Short)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getBaseline(width: Int, height: Int): Int
Link copied to clipboard
open fun getBounds(rv: Rectangle?): Rectangle?
Link copied to clipboard
Link copied to clipboard
open fun getComponent(n: Int): Component?
Link copied to clipboard
open fun getComponentAt(x: Int, y: Int): Component?
Link copied to clipboard
open fun getComponentZOrder(comp: Component?): Int
Link copied to clipboard
open fun getConditionForKeyStroke(aKeyStroke: KeyStroke?): Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getFontMetrics(font: Font?): FontMetrics?
Link copied to clipboard
Link copied to clipboard
open fun <T : EventListener?> getListeners(listenerType: Class<T?>?): Array<out T?>?
Link copied to clipboard
open fun getLocation(rv: Point?): Point?
Link copied to clipboard
open fun getMousePosition(allowChildren: Boolean): Point?
Link copied to clipboard
open fun getPopupLocation(event: MouseEvent?): Point?
Link copied to clipboard
open fun getSize(rv: Dimension?): Dimension?
Link copied to clipboard
open fun getToolTipLocation(event: MouseEvent?): Point?
Link copied to clipboard
open fun gotFocus(evt: Event?, what: Any?): Boolean
Link copied to clipboard
open fun grabFocus()
Link copied to clipboard
open fun handleEvent(evt: Event?): Boolean
Link copied to clipboard
open override fun hasFocus(): Boolean
Link copied to clipboard
open fun hide()
Link copied to clipboard
open fun imageUpdate(img: Image?, infoflags: Int, x: Int, y: Int, w: Int, h: Int): Boolean
Link copied to clipboard
open fun insets(): Insets?
Link copied to clipboard
open fun inside(x: Int, y: Int): Boolean
Link copied to clipboard
open fun invalidate()
Link copied to clipboard
Link copied to clipboard
open override fun isFocusable(): Boolean
Link copied to clipboard
open override fun isFocusOwner(): Boolean
Link copied to clipboard
open override fun isShowing(): Boolean
Link copied to clipboard
open fun keyDown(evt: Event?, key: Int): Boolean
Link copied to clipboard
open fun keyUp(evt: Event?, key: Int): Boolean
Link copied to clipboard
open fun layout()
Link copied to clipboard
open fun list()
open fun list(out: PrintStream?)
open fun list(out: PrintWriter?)
open fun list(out: PrintStream?, indent: Int)
open fun list(out: PrintWriter?, indent: Int)
Link copied to clipboard
open fun locate(x: Int, y: Int): Component?
Link copied to clipboard
open fun location(): Point?
Link copied to clipboard
open fun lostFocus(evt: Event?, what: Any?): Boolean
Link copied to clipboard
open fun minimumSize(): Dimension?
Link copied to clipboard
open fun mouseDown(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun mouseDrag(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun mouseEnter(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun mouseExit(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun mouseMove(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun mouseUp(evt: Event?, x: Int, y: Int): Boolean
Link copied to clipboard
open fun move(x: Int, y: Int)
Link copied to clipboard
actual fun needRedraw()
actual fun needRedraw()
expect fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
actual fun needRedraw()
Link copied to clipboard
actual fun needRender(throttledToVsync: Boolean)

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)

Redraw on the next animation Frame (on vsync signal if vsync is enabled).

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)

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)

Schedules a frame to an appropriate moment.

actual fun needRender(throttledToVsync: Boolean)

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)

Schedules a drawFrame to the appropriate moment.

Link copied to clipboard
open fun nextFocus()
Link copied to clipboard
Link copied to clipboard
open override fun paint(g: Graphics)
Link copied to clipboard
open fun paintAll(g: Graphics?)
Link copied to clipboard
Link copied to clipboard
open fun paintImmediately(x: Int, y: Int, w: Int, h: Int)
Link copied to clipboard
open fun postEvent(e: Event?): Boolean
Link copied to clipboard
Link copied to clipboard
open fun prepareImage(image: Image?, observer: ImageObserver?): Boolean
open fun prepareImage(image: Image?, width: Int, height: Int, observer: ImageObserver?): Boolean
Link copied to clipboard
open fun print(g: Graphics?)
Link copied to clipboard
open fun printAll(g: Graphics?)
Link copied to clipboard
Link copied to clipboard
fun putClientProperty(key: Any?, value: Any?)
Link copied to clipboard
open fun registerKeyboardAction(anAction: ActionListener?, aKeyStroke: KeyStroke?, aCondition: Int)
open fun registerKeyboardAction(anAction: ActionListener?, aCommand: String?, aKeyStroke: KeyStroke?, aCondition: Int)
Link copied to clipboard
open fun remove(comp: Component?)
open fun remove(index: Int)
open fun remove(popup: MenuComponent?)
Link copied to clipboard
open fun removeAll()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun removeFocusListener(l: FocusListener?)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun removeKeyListener(l: KeyListener)
Link copied to clipboard
open override fun removeMouseListener(l: MouseListener)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun removeNotify()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Updates the layer and redraws synchronously.

Link copied to clipboard
open fun repaint()
open fun repaint(tm: Long)
open fun repaint(x: Int, y: Int, width: Int, height: Int)
open fun repaint(tm: Long, x: Int, y: Int, width: Int, height: Int)
open fun repaint(r: Rectangle?)
Link copied to clipboard
Link copied to clipboard
open fun requestFocus(temporary: Boolean): Boolean
open override fun requestFocus()
open override fun requestFocus(cause: FocusEvent.Cause?)
Link copied to clipboard
open override fun requestFocusInWindow(): Boolean
open override fun requestFocusInWindow(cause: FocusEvent.Cause?): Boolean
Link copied to clipboard
Link copied to clipboard
open override fun reshape(x: Int, y: Int, w: Int, h: Int)
Link copied to clipboard
open fun resize(d: Dimension?)
open fun resize(width: Int, height: Int)
Link copied to clipboard
open fun revalidate()
Link copied to clipboard
Link copied to clipboard
open fun scrollRectToVisible(aRect: Rectangle?)
Link copied to clipboard
open override fun setBackground(bg: Color?)
Link copied to clipboard
open fun setComponentZOrder(comp: Component?, index: Int)
Link copied to clipboard
open override fun setFocusable(focusable: Boolean)
Link copied to clipboard
open fun setFocusTraversalKeys(id: Int, keystrokes: Set<out AWTKeyStroke?>?)
Link copied to clipboard
open override fun setFocusTraversalKeysEnabled(focusTraversalKeysEnabled: Boolean)
Link copied to clipboard
fun setInputMap(condition: Int, map: InputMap?)
Link copied to clipboard
open fun setMixingCutoutShape(shape: Shape?)
Link copied to clipboard
open fun show()
open fun show(b: Boolean)
Link copied to clipboard
open fun size(): Dimension?
Link copied to clipboard
open fun transferFocus()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun unregisterKeyboardAction(aKeyStroke: KeyStroke?)
Link copied to clipboard
open fun update(g: Graphics?)
Link copied to clipboard
open fun updateUI()
Link copied to clipboard
open fun validate()