Skip to content

UI.Frame

Name Mandatory Description Default Type
⬅️ Input The value that will be passed to the Contents shards of the frame. Any
Output ➡️ The output of this shard will be its input. Any
Contents No The UI contents. none NoneShard[Shard]
InnerMargin No The margin inside the frame, between the outline and the contents. none Float4
OuterMargin No The margin outside the frame. none Float4
Rounding No Rounding radiuses for the corners. none Float4
FillColor No The color filling the background of the frame. none ColorVar(Color)None
StrokeColor No The color for the frame outline. none ColorVar(Color)None
StrokeWidth No The width of the frame outline. none Float

Visually groups the contents together.

Examples

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

  // UI
  UI({
    UI.CentralPanel({
      UI.Frame(
        InnerMargin: @f4(10 10 10 10)
        OuterMargin: @f4(0 0 0 0)
        Rounding: @f4(5 5 5 5)
        FillColor: @color(50 50 21)
        StrokeColor: @color(250 250 32)
        StrokeWidth: 2.0
        Contents: {
          "Frame content" | UI.Label
        }
      )
    })
  })

  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)