Skip to content

Overlay flags

Overlay flags are used by functions such as ui.crDisplayRect() to control options for displaying the overlay.

For example, to make FL Studio highlight channel names and mute buttons, and scroll to the selected channels:

import ui
import midi

ui.crDisplayRect(
    0, 1, 1, 3,
    2000,
    flags=midi.CR_HighlightChannelName
    | midi.CR_ScrollToView
    | midi.CR_HighlightChannelMute
)

CR_HighlightChannels module-attribute 

CR_HighlightChannels = 1

When specified, ui.crDisplayRect() highlights channel buttons.

CR_ScrollToView module-attribute 

CR_ScrollToView = 1 << 1

When specified, ui.crDisplayRect() scrolls so that the given area is visible.

CR_HighlightChannelMute module-attribute 

CR_HighlightChannelMute = 1 << 2

When specified, ui.crDisplayRect() highlights channel mute buttons.

CR_HighlightChannelPanVol module-attribute 

CR_HighlightChannelPanVol = 1 << 3

When specified, ui.crDisplayRect() highlights channel pan and volume.

CR_HighlightChannelTrack module-attribute 

CR_HighlightChannelTrack = 1 << 4

When specified, ui.crDisplayRect() highlights target mixer track controls.

CR_HighlightChannelName module-attribute 

CR_HighlightChannelName = 1 << 5

When specified, ui.crDisplayRect() highlights channel names.

CR_HighlightChannelSelect module-attribute 

CR_HighlightChannelSelect = 1 << 6

When specified, ui.crDisplayRect() highlights channel selection buttons.

MI_ScrollToView module-attribute 

MI_ScrollToView = 1 << 1

When specified, ui.miDisplayRect() scrolls so that the given mixer tracks are visible.