Crate flatbox_egui

Modules

• backend
• command
• containers
  Containers are pieces of the UI which wraps other pieces of UI. Examples: Window, ScrollArea, Resize, SidePanel, etc.
• epaint
  A simple 2D graphics library for turning simple 2D shapes and text into textured triangles.
• introspection
  Showing UI:s for egui/epaint types.
• layers
  Handles paint layers, i.e. how things are sometimes painted behind or in front of other things.
• menu
  Menu bar functionality (very basic so far).
• output
  All the data egui returns to the backend at the end of each frame.
• painter
• special_emojis
  The default egui fonts supports around 1216 emojis in total. Here are some of the most useful: ∞⊗⎗⎘⎙⏏⏴⏵⏶⏷ ⏩⏪⏭⏮⏸⏹⏺■▶📾🔀🔁🔃 ☀☁★☆☐☑☜☝☞☟⛃⛶✔ ↺↻⟲⟳⬅➡⬆⬇⬈⬉⬊⬋⬌⬍⮨⮩⮪⮫ ♡ 📅📆 📈📉📊 📋📌📎📤📥🔆 🔈🔉🔊🔍🔎🔗🔘 🕓🖧🖩🖮🖱🖴🖵🖼🗀🗁🗋🗐🗑🗙🚫❓
• style
  egui theme (spacing, colors, etc).
• text
• util
  Miscellaneous tools used by the rest of egui.
• widget_text
• widgets
  Widgets are pieces of GUI such as Label, Button, Slider etc.

Macros

• egui_assert
  An assert that is only active when egui is compiled with the extra_asserts feature or with the extra_debug_asserts feature in debug builds.
• github_link_file
  Create a Hyperlink to the current file!() on github.
• github_link_file_line
  Create a Hyperlink to the current file!() (and line) on Github
• trace
  Show debug info on hover when Context::set_debug_on_hover has been turned on.

Structs

• Align2
  Two-dimension alignment, e.g. Align2::LEFT_TOP.
• Area
  An area on the screen that can be moved by dragging.
• Button
  Clickable button with text.
• CentralPanel
  A panel that covers the remainder of the screen, i.e. whatever area is left after adding other panels.
• Checkbox
  Boolean on/off control with text label.
• ClippedPrimitive
  A Mesh or PaintCallback within a clip rectangle.
• CollapsingHeader
  A header which can be collapsed/expanded, revealing a contained Ui region.
• CollapsingResponse
  The response from showing a CollapsingHeader.
• Color32
  This format is used for space-efficient color representation (32 bits).
• ColorImage
  A 2D RGBA color image in RAM.
• ComboBox
  A drop-down selection menu with a descriptive label.
• Context
  Your handle to egui.
• DragValue
  A numeric value that you can change by dragging the number. More compact than a Slider.
• DroppedFile
  A file dropped into egui.
• FontData
  A .ttf or .otf file and a font face index.
• FontDefinitions
  Describes the font data and the sizes to use.
• FontId
  How to select a sized font.
• FontImage
  A single-channel image designed for the font texture.
• FontTweak
  Extra scale and vertical tweak to apply to all text of a certain font.
• Frame
  Add a background, frame and/or margin to a rectangular background of a Ui.
• FullOutput
  What egui emits each frame from crate::Context::run.
• Galley
  Text that has been layed out, ready for painting.
• Grid
  A simple grid layout.
• HoveredFile
  A file about to be dropped into egui.
• Hyperlink
  A clickable hyperlink, e.g. to "https://github.com/emilk/egui".
• Id
  egui tracks widgets frame-to-frame using Ids.
• Image
  An widget to show an image of a given size.
• ImageButton
  A clickable image within a frame.
• InnerResponse
  Returned when we wrap some ui-code and want to return both the results of the inner function and the ui as a whole, e.g.:
• InputState
  Input state that egui updates each frame.
• Label
  Static text.
• LayerId
  An identifier for a paint layer. Also acts as an identifier for Area:s.
• Layout
  The layout of a Ui, e.g. “vertical & centered”.
• Link
  Clickable text, that looks like a hyperlink.
• Memory
  The data that egui persists between frames.
• Mesh
  Textured triangles in two dimensions.
• Modifiers
  State of the modifier keys. These must be fed to egui.
• MultiTouchInfo
  All you probably need to know about a multi-touch gesture.
• PaintCallback
  If you want to paint some 3D shapes inside an egui region, you can use this.
• PaintCallbackInfo
  Information passed along with PaintCallback (Shape::Callback).
• Painter
  Helper to paint shapes and text to a specific region on a specific layer.
• PlatformOutput
  The non-rendering part of what egui emits each frame.
• PointerState
  Mouse or touch state.
• Pos2
  A position on screen.
• ProgressBar
  A simple progress bar.
• RadioButton
  One out of several alternatives, either selected or not.
• RawInput
  What the integrations provides to egui at the start of each frame.
• Rect
  A rectangular region of space.
• Resize
  A region that can be resized by dragging the bottom right corner.
• Response
  The result of adding a widget to a Ui.
• Rgba
  0-1 linear space RGBA color with premultiplied alpha.
• RichText
  Text and optional style choices for it.
• Rounding
  How rounded the corners of things should be
• ScrollArea
  Add vertical and/or horizontal scrolling to a contained Ui.
• SelectableLabel
  One out of several alternatives, either selected or not. Will mark selected items with a different background color. An alternative to RadioButton and Checkbox.
• Sense
  What sort of interaction is a widget sensitive to?
• Separator
  A visual separator. A horizontal or vertical line (depending on Layout).
• SidePanel
  A panel that covers the entire left or right side of a Ui or screen.
• Slider
  Control a number with a slider.
• Spinner
  A spinner widget used to indicate loading.
• Stroke
  Describes the width and color of a line.
• Style
  Specifies the look and feel of egui.
• TextEdit
  A text region that the user can edit the contents of.
• TextFormat
• TextureHandle
  Used to paint images.
• TexturesDelta
  What has been allocated and freed during the last period.
• TopBottomPanel
  A panel that covers the entire top or bottom of a Ui or screen.
• TouchDeviceId
  this is a u64 as values of this kind can always be obtained by hashing
• TouchId
  Unique identification of a touch occurrence (finger or pen or …). A Touch ID is valid until the finger is lifted. A new ID is used for the next touch.
• Ui
  This is what you use to place widgets.
• Vec2
  A vector has a direction and length. A Vec2 is often used to represent a size.
• Visuals
  Controls the visual style (colors etc) of egui.
• WidgetInfo
  Describes a widget such as a crate::Button or a crate::TextEdit.
• Window
  Builder for a floating window which can be dragged, closed, collapsed, resized and scrolled (off by default).

Enums

• Align
  left/center/right or top/center/bottom alignment for e.g. anchors and layouts.
• CursorIcon
  A mouse cursor icon.
• Direction
  Layout direction, one of LeftToRight, RightToLeft, TopDown, BottomUp.
• Event
  An input event generated by the integration.
• FontFamily
  Font of unknown size.
• FontSelection
  A way to select FontId, either by picking one directly or by using a TextStyle.
• ImageData
  An image stored in RAM.
• Key
  Keyboard keys.
• Order
  Different layer categories
• PointerButton
  Mouse button (or similar for touch input)
• Shape
  A paint primitive such as a circle or a piece of text. Coordinates are all screen space points (not physical pixels).
• SliderOrientation
  Specifies the orientation of a Slider.
• TextStyle
  Alias for a FontId (font of a certain size).
• TextureFilter
  How the texture texels are filtered.
• TextureId
  What texture to use in a Mesh mesh.
• TouchPhase
  In what phase a touch event is in.
• WidgetText
  This is how you specify text for a widget.
• WidgetType
  The different types of built-in widgets in egui

Constants

• NUM_POINTER_BUTTONS
  Number of pointer buttons supported by egui, i.e. the number of possible states of PointerButton.

Traits

• NumExt
  Extends f32, Vec2 etc with at_least and at_most as aliases for max and min.
• TextBuffer
  Trait constraining what types crate::TextEdit may use as an underlying buffer.
• Widget
  Anything implementing Widget can be added to a Ui with Ui::add.
• WidgetWithState
  Helper so that you can do TextEdit::State::read…

Functions

• __run_test_ctx
  For use in tests; especially doctests.
• __run_test_ui
  For use in tests; especially doctests.
• global_dark_light_mode_buttons
  Show larger buttons for switching between light and dark mode (globally).
• global_dark_light_mode_switch
  Show a small button to switch to/from dark/light mode (globally).
• lerp
  Linear interpolation.
• popup_below_widget
  Shows a popup below another widget.
• pos2
  pos2(x, y) == Pos2::new(x, y)
• remap
  Linearly remap a value from one range to another, so that when x == from.start() returns to.start() and when x == from.end() returns to.end().
• remap_clamp
  Like remap, but also clamps the value so that the returned value is always in the to range.
• reset_button
  Show a button to reset a value to its default. The button is only enabled if the value does not already have its original value.
• reset_button_with
  Show a button to reset a value to its default. The button is only enabled if the value does not already have its original value.
• show_tooltip
  Show a tooltip at the current pointer position (if any).
• show_tooltip_at
  Show a tooltip at the given position.
• show_tooltip_at_pointer
  Show a tooltip at the current pointer position (if any).
• show_tooltip_for
  Show a tooltip under the given area.
• show_tooltip_text
  Show some text at the current pointer position (if any).
• stroke_ui
• vec2
  vec2(x, y) == Vec2::new(x, y)
• warn_if_debug_build
  Helper function that adds a label when compiling with debug assertions enabled.

Type Aliases

• IconPainter
  A function that paints the ComboBox icon
• IdMap
  IdMap<V> is a HashMap<Id, V> optimized by knowing that Id has good entropy, and doesn’t need more hashing.