Skip to content

UI.Checkbox

Name Mandatory Description Default Type
⬅️ Input The value is ignored. None
Output ➡️ Indicates whether the checkbox state changed during this frame. Bool
Label No The text label of this checkbox. none StringNone
Variable No The variable that holds the input value. none BoolVar(Bool)None
Style No The text style. none {Any}Var({Any})

Boolean on/off widget with text label.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
// Simple checkbox
GFX.MainWindow(Contents: {
  // Setup
  GFX.DrawQueue = ui-draw-queue
  GFX.UIPass(ui-draw-queue) >> render-steps

  // UI
  UI({
    UI.CentralPanel({
      UI.Checkbox(
        Label: "Checked"
        Variable: checked
      )
    })
  })

  UI.Render(ui-draw-queue)

  GFX.Render(Steps: render-steps)
})

[warning] Context has 2 buffers at release (2 released, 2 kept)
[warning] Context has 5 textures at release (1 released, 5 kept)
 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
// Styled checkbox
GFX.MainWindow(Contents: {
  // Setup
  GFX.DrawQueue = ui-draw-queue
  GFX.UIPass(ui-draw-queue) >> render-steps

  // UI
  UI({
    UI.CentralPanel({
      UI.Checkbox(
        Label: "Checked"
        Style: {color: @color(255 0 255) italics: true}
        Variable: checked
      )
    })
  })

  UI.Render(ui-draw-queue)

  GFX.Render(Steps: render-steps)
})

[warning] Context has 2 buffers at release (2 released, 2 kept)
[warning] Context has 5 textures at release (1 released, 5 kept)