RaylibGuiModuleBase<R extends RaylibBase, ColorStructType extends ColorBase<ColorStructType>, FontStructType extends FontBase<FontStructType, TextureStructType, RectangleStructType, GlyphInfoStructType, ImageStructType>, GlyphInfoStructType extends GlyphInfoBase<GlyphInfoStructType, ImageStructType>, ImageStructType extends ImageBase<ImageStructType>, MatrixStructType extends MatrixBase<MatrixStructType, Vector3StructType, QuaternionStructType, Vector4StructType>, QuaternionStructType extends QuaternionBase<QuaternionStructType, MatrixStructType, Vector3StructType, Vector4StructType>, RectangleStructType extends RectangleBase<RectangleStructType>, TextureStructType extends TextureBase<TextureStructType>, Vector2StructType extends Vector2Base<Vector2StructType, MatrixStructType, Vector3StructType, QuaternionStructType, Vector4StructType>, Vector3StructType extends Vector3Base<Vector3StructType, MatrixStructType, QuaternionStructType, Vector4StructType>, Vector4StructType extends Vector4Base<Vector4StructType, QuaternionStructType, MatrixStructType, Vector3StructType>> class abstract

Backend-agnostic contract for the Raylib Gui module.

Concrete platform implementations mix in or extend this to provide the full Core API surface across different backends.

Inheritance

• Object
• RaylibModule<R>
• RaylibGuiModuleBase

Mixed-in types

• RaylibGuiModuleExtras<R>

Constructors

RaylibGuiModuleBase(R rl)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

RAYGUI_COLORBARALPHA_CHECKED_SIZE → int

See RaylibGuiConstants.RAYGUI_COLORBARALPHA_CHECKED_SIZE.

no setter, inherited

RAYGUI_GRID_ALPHA → double

See RaylibGuiConstants.RAYGUI_GRID_ALPHA.

no setter, inherited

RAYGUI_GROUPBOX_LINE_THICK → int

See RaylibGuiConstants.RAYGUI_GROUPBOX_LINE_THICK.

no setter, inherited

RAYGUI_ICON_DATA_ELEMENTS → int

See RaylibGuiConstants.RAYGUI_ICON_DATA_ELEMENTS.

no setter, inherited

RAYGUI_ICON_MAX_ICONS → int

See RaylibGuiConstants.RAYGUI_ICON_MAX_ICONS.

no setter, inherited

RAYGUI_ICON_MAX_NAME_LENGTH → int

See RaylibGuiConstants.RAYGUI_ICON_MAX_NAME_LENGTH.

no setter, inherited

RAYGUI_ICON_SIZE → int

See RaylibGuiConstants.RAYGUI_ICON_SIZE.

no setter, inherited

RAYGUI_ICON_TEXT_PADDING → int

See RaylibGuiConstants.RAYGUI_ICON_TEXT_PADDING.

no setter, inherited

RAYGUI_ICONS → List<int>

See RaylibGuiConstants.RAYGUI_ICONS.

no setter, inherited

RAYGUI_LINE_MARGIN_TEXT → int

See RaylibGuiConstants.RAYGUI_LINE_MARGIN_TEXT.

no setter, inherited

RAYGUI_LINE_TEXT_PADDING → int

See RaylibGuiConstants.RAYGUI_LINE_TEXT_PADDING.

no setter, inherited

RAYGUI_MAX_CONTROLS → int

See RaylibGuiConstants.RAYGUI_MAX_CONTROLS.

no setter, inherited

RAYGUI_MAX_LINE_BUFFER_SIZE → int

See RaylibGuiConstants.RAYGUI_MAX_LINE_BUFFER_SIZE.

no setter, inherited

RAYGUI_MAX_PROPS_BASE → int

See RaylibGuiConstants.RAYGUI_MAX_PROPS_BASE.

no setter, inherited

RAYGUI_MAX_PROPS_EXTENDED → int

See RaylibGuiConstants.RAYGUI_MAX_PROPS_EXTENDED.

no setter, inherited

RAYGUI_MAX_TEXT_LINES → int

See RaylibGuiConstants.RAYGUI_MAX_TEXT_LINES.

no setter, inherited

RAYGUI_MESSAGEBOX_BUTTON_HEIGHT → int

See RaylibGuiConstants.RAYGUI_MESSAGEBOX_BUTTON_HEIGHT.

no setter, inherited

RAYGUI_MESSAGEBOX_BUTTON_PADDING → int

See RaylibGuiConstants.RAYGUI_MESSAGEBOX_BUTTON_PADDING.

no setter, inherited

RAYGUI_MIN_MOUSE_WHEEL_SPEED → int

See RaylibGuiConstants.RAYGUI_MIN_MOUSE_WHEEL_SPEED.

no setter, inherited

RAYGUI_MIN_SCROLLBAR_HEIGHT → int

See RaylibGuiConstants.RAYGUI_MIN_SCROLLBAR_HEIGHT.

no setter, inherited

RAYGUI_MIN_SCROLLBAR_WIDTH → int

See RaylibGuiConstants.RAYGUI_MIN_SCROLLBAR_WIDTH.

no setter, inherited

RAYGUI_PANEL_BORDER_WIDTH → int

See RaylibGuiConstants.RAYGUI_PANEL_BORDER_WIDTH.

no setter, inherited

RAYGUI_SCROLLBAR_LEFT_SIDE → int

See RaylibGuiConstants.RAYGUI_SCROLLBAR_LEFT_SIDE.

no setter, inherited

RAYGUI_SCROLLBAR_RIGHT_SIDE → int

See RaylibGuiConstants.RAYGUI_SCROLLBAR_RIGHT_SIDE.

no setter, inherited

RAYGUI_TABBAR_ITEM_WIDTH → int

See RaylibGuiConstants.RAYGUI_TABBAR_ITEM_WIDTH.

no setter, inherited

RAYGUI_TEXTBOX_AUTO_CURSOR_COOLDOWN → int

See RaylibGuiConstants.RAYGUI_TEXTBOX_AUTO_CURSOR_COOLDOWN.

no setter, inherited

RAYGUI_TEXTBOX_AUTO_CURSOR_DELAY → int

See RaylibGuiConstants.RAYGUI_TEXTBOX_AUTO_CURSOR_DELAY.

no setter, inherited

RAYGUI_TEXTFORMAT_MAX_SIZE → int

See RaylibGuiConstants.RAYGUI_TEXTFORMAT_MAX_SIZE.

no setter, inherited

RAYGUI_TEXTINPUTBOX_BUTTON_HEIGHT → int

See RaylibGuiConstants.RAYGUI_TEXTINPUTBOX_BUTTON_HEIGHT.

no setter, inherited

RAYGUI_TEXTINPUTBOX_BUTTON_PADDING → int

See RaylibGuiConstants.RAYGUI_TEXTINPUTBOX_BUTTON_PADDING.

no setter, inherited

RAYGUI_TEXTINPUTBOX_HEIGHT → int

See RaylibGuiConstants.RAYGUI_TEXTINPUTBOX_HEIGHT.

no setter, inherited

RAYGUI_TEXTSPLIT_MAX_ITEMS → int

See RaylibGuiConstants.RAYGUI_TEXTSPLIT_MAX_ITEMS.

no setter, inherited

RAYGUI_TEXTSPLIT_MAX_TEXT_SIZE → int

See RaylibGuiConstants.RAYGUI_TEXTSPLIT_MAX_TEXT_SIZE.

no setter, inherited

RAYGUI_TOGGLEGROUP_MAX_ITEMS → int

See RaylibGuiConstants.RAYGUI_TOGGLEGROUP_MAX_ITEMS.

no setter, inherited

RAYGUI_VALUEBOX_MAX_CHARS → int

See RaylibGuiConstants.RAYGUI_VALUEBOX_MAX_CHARS.

no setter, inherited

RAYGUI_VERSION → String

See RaylibGuiConstants.RAYGUI_VERSION.

no setter, inherited

RAYGUI_VERSION_MAJOR → int

See RaylibGuiConstants.RAYGUI_VERSION_MAJOR.

no setter, inherited

RAYGUI_VERSION_MINOR → int

See RaylibGuiConstants.RAYGUI_VERSION_MINOR.

no setter, inherited

RAYGUI_VERSION_PATCH → int

See RaylibGuiConstants.RAYGUI_VERSION_PATCH.

no setter, inherited

RAYGUI_WINDOWBOX_STATUSBAR_HEIGHT → int

See RaylibGuiConstants.RAYGUI_WINDOWBOX_STATUSBAR_HEIGHT.

no setter, inherited

RaylibCaptureIds → RaylibGuiModuleCaptureIds

Capture ID generator for pointer slots allocated by this module.

final

RaylibDebugLabels → RaylibGuiModuleDebugLabels

Debug label generator for this module's function calls.

final

rl → R

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

debug(bool v) → void

Enables or disables debug logging for this module.

inherited

debugError(String message) → void

Logs message at error level if debug is enabled and message passes all filters.

inherited

debugFilter(bool filter(String)) → void

Adds a predicate that gates debug output. Only messages satisfying at least one filter are logged.

inherited

debugInfo(String message) → void

Logs message at info level if debug is enabled and message passes all filters.

inherited

debugTime(bool v) → void

Enables or disables per-call timing output alongside debug logs.

inherited

debugWarn(String message) → void

Logs message at warn level if debug is enabled and message passes all filters.

inherited

disableSync<T>(T f()) → T

Executes f with RaylibTempBase syncing temporarily disabled, restoring the previous sync state afterward.

inherited

dispose() → void

Calls all registered onDispose callbacks and clears them.

inherited

doLoad() → void

Ensures load is called exactly once, regardless of how many times doLoad is invoked.

inherited

GuiButton(RectangleStructType bounds, String? text) → int

Button control, returns true when clicked

GuiCheckBox(RectangleStructType bounds, String? text, bool checked) → (int, bool)

Check Box control, returns true when active

GuiColorBarAlpha(RectangleStructType bounds, num alpha) → (int, double)

Color Bar Alpha control

GuiColorBarHue(RectangleStructType bounds, num value) → (int, double)

Color Bar Hue control

GuiColorPanel(RectangleStructType bounds, ColorStructType color) → (int, ColorStructType)

Color Panel control

GuiColorPanelHSV(RectangleStructType bounds, [Vector3StructType? colorHsv]) → (int, Vector3StructType)

Color Panel control that updates Hue-Saturation-Value color value, used by GuiColorPickerHSV()

GuiColorPicker(RectangleStructType bounds, ColorStructType? color) → (int, ColorStructType)

Color Picker control (multiple color controls)

GuiColorPickerHSV(RectangleStructType bounds, [Vector3StructType? colorHsv]) → (int, Vector3StructType)

Color Picker control that avoids conversion to RGB on each call (multiple color controls)

GuiComboBox(RectangleStructType bounds, String? text, num active) → (int, int)

Combo Box control

GuiDisable() → void

Disable gui controls (global state

GuiDisableTooltip() → void

Disable gui tooltips (global state)

GuiDrawIcon(GuiIconName iconId, num posX, num posY, num pixelSize, ColorStructType color) → void

Draw icon using pixel size at specified position

GuiDropdownBox(RectangleStructType bounds, String? text, num active, bool editMode) → (int, int)

Dropdown Box control

GuiDummyRec(RectangleStructType bounds, String? text) → int

Dummy control for placeholders

GuiEnable() → void

Enable gui controls (global state)

GuiEnableTooltip() → void

Enable gui tooltips (global state)

GuiGetFont() → FontStructType

Get gui custom font (global state)

GuiGetIcons() → List<int>

Get raygui icons data

GuiGetState() → int

Get gui state (global state)

GuiGetStyle(GuiControl control, GuiProperty property) → int

Get one style property

GuiGetTextWidth(String? text) → int

Get text width considering gui style and icon size (if required)

GuiGrid(RectangleStructType bounds, num spacing, num subdivs, [Vector2StructType? mouseCell]) → int

Grid control

GuiGroupBox(RectangleStructType bounds, String? text) → int

Group Box control with text name

GuiIconText(GuiIconName iconId, String? text) → String

Get text with icon id prepended (if supported)

GuiIsLocked() → bool

Check if gui is locked (global state)

GuiLabel(RectangleStructType bounds, String? text) → int

Label control

GuiLabelButton(RectangleStructType bounds, String? text) → int

Label button control, returns true when clicked

GuiLine(RectangleStructType bounds, String? text) → int

Line separator control, could contain text

GuiListView(RectangleStructType bounds, String? text, {int? scrollIndex, int? active}) → (int, int?, int?)

List View control

GuiListViewEx(RectangleStructType bounds, List<String>? text, {int? scrollIndex, int? active, int? focus}) → (int, int?, int?, int?)

List View with extended parameters

GuiLoadIcons(String fileName, bool loadIconsName) → List<String>

Load raygui icons file (.rgi) into internal icons data

GuiLoadStyle(String fileName) → void

Load style file over global style variable (.rgs)

GuiLoadStyleDefault() → void

Load style default over global style

GuiLock() → void

Lock gui controls (global state)

GuiMessageBox(RectangleStructType bounds, String? title, String message, String buttons) → int

Message Box control, displays a message

GuiPanel(RectangleStructType bounds, String? text) → int

Panel control, useful to group controls

GuiProgressBar(RectangleStructType bounds, String? textLeft, String? textRight, num value, num minValue, num maxValue) → (int, double)

Progress Bar control

GuiScrollPanel(RectangleStructType bounds, String? text, RectangleStructType content, Vector2StructType scroll, [RectangleStructType? view]) → int

Scroll Panel control

GuiSetAlpha(num alpha) → void

Set gui controls alpha (global state), alpha goes from 0.0 to 1.0

GuiSetFont(FontStructType font) → void

Set gui custom font (global state)

GuiSetIconScale(num scale) → void

Set default icon drawing size

GuiSetState(GuiState state) → void

Set gui state (global state)

GuiSetStyle(GuiControl control, GuiProperty property, num value) → void

Set one style property

GuiSetTooltip(String? tooltip) → void

Set tooltip string

GuiSlider(RectangleStructType bounds, String? textLeft, String? textRight, num value, num minValue, num maxValue) → (int, double)

Slider control

GuiSliderBar(RectangleStructType bounds, String? textLeft, String? textRight, num value, num minValue, num maxValue) → (int, double)

Slider Bar control

GuiSpinner(RectangleStructType bounds, String? text, num value, num minValue, num maxValue, bool editMode) → (int, int)

Spinner control

GuiStatusBar(RectangleStructType bounds, String? text) → int

Status Bar control, shows info text

GuiTabBar(RectangleStructType bounds, List<String> text) → (int, int)

Tab Bar control, returns TAB to be closed or -1

GuiTextBox(RectangleStructType bounds, String? text, num textSize, bool editMode) → (int, String)

Text Box control, updates input text

GuiTextInputBox(RectangleStructType bounds, String? title, String? message, String buttons, String? text, num textMaxSize, bool? secretViewActive) → (int, String, bool?)

Text Input Box control, ask for text, supports secret

GuiToggle(RectangleStructType bounds, String? text, bool active) → (int, bool)

Toggle Button control

GuiToggleGroup(RectangleStructType bounds, String? text, num active) → (int, int)

Toggle Group control

GuiToggleSlider(RectangleStructType bounds, String? text, num active) → (int, int)

Toggle Slider control

GuiUnlock() → void

Unlock gui controls (global state)

GuiValueBox(RectangleStructType bounds, String? text, num value, num minValue, num maxValue, bool editMode) → (int, int)

Value Box control, updates input text with numbers

GuiValueBoxFloat(RectangleStructType bounds, String? text, String textValue, num value, bool editMode) → (int, double)

Value box control for float values

GuiWindowBox(RectangleStructType bounds, String? title) → int

Window Box control, shows a window that can be closed

load() → void

Override to perform one-time module initialization. Called by doLoad.

inherited

logError(Object? message) → void

inherited

logInfo(Object? message) → void

inherited

logWarn(Object? message) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDispose(void fn()) → void

Registers fn to be called when this module is disposed.

inherited

run<T>(String name(), T f()) → T

Executes f, logging its label (and optionally timing it) when debug is enabled and the label passes all filters.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited