dvui

A generic id created by hashing std.builting.SourceLocation's (from @src())

Used to track which widget holds mouse capture.

DEPRECATED: See dvui.Id.extendId

DEPRECATED: See dvui.Id.update

Data for matching events to widgets. See eventMatch.

Animation state - see animation and animationGet.

Creates a nested group for Options.tab_index values. tab_index controls

Captures dvui drawing to part of the screen in a Texture.

Reverse the normal back-to-front rendering order. Rendering inside is

Used with TreeSitter

Gets a texture from the internal texture cache. If a texture

See Texture.Cache.add

See Texture.Cache.invalidate

Retain this texture key.

Release this texture key. dvui will free its texture normally.

Set retain token for this texture key. null means remove retain token.

Clear retain for all textures and values with this retain token.

See Dragging.preStart

See Dragging.start

Get offset previously given to dragPreStart or dragStart.

Get rect from mouse position using offset and size previously given to

See Dragging.get

True if dragging and dragStart (or dragPreStart) was the given name.

Stop any mouse drag.

Get the current dvui.Window which corresponds to the OS window we are

Guess which type of pointing device is being used (touchpad vs. mouse).

Allocates space for a widget to the alloc stack, or the arena

Pops a widget off the alloc stack, if it was allocated there.

Returns whether the widget was created with widgetAlloc.

Get the active theme.

Set the active theme.

Toggle showing the debug window (run during Window.end).

Nanosecond timestamp for this frame.

Add font to be referenced later by name.

Takes in svg bytes and returns a tvg bytes that can be used

Get the width of an icon at a specified height.

Id of the currently focused subwindow. Used by FloatingMenuWidget to

Focus a subwindow.

Raise a subwindow to the top of the stack.

Focus a widget in the given subwindow (if null, the current subwindow).

Id of the focused widget (if any) in the focused subwindow.

Id of the focused widget (if any) in the current subwindow.

Last widget id we saw this frame that was the focused widget.

Pass result from lastFocusedIdInFrame. Returns the id of a widget that

Last widget id we saw in the current subwindow that was focused.

Set cursor the app should use if not already set this frame.

Called by floating widgets to participate in subwindow stacking - the order

Used by floating windows (subwindows) to install themselves as the current

Id of current subwindow (the one widgets run now will be in).

The difference between the final mouse position this frame and last frame.

Capture the mouse for this widget's data.

In most cases, use captureMouse but if you want to customize the

If the widget ID passed has mouse capture, this maintains that capture for

Test if the passed widget ID currently has mouse capture.

Get the widget ID that currently has mouse capture or null if none.

Get current screen rectangle in pixels that drawing is being clipped to.

Intersect the given physical rect with the current clipping rect and set

Set the current clipping rect to the given physical rect.

Multiplies the current alpha value with the passed in multiplier.

Set the current alpha value [0-1] where 1 is fully opaque.

Set snap_to_pixels setting. If true:

Get current snap_to_pixels setting. See snapToPixelsSet.

Set kerning setting. If true:

Requests another frame to be shown.

Get the textual content of the system clipboard. Caller must copy.

Set the textual content of the system clipboard.

Ask the system to open the given url.

Seconds elapsed between last frame and current. This value can be quite

Average frames per second over the past 30 frames.

Get the Widget that would be the parent of a new widget.

Make w the new parent widget. See parentGet.

Make a previous parent widget the current parent.

Set if dvui should immediately render, and return the previous setting.

Get the OS window size in natural pixels. Physical pixels might be more on

Get the OS window size in pixels. See windowRect.

Get the Rect and scale factor for the OS window. The Rect is in pixels,

The natural scale is how many pixels per natural pixel. Useful for

True if this is the first frame we've seen this widget id, meaning we don't

Get the min size recorded for id from last frame or null if id was not seen

Return the maximum of min_size and the min size for id from last frame.

Store value under key (id+name).

Set a deinit function for value stored under key (id+name).

Set retain token for this key (id+name). null means remove retain token.

Set value for key (id+name), copying the slice contents. Can be passed a

Same as dataSetSlice, but will copy value num_copies times all concatenated

Retrieve the value for key (id+name).

Retrieve the value for key (id+name). If no value was stored, store default and then return it.

Retrieve a pointer to the value for key (id+name). If no value was

Retrieve a pointer to the value for key (id+name).

Retrieve slice contents for key (id+name).

Retrieve slice contents for key (id+name).

Remove key (id+name) and associated value (if any). The value will be freed at next

Return a rect that fits inside avail given the options. avail wins over

Get the slice of Events for this frame.

Wrapper around eventMatch for normal usage.

Should e be processed by a widget with the given id and screen rect?

Handles all events needed for clicking behaviour, used by ButtonWidget.

Add animation a to key associated with id. See Animation.

Retrieve an animation previously added with animation. See Animation.

Add a timer for id that will be timerDone on the first frame after micros

Return the number of micros left on the timer for id if there is one. If

Return true on the first frame after a timer has expired.

Return true if timerDone or if there is no timer. Useful for periodic

Scroll the current containing scroll area to show the passed in screen rect

Bubbled from inside a scrollarea to ensure scrolling while dragging

Set the tab order for this widget. tab_index values are visited starting

Move focus to the next widget in tab index order. Uses the tab index values from last frame.

Move focus to the previous widget in tab index order. Uses the tab index values from last frame.

Widgets that accept text input should call this on frames they have focus.

Temporary menu that floats above current layer. Usually contains multiple

Subwindow that the user can generally resize and move around. Options.rect

Spawn a new OS Window and subsequent widgets will be drawn on it.

Normal widgets seen at the top of floatingWindow. Includes a close

Add a dialog to be displayed on the GUI thread during Window.end.

Only called from gui thread.

Add a dialog to be displayed on the GUI thread during Window.end.

Add a toast. Use toast for a simple message.

Remove a previously added toast.

Returns toasts that were previously added with non-null subwindow_id.

Add a simple toast. Use toastAdd for more complex toasts.

Standard way of showing toasts. For the main window, this is called with

Wrapper widget that takes a single child and animates it.

Show chosen entry, and click to display all entries in a floating menu.

Show @tagName of choice, and click to display all tags in that enum in a floating menu.

Wraps a textEntry to provide an attached menu (dropdown) of choices.

Text entry widget with dropdown choices.

Arrow icon and label that remembers if it has been clicked (expanded).

A bordered box with a heading, used to group related widgets,

Splits area in two with a user-moveable sash between.

Show text with wrapping (optional). Supports mouse and touch selection.

Context menu activated by mouse right click and touch "long press" (0.5s).

Show a floating text tooltip as long as the mouse is inside init_opts.active_rect.

Turns off normal tab navigation. Use for things where tab should go to the

focusGroup where the default role is "radio_group".

Shim to make widget ids unique.

Lays out children according to gravity anywhere inside. Useful to overlap

Box that packs children with gravity 0 or 1, or anywhere with gravity

Box laying out children horizontally, making new rows as needed.

Create either a draggable separator (resize_options != null)

Create a heading with a static label

Create a heading and allow the column to be sorted.

A grid heading with a checkbox for select-all and select-none

Size columns widths using ratios.

Widget for making thin lines to visually separate other widgets. Use

Empty widget used to take up space with .min_size_content.

A label that calls openURL when clicked.

A clickable label. See link.

Format and display a label.

Format and display a label with extra label options.

Display a label (no formatting) with extra label options.

Display an icon rasterized lazily from tvg_bytes.

Show raster image. dvui will handle texture creation/destruction for you,

returns true if fraction (0-1) was changed

Combines a slider and a text entry box on key press. Displays value on top of slider.

The returned slice is guaranteed to be valid utf8. If the passed in slice

A text entry for hex color codes. Supports the same formats as Color.fromHex

A photoshop style color picker

Display a struct and allow the user to edit values

Using this in application code will hinder ZLS from referencing the correct backend.

Accessibility

Used as a default maximum in various places:

The amount of logical pixels to scroll per "tick" of the scroll wheel.

When this is true, animation overwrites end_time so animations expire next frame.

Current Window (i.e. the one that widgets will be added to).

Global Io used by dvui functions, set by the backend when it is initialized.

Global debug struct.

For apps that want dvui to provide the mainloop which runs these callbacks.

Provides a consistent API for interacting with the backend

Maps to an OS window, and save all the state needed between frames.

A collection of points that make up a shape that can later be rendered to the screen.

A browser-DevTools-style profiler for a dvui GUI: a perf chart, a navigable

You can find below a list of available widgets.

Spawn a new OS Window

Note on ARIA Roles

A scrollable grid widget for displaying tabular data. Also known as a

A group of functions for displaying and editing values in structs

Easing functions mainly used for animations. Controls the rate of change of a value,

Helpers for Multi and Single selection

A wrapper around std.HashMapUnmanaged that stores a used flag next

Physical size of image, pixels per meter added to png pHYs chunk.

Toasts are just specialized dialogs

Adds accessibility support to widgets via the AccessKit library

A texture held by the backend. Can be drawn with dvui.renderTexture.

A texture held by the backend that can be drawn onto. See dvui.Picture.

Source data for image() and imageSize().

Get the size of a raster image. If source is .imageFile, this only decodes

Create a texture that can be rendered with renderTexture.

Update a texture that was created with textureCreate.

Update a sub-rectangle of a texture from raw PMA pixel data.

Create a texture that can be rendered with renderTexture and drawn to

Read pixels from texture created with textureCreateTarget.

Convert a target texture to a normal texture. target is destroyed. See

Destroy a texture created with textureCreate at the end of the frame.

Represents a deferred call to one of the render functions. This is how

Change where dvui renders. Can pass output from dvui.textureCreateTarget or

Rendered Triangles taking in to account the current clip rect

Only renders a single line of text. Newlines are rendered as spaces.

Only valid between Window.beginand Window.end.

Calls renderTexture with the texture created from tvg_bytes

Calls renderTexture with the texture created from source

Renders a ninepatch with the given parameters.

A collection of layout helper functions for placing widgets

Helper to layout widgets stacked vertically or horizontally.

Help left-align widgets by adding horizontal spacers.

Controls how placeOnScreen will move start to avoid spawner.

Adjust start rect based on screen and spawner (like a context menu).

Opens a file picker WITHOUT blocking. The file can be accessed by calling wasmFileUploaded with the same id

Will only return a non-null value for a single frame

Opens a file picker WITHOUT blocking. The files can be accessed by calling wasmFileUploadedMultiple with the same id

Will only return a non-null value for a single frame

Block while showing a native file open dialog. Return the selected file

Block while showing a native file open dialog with multiple selection.

Block while showing a native file save dialog. Return the selected file

Block while showing a native folder select dialog. Return the selected