parin.addons.microui.wrapper

High-level wrapper around the low-level core module. Provides helper functions that use a global context and follow D naming conventions.

var uiContext uiNumberFmt uiNumberFmtWithZero

alias beginUi endUi UiAtlas UiAtlasEnum UiBaseCommand UiClip UiClipCommand UiClipEnum UiColor UiColorEnum UiCommand UiCommandData UiContainer UiContext UiDrawFrameFunc UiFont UiFVec UiIcon UiIconCommand UiIconEnum UiId UiJumpCommand UiKeyFlag UiKeyFlags UiLayout UiMargin UiMember UiMouseFlag UiMouseFlags UiOptFlag UiOptFlags UiPoolItem UiPrivate UiRect UiRectCommand UiResFlag UiResFlags UiSlice UiSliceMode UiSlicePart UiSliceParts UiStyle UiTextCommand UiTextHeightFunc UiTexture UiTextWidthFunc UiVec

fn beginColumn beginDMenu beginPanel beginPopup beginTreeNode beginUiCore beginUiFrame beginWindow bringUiContainerToFront button checkbox checkUiClipRect drawControlFrame drawControlText drawUibox drawUiIcon drawUiRect drawUiState drawUiText endColumn endDMenu endPanel endPopup endTreeNode endUiCore endUiFrame endWindow getCurrentUiContainer getFromUiPool getUiClipRect getUiContainer getUiId handleUiInput header headerAndMembers isUiMouseOver label members nextLayout nextUiCommand number openDMenu openPopup popUiClipRect popUiId pushUiClipRect pushUiCommand pushUiId readyUi readyUiCore readyUiPool row setLayoutHeight setLayoutWidth setNextLayout setUiClipRect setUifocus slider tempMuUiTextHeightFunc tempMuUiTextWidthFunc text textBox uiInputKeyDown uiInputKeyUp uiInputMouseDown uiInputMouseMove uiInputMouseUp uiInputScroll uiInputText uiStyle updateControl updateUiPool

Types 47

aliasUiTextWidthFunc = MuTextWidthFunc

Used for getting the width of the text.

aliasUiTextHeightFunc = MuTextHeightFunc

Used for getting the height of the text.

aliasUiDrawFrameFunc = MuDrawFrameFunc

Used for drawing a frame.

aliasUiId = MuId

The control ID type of microui.

aliasUiFont = MuFont

The font type of microui.

aliasUiTexture = MuTexture

The texture type of microui.

aliasUiSliceMode = MuSliceMode

The slice repeat mode type of microui.

aliasUiRect = IRect

deprecated Use `IRect`. It's the same.

A 2D rectangle using ints.

aliasUiVec = IVec2

deprecated Use `IVec2`. It's the same.

A 2D vector using ints.

aliasUiFVec = Vec2

deprecated Use `Vec2`. It's the same.

A 2D vector using floats.

aliasUiMargin = Margin

deprecated Use `Margin`. It's the same.

A set of 4 integer margins for left, top, right, and bottom.

aliasUiSlicePart = SlicePart

deprecated Use `SlicePart`. It's the same.

A part of a 9-slice with source and target rectangles for drawing.

aliasUiSliceParts = SliceParts

deprecated Use `SliceParts`. It's the same.

The parts of a 9-slice.

aliasUiPoolItem = MuPoolItem

A pool item.

aliasUiBaseCommand = MuBaseCommand

Base structure for all render commands, containing type and size metadata.

aliasUiJumpCommand = MuJumpCommand

Command to jump to another location in the command buffer.

aliasUiClipCommand = MuClipCommand

Command to set a clipping rectangle.

aliasUiRectCommand = MuRectCommand

Command to draw a rectangle with a given color.

aliasUiTextCommand = MuTextCommand

Command to render text at a given position with a font and color. The text is a null-terminated string. Use str.ptr to access it.

aliasUiIconCommand = MuIconCommand

Command to draw an icon inside a rectangle with a given color.

aliasUiCommandData = MuCommandData

A union of all possible render commands.

aliasUiLayout = MuLayout

Layout state used to position UI controls within a container.

aliasUiContainer = MuContainer

A UI container holding commands.

aliasUiSlice = MuSlice

A 9-slice definition for an atlas area, controlling how it is sampled and tiled.

aliasUiStyle = MuStyle

UI style settings including font, sizes, spacing, and colors.

aliasUiContext = MuContext

The UI context.

aliasUiCommand = MuCommand

The command kind.

aliasUiClipEnum = MuClip

deprecated Remove `Enum` from the type name.

The clipping kind.

aliasUiClip = MuClip

The clipping kind.

aliasUiColorEnum = MuColor

deprecated Remove `Enum` from the type name.

The color kind.

aliasUiColor = MuColor

The color kind.

aliasUiIconEnum = MuIcon

deprecated Remove `Enum` from the type name.

The icon kind.

aliasUiIcon = MuIcon

The icon kind.

aliasUiAtlasEnum = MuAtlas

deprecated Remove `Enum` from the type name.

The atlas area kind.

aliasUiAtlas = MuAtlas

The atlas area kind.

aliasUiResFlags = MuResFlags

Bitmask type for result flags.

aliasUiResFlag = MuResFlag

Result flags indicating the outcome of a control interaction.

aliasUiOptFlags = MuOptFlags

Bitmask type for option flags.

aliasUiOptFlag = MuOptFlag

Option flags controlling control and window behaviour.

aliasUiMouseFlags = MuMouseFlags

Bitmask type for mouse button flags.

aliasUiMouseFlag = MuMouseFlag

Flags representing which mouse buttons are pressed.

aliasUiKeyFlags = MuKeyFlags

Bitmask type for keyboard key flags.

aliasUiKeyFlag = MuKeyFlag

Flags representing which keys are currently held down.

aliasUiPrivate = MuPrivate

Used by the members function to hide data.

aliasUiMember = MuMember

Used by the members function to show data in a specific way.

aliasbeginUi = beginUiFrame

deprecated Use `beginUiFrame`. It's a better name.

The old name of the beginUiFrame function.

aliasendUi = endUiFrame

deprecated Use `endUiFrame`. It's a better name.

The old name of the endUiFrame function.

Functions 82

fnUiStyle * uiStyle() ref

fnvoid readyUiCore(UiFont font = null, int fontScale = 1)

fnvoid readyUiCore(UiTextWidthFunc width, UiTextHeightFunc height, UiFont font = null, int fontScale = 1)

fnvoid beginUiCore()

fnvoid endUiCore()

fnvoid setUifocus(UiId id)

fnUiId getUiId(const(void) * data, Sz size)

fnUiId getUiId(IStr str)

fnvoid pushUiId(const(void) * data, Sz size)

fnvoid pushUiId(IStr str)

fnvoid popUiId()

fnvoid pushUiClipRect(IRect rect)

fnvoid popUiClipRect()

fnIRect getUiClipRect()

fnUiClip checkUiClipRect(IRect rect)

fnUiContainer * getCurrentUiContainer()

fnUiContainer * getUiContainer(IStr name)

fnvoid bringUiContainerToFront(UiContainer * cnt)

fnint readyUiPool(UiPoolItem * items, Sz len, UiId id)

fnint getFromUiPool(UiPoolItem * items, Sz len, UiId id)

fnvoid updateUiPool(UiPoolItem * items, Sz idx)

fnvoid uiInputMouseMove(int x, int y)

fnvoid uiInputMouseDown(int x, int y, UiMouseFlags input)

fnvoid uiInputMouseUp(int x, int y, UiMouseFlags input)

fnvoid uiInputScroll(int x, int y)

fnvoid uiInputKeyDown(UiKeyFlags input)

fnvoid uiInputKeyUp(UiKeyFlags input)

fnvoid uiInputText(IStr text)

fnUiCommandData * pushUiCommand(UiCommand type, Sz size)

fnbool nextUiCommand(UiCommandData * * cmd)

fnvoid setUiClipRect(IRect rect)

fnvoid drawUiRect(IRect rect, Rgba color, UiAtlas id = UiAtlas.none)

fnvoid drawUibox(IRect rect, Rgba color)

fnvoid drawUiText(UiFont font, IStr str, IVec2 point, Rgba color)

fnvoid drawUiIcon(UiIcon id, IRect rect, Rgba color)

fnvoid beginColumn()

fnvoid endColumn()

fnvoid row(int height, const(int)[] widths...)

fnvoid setLayoutWidth(int width)

fnvoid setLayoutHeight(int height)

fnvoid setNextLayout(IRect rect, bool relative)

fnIRect nextLayout()

fnvoid drawControlFrame(UiId id, IRect rect, UiColor colorId, UiOptFlags opt, UiAtlas atlasId = UiAtlas.none)

fnvoid drawControlText(IStr text, IRect rect, UiColor colorId, UiOptFlags opt)

fnbool isUiMouseOver(IRect rect)

fnvoid updateControl(UiId id, IRect rect, UiOptFlags opt)

fnvoid text(IStr text)

fnvoid label(IStr text)

fnUiResFlags button(IStr label, UiIcon icon = UiIcon.none, UiOptFlags opt = UiOptFlag.alignCenter)

fnUiResFlags checkbox(ref bool state, IStr label = "")

fnUiResFlags textBox(Str buffer, ref Sz newlen, UiOptFlags opt = UiOptFlag.none)

fnMuResFlags textBox(Str buffer, ref IStr newslice, UiOptFlags opt = UiOptFlag.none)

MuResFlags textBox(Sz N =  128,  IStr file =  __FILE__,  Sz line =  __LINE__)(ref  IStr newslice,  UiOptFlags opt =  UiOptFlag.none)

UiResFlags slider(ref  float  value,  float  low,  float  high,  float  step =  0.01f,  IStr fmt =  uiNumberFmt,  UiOptFlags opt =  UiOptFlag.alignCenter)

UiResFlags slider(ref  int  value,  int  low,  int  high,  int  step =  1,  IStr fmt =  uiNumberFmt,  UiOptFlags opt =  UiOptFlag.alignCenter)

UiResFlags number(ref  float  value,  float  step =  0.01f,  IStr fmt =  uiNumberFmt,  UiOptFlags opt =  UiOptFlag.alignCenter)

fnUiResFlags number(ref int value, int step = 1, IStr fmt = uiNumberFmt, UiOptFlags opt = UiOptFlag.alignCenter)

fnUiResFlags header(IStr label, UiOptFlags opt = UiOptFlag.none)

fnvoid members(T)(ref T data, int labelWidth, bool canShowPrivateMembers = false)

fnUiResFlags headerAndMembers(T)(ref T data, int labelWidth, IStr label = "", bool canShowPrivateMembers = false)

fnUiResFlags beginTreeNode(IStr label, UiOptFlags opt = UiOptFlag.none)

fnvoid endTreeNode()

fnUiResFlags beginWindow(IStr title, IRect rect, UiOptFlags opt = UiOptFlag.none)

fnUiResFlags beginWindow(IStr title, int x, int y, int w, int h, UiOptFlags opt = UiOptFlag.none)

fnvoid endWindow()

fnvoid openPopup(IStr name)

fnUiResFlags beginPopup(IStr name)

fnvoid endPopup()

fnvoid beginPanel(IStr name, UiOptFlags opt = UiOptFlag.none)

fnvoid endPanel()

fnvoid openDMenu()

UiResFlags beginDMenu(ref  IStr selection,  const(IStr)[]  items,  IVec2 canvas,  IStr label =  "",  Vec2 scale =  Vec2(0.5f,  0.7f))

fnvoid endDMenu()

fnint tempMuUiTextWidthFunc(UiFont font, IStr str) @trusted

fnint tempMuUiTextHeightFunc(UiFont font) @trusted

fnvoid readyUi(UiFont font = null, int fontScale = 1) @trustedInitializes the microui context and sets temporary text size functions. Value `font` should be a `FontId*`.

fnvoid readyUi(int fontScale)Initializes the microui context and sets temporary text size functions.

fnvoid readyUi(FontId font, int fontScale = 1)Initializes the microui context and sets temporary text size functions.

fnvoid handleUiInput() @trustedHandles input events and updates the microui context accordingly.

fnvoid drawUiState() @trustedDraws the microui context to the screen.

fnvoid beginUiFrame()Begins input handling and UI processing.

fnvoid endUiFrame()Ends UI processing and performs drawing.

Variables 3

varUiContext uiContext

enumvaruiNumberFmt = muNumberFmt

Format string used for numbers.

enumvaruiNumberFmtWithZero = muNumberFmtWithZero

Format string used for numbers, with a zero at the end.