Masks control how an item’s area interacts with the content behind it. They are applied per-item in the FX tab and determine whether (and how) the wallpaper background is visible through the item.
Default. The item renders normally with no background interaction.
Available since version 3.82
Shaders are GPU-powered visual effects that transform how layers and items look in real time. They can be applied in two ways:
Both paths use the same shader library and parameters.
| Formula | Description |
|---|---|
| $df("hh:mma", ai(sunrise))$ | Today's sunrise in hh:mm format |
| $df("hh:mma", ai(sunset))$ | Today's sunset in hh:mm format |
| $ai(isday)$ | Will return 1 during daylight or 0 if night |
| $tf(ai(nsunrise))$ | Time to next sunrise |
| $tf(ai(nsunset))$ | Time to next sunset |
| $ai(mphase)$ | Current Moon phase name |
| $ai(zodiac)$ | Current Zodiac sign name |
| $ai(season)$ | Current Season name |
| $ai(mage)$ | Current Moon age |
| $ai(mill)$% | Current Moon illumination (in percentage) |
| $df("hh:mma", ai(moonrise))$ | Moon rise |
| $ai(moonrise, a1d)$ | Moon rise for tomorrow |
| $df("hh:mma", ai(moonset))$ | Moon set |
| $ai(moonrise, r2d)$ | Moon set 2 days ago |
| $df("hh:mma", ai(csunrise))$ | Today's civil sunrise in hh:mm format |
| $df("hh:mma", ai(csunset))$ | Today's civil sunset in hh:mm format |
| $df("hh:mma", ai(usunrise))$ | Today's nautical sunrise in hh:mm format |
| $df("hh:mma", ai(usunset))$ | Today's nautical sunset in hh:mm format |
| $df("hh:mma", ai(asunrise))$ | Today's astronomical sunrise in hh:mm format |
| $df("hh:mma", ai(asunset))$ | Today's astronomical sunset in hh:mm format |
| $ai(mphasec)$ | Current Moon phase code, one of: NEW, WAXING_CRESCENT, FIRST_QUARTER, WAXING_GIBBOUS, FULL, WANING_GIBBOUS, THIRD_QUARTER, WANING_CRESCENT |
| $ai(zodiacc)$ | Current Zodiac sign code, one of: ARIES, TAURUS, GEMINI, CANCER, LEO, VIRGO, LIBRA, SCORPIO, SAGITTARIUS, CAPRICORN, AQUARIUS, PISCES |
| $ai(seasonc)$ | Current Season code, one of: SPRING, SUMMER, AUTUMN, WINTER |
| Formula | Description |
|---|---|
| $aq(index)$ | Air quality index (0 = best, 400 = worst) |
| $aq(label)$ | Air quality level label |
| $aq(level)$ | Air quality level, one of:: NA, GOOD, MODERATE, UNHEALTHY_FOR_SENSITIVE, UNHEALTHY, VERY_UNHEALTHY, HAZARDOUS |
| $aq(no2)$ | Average No2 (µg/m³) |
| $aq(pm10)$ | Average PM10 (µg/m³) |
| $aq(pm25)$ | Average PM25 (µg/m³) |
| $aq(station)$ | Data station ID |
| $aq(source)$ | Name of the data source |
| $tf(aq(updated))$ | Last data check in hh:mm format |
| $tf(aq(collected))$ | Time of data measurement in hh:mm format |
| Formula | Description |
|---|---|
| $bi(level)$% | Battery Level (in %) |
| $bi(temp)$°$wi(tempu)$ | Battery Temperature in local unit |
| $bi(tempc)$ | Battery Temperature in celsius |
| $bi(volt)$ | Battery voltage in millivolts |
| $bi(charging)$ | Will return 0 if on battery, 1 if charging |
| $bi(fast)$ | Will return 1 if fast charging, 0 otherwise (Android 5.x or better only) |
| $bi(source)$ | Current power source (Battery, AC, USB or Wireless) |
| $df("hh:mma", bi(plugged))$ | Date of last plugged / unplugged event |
| $bi(current)$ | Realtime charging/discharging current in milliampere |
| $if(bi(charging) = 0, "unplugged", "plugged")$ $tf(bi(plugged))$ | Time since last plugged / unplugged event |
| $df("hh:mma", bi(fullempty))$ | Date of expected next charged/discharged event |
| $if(bi(charging) = 0, discharged, charged)$ $tf(bi(fullempty))$ | Time to next expected charged/discharged event |
| $if(bi(charging) = 0, Discharged, Full)$$if(bi(charging) = 0 | bi(level) < 100, " in " + tf(bi(fullempty) - dp()))$ | Alternate time to next expected charged/discharged event with relative time |
| $bi(level, r30m)$% | Battery Level (in %) 30 minutes ago |
| $bi(source, r1h)$ | Battery Source 1 hour ago |
| $bi(temp, r2h)$°$wi(tempu)$ | Battery Temp 2 hours ago |
| Formula | Description |
|---|---|
| $bp(muted, mi(cover))$ | Extract muted color from cover art |
| $bp(vibrant, mi(cover))$ | Extract vibrant color from cover art |
| $bp(dominant, mi(cover))$ | Extract dominant color from cover art |
| $bp(mutedbc, mi(cover))$ | Extract muted body text color from cover art |
| $bp(vibrantbc, mi(cover))$ | Extract vibrant body text color from cover art |
| $bp(mutedtc, mi(cover))$ | Extract muted title text color from cover art |
| $bp(vibranttc, mi(cover))$ | Extract vibrant title text color from cover art |
| $bp(dmuted, mi(cover))$ | Extract muted dark color from cover art |
| $bp(dvibrant, mi(cover))$ | Extract vibrant dark color from cover art |
| $bp(dmutedbc, mi(cover))$ | Extract muted dark body text color from cover art |
| $bp(dvibrantbc, mi(cover))$ | Extract vibrant dark body text color from cover art |
| $bp(dmutedtc, mi(cover))$ | Extract muted dark title text color from cover art |
| $bp(dvibranttc, mi(cover))$ | Extract vibrant dark title text color from cover art |
| $bp(lmuted, mi(cover))$ | Extract muted light color from cover art |
| $bp(lvibrant, mi(cover))$ | Extract vibrant light color from cover art |
| $bp(lmutedbc, mi(cover))$ | Extract muted light body text color from cover art |
| $bp(lvibrantbc, mi(cover))$ | Extract vibrant light body text color from cover art |
| $bp(lmutedtc, mi(cover))$ | Extract muted light title text color from cover art |
| $bp(lvibranttc, mi(cover))$ | Extract vibrant light title text color from cover art |
| $bp(dominanttc, mi(cover))$ | Extract dominant title text color from cover art |
| $bp(dominantbc, mi(cover))$ | Extract dominant body text color from cover art |
| Formula | Description |
|---|---|
| $br(kwgt, FOOBAR)$ | Will write the value of variable FOOBAR sent from Kustom Widget Flow |
| $br(tasker, FOOBAR)$ | Will write the value of variable FOOBAR sent from Tasker action plugin |
| $br(zooper, FOOBAR)$ | Will write the value of variable FOOBAR sent to Zooper from Tasker or third party plugins (equivalent in Zooper would be #TFOOBAR#) |
| $br(remote, FOOBAR)$ | Will write the value of variable FOOBAR sent to Kustom via remote message (see remote token in advanced settings) |
| Formula | Description |
|---|---|
| $cd(1, stext)$ | First complication small text |
| $cd(2, ltext)$ | Second complication long text if available |
| $cd(3, icon)$ | Third complication icon |
| $cd(1, rval)$ | First complication ranged value |
| $cd(1, rmin)$ | First complication ranged min value |
| $cd(1, rmax)$ | First complication ranged max value |
| $cd(1, simg)$ | First complication small image |
| $cd(0, limg)$ | Background complication large image |
| $cd(0, title)$ | First complication title if available |
| Formula | Description |
|---|---|
| $ce(#FF0000, invert)$ | Will invert RGB color |
| $ce(#FF0000, comp)$ | Will return complementary color |
| $ce(#FF0000, contrast)$ | Return either black or white depending on best contrast |
| $ce(#FF0000, alpha, 50)$ | Will make a fully opaque red into 50% transparent |
| $ce(#FF0000, sat, 0)$ | Will convert red color into Greyscale equivalent |
| $ce(#FF0000, lum, 50)$ | Will set red luminance to 50 |
| $ce(#FF0000, lum, a50)$ | Will add 50 to red luminance (0 to 100) |
| $ce(#FF0000, alpha, r50)$ | Will remove 50 from red alpha (0 to 255) |
| $ce(#FF0000, #FF0000, 50)$ | Mix half red and half blue (50% gradient) |
| Formula | Description |
|---|---|
| $df(EEE hh:mm, ci(start, 0))$-$df(hh:mm, ci(end, 0))$ $ci(title, 0)$ | Day start-end title of first upcoming event |
| $ci(title, 1)$ | Title of second upcoming event |
| $ci(desc, 1)$ | Description of second upcoming event or all day event (the first) |
| $df("hh:mma", ci(start, 0))$ | Start date of next upcoming event in HH:MM format |
| $ci(allday, 0)$ | Will write 1 if next upcoming event is allday, 0 otherwise |
| $ci(title, a0, a0d)$ | Title of today's first all day event |
| $ci(desc, e1, a0d)$ | Description of today's second event |
| $ci(loc, e1, a0d)$ | Location of today's second event |
| $ci(ccolor, e0, a1d)$ | Calendar Color of first event tomorrow |
| $ci(cname, a1, a1d)$ | Calendar Name of first all day event tomorrow |
| $df("hh:mma", ci(end, 0, a0d))$ | End date of second event today in HH:MM format |
| $ci(color, 1, a1d)$ | Color of second event tomorrow |
| $ci(ecount, a0d)$ | Number of appointments today |
| $ci(acount, a1d)$ | Number of all day events tomorrow |
| $ci(url, 0)$ | Url of first event today (to be used in Touch, open Url action) |
| $ci(urld, 0)$ | Open calendar at first event time (to be used in Touch, open Url action) |