KiteConfig/io.github.yuroyami.kiteconfig/KiteDesktopLogoScope

KiteDesktopLogoScope

abstract class KiteDesktopLogoScope : KiteLogoScope

Desktop's logo details, inside kiteConfig { desktop { logo { ... } } }.

Everything in KiteLogoScope applies here too, plus the macOS shape.

Constructors

KiteDesktopLogoScope

constructor()

Properties

abstract val background: Property<LogoBackground>

What sits behind foreground: color("#102A43") or image(file("bg.png")).

abstract val enabled: Property<Boolean>

Deliver the icon to this platform. Default: on once foreground is set.

abstract val foreground: RegularFileProperty

PNG holding the artwork that sits on top: your mark, your glyph.

foregroundScale

abstract val foregroundScale: Property<Double>

How much of the icon canvas the foreground may fill, as a ratio in 0 < s <= 1.

abstract val overlay: RegularFileProperty

PNG drawn on top of foreground, at the same size and position, with the same mask. Use the same width and height as the foreground, transparent everywhere except what you add, such as a ribbon in one corner. A PNG of a different shape is centered, so a corner ribbon would move.

abstract val roundMac: Property<Boolean>

Round the generated macOS icon. Default: true, the macOS style.

Functions

fun color(hex: String): LogoBackground

A solid plate behind the mark.

fun image(file: File): LogoBackground

A PNG behind the mark.

fun image(file: RegularFile): LogoBackground

A PNG behind the mark, from a Gradle file provider.