Crate imgui

Source

Re-exports§

pub extern crate imgui_sys as sys;
pub use self::color::ImColor32;
pub use self::drag_drop::DragDropFlags;
pub use self::drag_drop::DragDropSource;
pub use self::drag_drop::DragDropTarget;
pub use self::draw_list::ChannelsSplit;
pub use self::draw_list::DrawListMut;
pub use self::text_filter::*;

Modules§

color
drag_drop
Structs to create a Drag and Drop sequence. Almost all structs are re-exported and can be accessed from the crate root; some additional utilities can be found in here.
draw_list
The draw list lets you create custom graphics within a window.
internal
Internal raw utilities (don’t use unless you know what you’re doing!)
text_filter

Macros§

create_token
This is a macro used internally by imgui-rs to create StackTokens representing various global state in DearImGui.

Structs§

AngleSlider
Builder for an angle slider widget.
BackendFlags
Backend capabilities
ButtonFlags
Flags for invisible buttons
ChildWindow
Builder for a child window
ChildWindowToken
Tracks a child window that can be ended by calling .end() or by dropping
CollapsingHeader
Builder for a collapsing header widget
ColorButton
Builder for a color button widget.
ColorEdit3
Builder for a color editor widget.
ColorEdit4
Builder for a color editor widget.
ColorEditFlags
Color edit flags
ColorPicker3
Builder for a color picker widget.
ColorPicker4
Examples
ColorStackToken
Tracks a color pushed to the color stack that can be popped by calling .end() or by dropping.
ComboBox
Builder for a combo box widget
ComboBoxFlags
Flags for combo boxes
ComboBoxToken
Tracks a combo box that can be ended by calling .end() or by dropping.
ConfigFlags
Configuration flags
Context
An imgui-rs context.
DisabledToken
Starts a scope where interaction is disabled. Ends be calling .end() or when the token is dropped.
Drag
Builder for a drag slider widget.
DragRange
Builder for a drag slider widget.
DrawCmdIterator
DrawCmdParams
DrawData
All draw data to render a Dear ImGui frame.
DrawList
Draw command list
DrawListIterator
Iterator over draw lists
DrawVert
A single vertex
DummyClipboardContext
Non-functioning placeholder
Font
Runtime data for a single font within a font atlas
FontAtlas
A font atlas that builds a single texture
FontAtlasFlags
Font atlas configuration flags
FontAtlasTexture
Handle to a font atlas texture
FontConfig
Configuration settings for a font
FontGlyph
A single font glyph
FontGlyphRanges
A set of Unicode codepoints
FontId
A font identifier
FontStackToken
Tracks a font pushed to the font stack that can be popped by calling .end() or by dropping.
GroupToken
Tracks a layout group that can be ended with end or by dropping.
Id
Unique ID used by widgets.
IdStackToken
Tracks an ID pushed to the ID stack that can be popped by calling .pop() or by dropping. See crate::Ui::push_id for more details.
ImStr
A UTF-8 encoded, implicitly nul-terminated string slice.
ImString
A UTF-8 encoded, growable, implicitly nul-terminated string.
Image
Builder for an image widget
ImageButton
Builder for an image button widget
ImageButtonDeprecated
InputFloat
InputFloat2
InputFloat3
InputFloat4
InputInt
InputInt2
InputInt3
InputInt4
InputScalar
Builder for an input scalar widget.
InputScalarN
Builder for an input scalar widget.
InputText
InputTextCallback
Callback flags for an InputText widget. These correspond to the general textflags.
InputTextFlags
Flags for text inputs
InputTextMultiline
InputTextMultilineCallback
Callback flags for an InputTextMultiline widget. These correspond to the general textflags.
InvalidStyleColorValue
Io
Settings and inputs/outputs for imgui-rs
ItemFlagsStackToken
Tracks a change pushed to the item flags stack.
ItemHoveredFlags
Item hover check option flags
ItemWidthStackToken
ListBox
Builder for a list box widget
ListBoxToken
Tracks a list box that can be ended by calling .end() or by dropping
ListClipper
Used to render only the visible items when displaying a long list of items in a scrollable area.
MainMenuBarToken
Tracks a main menu bar that can be ended by calling .end() or by dropping
MenuBarToken
Tracks a menu bar that can be ended by calling .end() or by dropping
MenuItem
Builder for a menu item.
MenuToken
Tracks a menu that can be ended by calling .end() or by dropping
OwnedDrawData
A container for a heap-allocated deep copy of a DrawData struct.
PassthroughCallback
This is a Zst which implements TextCallbackHandler as a passthrough.
PlatformIo
Holds the information needed to enable multiple viewports.
PlatformMonitor
Describes a monitor that can be used by ImGui.
PlotHistogram
PlotLines
PopupModal
Create a modal pop-up.
PopupToken
Tracks a popup token that can be ended with end or by dropping.
ProgressBar
Builder for a progress bar widget.
PushAllowKeyboardFocusToken
PushButtonRepeatToken
Selectable
Builder for a selectable widget.
SelectableFlags
Flags for selectables
SharedFontAtlas
A font atlas that can be shared between contexts
Slider
Builder for a slider widget.
SliderFlags
Flags for sliders
Specs
A wrapper around a slice of TableColumnSortSpecs.
Style
User interface style/colors
StyleStackToken
Tracks a style pushed to the style stack that can be popped by calling .end() or by dropping.
SuspendedContext
A suspended imgui-rs context.
TabBar
Builder for a tab bar.
TabBarFlags
TabBarToken
Tracks a window that can be ended by calling .end() or by dropping
TabItem
TabItemFlags
TabItemToken
Tracks a tab bar item that can be ended by calling .end() or by dropping
TableBgTarget
Enum for [table_set_bg_color]. Background colors are rendering in 3 layers:
TableColumnFlags
Flags for TableColumnSetup and [table_setup_column_with].
TableColumnSetup
A struct containing all the data needed to setup a table column header via begin_table_header or table_setup_column.
TableColumnSortSpecs
TableFlags
Flags passed to begin_table methods.
TableRowFlags
Flags for [table_next_row_with_flags].
TableSortSpecsMut
A wrapper around table sort specs.
TableToken
Tracks a table which can be rendered onto, ending with .end() or by dropping.
TextCallbackData
This struct provides methods to edit the underlying text buffer that Dear ImGui manipulates. Primarily, it gives remove_chars, insert_chars, and mutable access to what text is selected.
TextWrapPosStackToken
TextureId
An opaque texture identifier
Textures
Generic texture mapping for use by renderers.
TooltipToken
Tracks a layout tooltip that can be ended by calling .end() or by dropping.
TreeNode
Builder for a tree node widget
TreeNodeFlags
Flags for tree nodes
TreeNodeToken
Tracks a tree node that can be popped by calling .pop(), end(), or by dropping.
Ui
A reference for building the user interface for one frame
UiBuffer
this is the unsafe cell upon which we build our abstraction.
VerticalSlider
Builder for a vertical slider widget.
Viewport
Describes an ImGui Viewport.
ViewportFlags
Window
Builder for a window
WindowFlags
Configuration flags for windows
WindowFocusedFlags
Window focus check option flags
WindowHoveredFlags
Window hover check option flags
WindowToken
Tracks a window that can be ended by calling .end() or by dropping.

Enums§

ColorEditDisplayMode
Color editor display mode.
ColorEditInputMode
Color editor input mode.
ColorFormat
Color component formatting
ColorPickerMode
Color picker hue/saturation/value editor mode
ColorPreview
Color editor preview style
ComboBoxHeight
Combo box height mode.
ComboBoxPreviewMode
Combo box preview mode.
Condition
Condition for applying a setting
Direction
A cardinal direction
DrawCmd
A draw command
FocusedWidget
Target widget selection for keyboard focus
FontSource
A source for binary font data
HistoryDirection
The arrow key a user pressed to trigger the on_history callback.
ItemFlag
A temporary change in item flags
Key
A key identifier
MouseButton
Represents one of the supported mouse buttons
MouseCursor
Mouse cursor type identifier
NavInput
An input identifier for navigation
StyleColor
A color identifier for styling.
StyleVar
A temporary change in user interface style
TableSortDirection
TreeNodeId
Unique ID used by tree nodes

Traits§

ClipboardBackend
Trait for clipboard backends
InputTextCallbackHandler
This trait provides an interface which ImGui will call on InputText and InputTextMultiline callbacks.
PlatformViewportBackend
Trait holding functions needed when the platform integration supports viewports.
RendererViewportBackend
Trait that holds optional functions for a rendering backend to support multiple viewports.

Functions§

dear_imgui_version
Returns the underlying Dear ImGui library version

Type Aliases§

DrawIdx
A vertex index