Skip to content

gnoblin.configure.compositor ​

Configure this part of gnoblin.configure with the compositor key.

Put these fields inside gnoblin.configure {compositor = {...}}. Changes apply on configuration reload. Omitted values keep the defaults shown below.

KeyValuesDefaultEffect
enable_animationsBooleantrueEnables compositor animations.
locate_pointerBooleanfalseEnables the pointer-location effect.
visual_bellBooleanfalseFlashes the screen when an app requests the visual bell.
audible_bellBooleantruePlays a sound when an app requests the audible bell.
visual_bell_type"fullscreen-flash" or "frame-flash""fullscreen-flash"Flash the full screen or the focused window.

For example, enable the pointer locator and use a focused-window flash:

lua
gnoblin.configure {
    compositor = {
        locate_pointer = true,
        visual_bell = true,
        visual_bell_type = "frame-flash",
    },
}

Guide: session settings.

Type definition ​

The block below is schema pseudocode in Lua table form. ? marks an optional field, and | separates accepted alternatives.

lua
gnoblin.configure {
    compositor = {
        enable_animations = boolean?,
        locate_pointer = boolean?,
        visual_bell = boolean?,
        audible_bell = boolean?,
        visual_bell_type = "fullscreen-flash" | "frame-flash"?,
    },
}