vnightly

App construction and configuration

mod app:

• Main application class

  struct App

  ptr: *const c_void

  Creates a new App instance from the given AppConfig

  • constructor new:

    The initialized data model of the application, will be passed to the `LayoutCallback` of the active windows

    • arg data: RefAny

    Additional configuration on how the global application should behave

    • arg config: AppConfig

    • -> App

  Spawn a new window on the screen when the app is run.

  • fn add_window:

    • &mut self

    New window, note that this will **not** be spawned as the root window

    • arg window: WindowCreateOptions

  Adds a new image identified by an ID to the image cache

  • fn add_image:

    • &mut self

    • arg id: String

    • arg image: ImageRef

  Returns a list of monitors - useful for setting the monitor that a window should spawn on.

  • fn get_monitors:

    • &self

    • List of currently attached monitors, note that this Vec will be empty on wasm32

      -> MonitorVec

  Runs the application. Due to platform restrictions (specifically WinMain on Windows), this function never returns.

  • fn run:

    • &self

    Initial state of the root (main) window of the application

    • arg window: WindowCreateOptions

• Configuration for optional features, such as whether to enable logging or panic hooks

  struct AppConfig

  Which layout solver version to use, necessary so that future upgrades don't break the layout of old programs

  layout_solver: LayoutSolver

  If enabled, logs error and info messages

  log_level: AppLogLevel

  If the app crashes / panics, a window with a message box pops up

  enable_visual_panic_hook: bool

  If set, a backtrace + error information gets logged to stdout (if the log_level is not LogLevel::Off)

  enable_logging_on_panic: bool

  Whether keyboard navigation should be enabled

  enable_tab_navigation: bool

  External callbacks to create a thread or get the curent time

  system_callbacks: SystemCallbacks

  Constructs a default AppConfig, uses the layout solver currently available

  • constructor new:

    • arg layout_solver: LayoutSolver

    • -> AppConfig

• Configuration to set which messages should be logged.

  enum AppLogLevel

  No logging

  Off

  Log errors

  Error

  Log warnings

  Warn

  Log informational messages

  Info

  Log debug messages

  Debug

  Log tracing information

  Trace

• Version of the layout solver to use - future binary versions of azul may have more fields here, necessary so that old compiled applications don't break with newer releases of azul. Newer layout versions are opt-in only.

  enum LayoutSolver

  Default, current layout solver version

  Default

• External system callbacks to get the system time or create / manage threads

  struct SystemCallbacks

  create_thread_fn: CreateThreadFn

  get_system_time_fn: GetSystemTimeFn

  Use the default, library-internal callbacks instead of providing your own

  • constructor library_internal:

    • -> SystemCallbacks

Window creation / startup configuration

mod window:

• Options on how to initially create the window

  struct WindowCreateOptions

  Initial state of the window on the first frame

  state: WindowState

  If not None, azul will try to create a window with the specific renderer type and crash if the renderer is not available for whatever reason

  renderer_type: OptionRendererOptions

  Initially the theme on the WindowState is set to the OS theme - use this field to override the operating systems Dark or Light mode

  theme: OptionWindowTheme

  Callback to run once when the window is initially created

  create_callback: OptionCallback

  If set to true, will hot-reload the UI every 200ms. Default: false

  hot_reload: bool

  Creates a new window configuration with a custom layout callback

  • constructor new:

    The callback to call when the UI of the window should be rendered

    • arg layout_callback: LayoutCallbackType

    • -> WindowCreateOptions

• Force a specific renderer: note that azul will crash on startup if the RendererOptions are not satisfied.

  struct RendererOptions

  Force the renderer to enable VSync. Set this only if your application can't run without VSync.

  vsync: Vsync

  Force the renderer to enable SRGB (OpenGL extension). Set this only if your application can't run without correct SRGB handling and color correctness is a priority.

  srgb: Srgb

  Force the renderer to enable hardware acceleration. Set this only if your application can't run without hardware acceleration (ex. for games).

  hw_accel: HwAcceleration

• Whether the renderer has VSync enabled

  enum Vsync

  Enabled

  Disabled

• Does the renderer render in SRGB color space? By default, azul tries to set it to Enabled and falls back to Disabled if the OpenGL context can't be initialized properly

  enum Srgb

  Enabled

  Disabled

• Does the renderer render using hardware acceleration? By default, azul tries to set it to Enabled and falls back to Disabled if the OpenGL context can't be initialized properly

  enum HwAcceleration

  Enabled

  Disabled

• Offset in physical pixels (integer units)

  struct LayoutPoint

  Note: can be negative

  x: isize

  Note: can be negative

  y: isize

• Size in physical pixels (integer units)

  struct LayoutSize

  Note: can be negative

  width: isize

  Note: can be negative

  height: isize

• Represents a rectangle in physical pixels (integer units)

  struct LayoutRect

  Note: can be negative

  origin: LayoutPoint

  Note: can be negative

  size: LayoutSize

• Raw platform handle, for integration in / with other toolkits and custom non-azul window extensions

  union enum RawWindowHandle

  IOS(IOSHandle)

  MacOS(MacOSHandle)

  Xlib(XlibHandle)

  Xcb(XcbHandle)

  Wayland(WaylandHandle)

  Windows(WindowsHandle)

  Web(WebHandle)

  Android(AndroidHandle)

  Unsupported

• struct IOSHandle

  ui_window: *mut c_void

  ui_view: *mut c_void

  ui_view_controller: *mut c_void

• struct MacOSHandle

  ns_window: *mut c_void

  ns_view: *mut c_void

• struct XlibHandle

  An Xlib Window

  window: u64

  A pointer to an Xlib Display

  display: *mut c_void

• struct XcbHandle

  An X11 xcb_window_t

  window: u32

  A pointer to an X server xcb_connection_t

  connection: *mut c_void

• struct WaylandHandle

  A pointer to a wl_surface

  surface: *mut c_void

  A pointer to a wl_display

  display: *mut c_void

• struct WindowsHandle

  Pointer to a HWND handle

  hwnd: *mut c_void

  Pointer to a HINSTANCE associated with this windows HWND.

  hinstance: *mut c_void

• struct WebHandle

  An ID value inserted into the data attributes of the canvas element. Set to 0 if invalid.

  id: u32

• struct AndroidHandle

  A pointer to an ANativeWindow

  a_native_window: *mut c_void

• X11 window hint: Type of window

  enum XWindowType

  A desktop feature. This can include a single window containing desktop icons with the same dimensions as the screen, allowing the desktop environment to have full control of the desktop, without the need for proxying root window clicks

  Desktop

  A dock or panel feature. Typically a Window Manager would keep such windows on top of all other windows

  Dock

  Toolbar windows. "Torn off" from the main application

  Toolbar

  Pinnable menu windows. "Torn off" from the main application

  Menu

  A small persistent utility window, such as a palette or toolbox

  Utility

  The window is a splash screen displayed as an application is starting up

  Splash

  This is a dialog window

  Dialog

  A dropdown menu that usually appears when the user clicks on an item in a menu bar. This property is typically used on override-redirect windows.

  DropdownMenu

  A popup menu that usually appears when the user right clicks on an object. This property is typically used on override-redirect windows.

  PopupMenu

  A tooltip window. Usually used to show additional information when hovering over an object with the cursor. This property is typically used on override-redirect windows.

  Tooltip

  The window is a notification. This property is typically used on override-redirect windows.

  Notification

  This should be used on the windows that are popped up by combo boxes. This property is typically used on override-redirect windows.

  Combo

  This indicates the the window is being dragged. This property is typically used on override-redirect windows.

  Dnd

  This is a normal, top-level window

  Normal

• Same as LayoutPoint, but uses i32 instead of isize

  struct PhysicalPositionI32

  x: i32

  y: i32

• Same as LayoutPoint, but uses u32 instead of isize

  struct PhysicalSizeU32

  width: u32

  height: u32

• Logical rectangle area (can differ based on HiDPI settings). Usually this is what you'd want for hit-testing and positioning elements.

  struct LogicalRect

  origin: LogicalPosition

  size: LogicalSize

• Logical position (can differ based on HiDPI settings). Usually this is what you'd want for hit-testing and positioning elements.

  struct LogicalPosition

  x: f32

  y: f32

• A size in "logical" (non-HiDPI-adjusted) pixels in floating-point units

  struct LogicalSize

  width: f32

  height: f32

• Unique hash of a window icon, so that azul does not have to compare the actual bytes to see wether the window icon has changed.

  struct IconKey

  Can be any number, just has to be unique to the application. You need to generate a new IconKey if the window icon of your application has changed.

  id: usize

• Small (16x16x4) window icon, usually shown in the window titlebar

  struct SmallWindowIconBytes

  Key / hash of the window icon, so that azul can detect whether the icon has changed and notify the OS about the change.

  key: IconKey

  Decoded bytes of the window icon, [32x32x4] bytes in length, rgba format

  rgba_bytes: U8Vec

• Large (32x32x4) window icon, usually used on high-resolution displays (instead of SmallWindowIcon)

  struct LargeWindowIconBytes

  Key / hash of the taskbar icon, so that azul can detect whether the icon has changed and notify the OS about the change.

  key: IconKey

  Decoded bytes of the window icon, [32x32x4] bytes in length, rgba format

  rgba_bytes: U8Vec

• Window "favicon", usually shown in the top left of the window on Windows

  union enum WindowIcon

  Low-resolution version of the favicon

  Small(SmallWindowIconBytes)

  High-resolution version of the favicon

  Large(LargeWindowIconBytes)

• Application taskbar icon, 256x256x4 bytes in size

  struct TaskBarIcon

  Unique icon key so that azul can determine whether the application icon has changed and notify the OS about the change

  key: IconKey

  Decoded bytes of the taskbar icon, 256x256x4 bytes in size, rgba format

  rgba_bytes: U8Vec

• Symbolic name for a keyboard key, does not take the keyboard locale into account

  enum VirtualKeyCode

  Key1

  Key2

  Key3

  Key4

  Key5

  Key6

  Key7

  Key8

  Key9

  Key0

  A

  B

  C

  D

  E

  F

  G

  H

  I

  J

  K

  L

  M

  N

  O

  P

  Q

  R

  S

  T

  U

  V

  W

  X

  Y

  Z

  Escape

  F1

  F2

  F3

  F4

  F5

  F6

  F7

  F8

  F9

  F10

  F11

  F12

  F13

  F14

  F15

  F16

  F17

  F18

  F19

  F20

  F21

  F22

  F23

  F24

  Snapshot

  Scroll

  Pause

  Insert

  Home

  Delete

  End

  PageDown

  PageUp

  Left

  Up

  Right

  Down

  Back

  Return

  Space

  Compose

  Caret

  Numlock

  Numpad0

  Numpad1

  Numpad2

  Numpad3

  Numpad4

  Numpad5

  Numpad6

  Numpad7

  Numpad8

  Numpad9

  NumpadAdd

  NumpadDivide

  NumpadDecimal

  NumpadComma

  NumpadEnter

  NumpadEquals

  NumpadMultiply

  NumpadSubtract

  AbntC1

  AbntC2

  Apostrophe

  Apps

  Asterisk

  At

  Ax

  Backslash

  Calculator

  Capital

  Colon

  Comma

  Convert

  Equals

  Grave

  Kana

  Kanji

  LAlt

  LBracket

  LControl

  LShift

  LWin

  Mail

  MediaSelect

  MediaStop

  Minus

  Mute

  MyComputer

  NavigateForward

  NavigateBackward

  NextTrack

  NoConvert

  OEM102

  Period

  PlayPause

  Plus

  Power

  PrevTrack

  RAlt

  RBracket

  RControl

  RShift

  RWin

  Semicolon

  Slash

  Sleep

  Stop

  Sysrq

  Tab

  Underline

  Unlabeled

  VolumeDown

  VolumeUp

  Wake

  WebBack

  WebFavorites

  WebForward

  WebHome

  WebRefresh

  WebSearch

  WebStop

  Yen

  Copy

  Paste

  Cut

• Symbolic accelerator key (ctrl, alt, shift)

  union enum AcceleratorKey

  Ctrl

  Alt

  Shift

  Key(VirtualKeyCode)

• Minimum / maximum / current size of the window in logical dimensions

  struct WindowSize

  Current dimensions in logical units

  dimensions: LogicalSize

  HiDPI factor that can be overridden by the application

  hidpi_factor: f32

  HiDPI factor of the system - note that some systems report the scaling factor wrong (esp. Linux HiDPI). Usually the same as hidpi_factor.

  system_hidpi_factor: f32

  Maximum size of the window in logical units

  min_dimensions: OptionLogicalSize

  Minimum size of the window in logical units

  max_dimensions: OptionLogicalSize

• Boolean flags relating to the current window state

  struct WindowFlags

  Is the window currently maximized

  is_maximized: bool

  Is the window currently minimized

  is_minimized: bool

  Is the window about to close on the next frame? Setting this to true will close the window.

  is_about_to_close: bool

  Is the window currently fullscreened?

  is_fullscreen: bool

  Does the window have decorations (close, minimize, maximize, title bar)?

  has_decorations: bool

  Is the window currently visible?

  is_visible: bool

  Is the window always on top?

  is_always_on_top: bool

  Whether the window is resizable

  is_resizable: bool

  Whether the window is currently focused (changing this field will request user attention)

  has_focus: bool

  Whether the window has an "extended frame", i.e. the title bar is not rendered and the maximize / minimize / close buttons bleed into the window content

  has_extended_window_frame: bool

  Whether the window has a background blur

  has_blur_behind_window: bool

  Is smooth scrolling enabled for this window?

  smooth_scroll_enabled: bool

  Is automatic TAB support enabled for this window?

  autotab_enabled: bool

• Debugging information, will be rendered as an overlay on top of the UI

  struct DebugState

  Display the frame profiler on screen

  profiler_dbg: bool

  Display intermediate render targets on screen

  render_target_dbg: bool

  Display all texture cache pages on screen

  texture_cache_dbg: bool

  Display GPU timing results

  gpu_time_queries: bool

  Query the number of pixels that pass the depth test divided and show it in the profiler as a percentage of the number of pixels in the screen (window width times height)

  gpu_sample_queries: bool

  Render each quad with their own draw call.
  Terrible for performance but can help with understanding the drawing order when inspecting renderdoc or apitrace recordings

  disable_batching: bool

  Display the pipeline epochs

  epochs: bool

  Print driver messages to stdout

  echo_driver_messages: bool

  Show an overlay displaying overdraw amount

  show_overdraw: bool

  Display the contents of GPU cache

  gpu_cache_dbg: bool

  Clear evicted parts of the texture cache for debugging purposes

  texture_cache_dbg_clear_evicted: bool

  Show picture caching debug overlay

  picture_caching_dbg: bool

  Highlight all primitives with colors based on kind

  primitive_dbg: bool

  Draw a zoom widget showing part of the framebuffer zoomed in

  zoom_dbg: bool

  Scale the debug renderer down for a smaller screen. This will disrupt any mapping between debug display items and page content, so shouldn't be used with overlays like the picture caching or primitive display

  small_screen: bool

  Disable various bits of the WebRender pipeline, to help narrow down where slowness might be coming from

  disable_opaque_pass: bool

  Disable alpha

  disable_alpha_pass: bool

  Disable all clip masks

  disable_clip_masks: bool

  Disable text rendering

  disable_text_prims: bool

  Disable gradients

  disable_gradient_prims: bool

  Disable image rendering

  obscure_images: bool

  Taint the transparent area of the glyphs with a random opacity to easily see when glyphs are re-rasterized

  glyph_flashing: bool

  The profiler only displays information that is out of the ordinary

  smart_profiler: bool

  Dump picture cache invalidation information to stdout

  invalidation_dbg: bool

  Print debug information about tile caches

  tile_cache_logging_dbg: bool

  Capture a profile of the frame to a file

  profiler_capture: bool

  Force WebRender to render a new frame, even if WR can't determine that the display has changed

  force_picture_invalidation: bool

• Current keyboard state, stores what keys / characters have been pressed

  struct KeyboardState

  Tracks if the Shift key is currently pressed - (READONLY)

  shift_down: bool

  Tracks if the Ctrl key is currently pressed - (READONLY)

  ctrl_down: bool

  Tracks if the Alt key is currently pressed - (READONLY)

  alt_down: bool

  Tracks if the Super / Windows / Command key is currently pressed - (READONLY)

  super_down: bool

  Currently pressed char - (READONLY)

  current_char: OptionChar

  Currently pressed VirtualKeyCode - (READONLY). DO NOT USE THIS FOR TEXT INPUT, USE current_char and On::TextInput instead.

  current_virtual_keycode: OptionVirtualKeyCode

  List of currently held-down VirtualKeyCodes - useful to implement combinated shortcuts (ex. Ctrl + Shift + Right)

  pressed_virtual_keycodes: VirtualKeyCodeVec

  List of currently held-down ScanCodes (typedef for u32). Same as current_virtual_keycodes, but the scancode identifies the physical key pressed, independent of the keyboard layout. The scancode does not change if the user adjusts the host's keyboard map. Use when the physical location of the key is more important than the key's host GUI semantics, such as for movement controls in a first-person game (German keyboard: Z key, UK keyboard: Y key, etc.)

  pressed_scancodes: ScanCodeVec

• Current icon of the mouse cursor

  enum MouseCursorType

  Default

  Crosshair

  Hand

  Arrow

  Move

  Text

  Wait

  Help

  Progress

  NotAllowed

  ContextMenu

  Cell

  VerticalText

  Alias

  Copy

  NoDrop

  Grab

  Grabbing

  AllScroll

  ZoomIn

  ZoomOut

  EResize

  NResize

  NeResize

  NwResize

  SResize

  SeResize

  SwResize

  WResize

  EwResize

  NsResize

  NeswResize

  NwseResize

  ColResize

  RowResize

• Current position of the mouse cursor, relative to the window. Set to Uninitialized on startup (gets initialized on the first frame).

  union enum CursorPosition

  The cursor is out of bound of the window. For security reasons, tracking the cursor is not permitted by the library

  OutOfWindow

  The cursor position is unknown because the app hasn't yet been started. This is the default value and should generally only be set on startup.

  Uninitialized

  Cursor position relative to the top left corner of the window

  InWindow(LogicalPosition)

• Current mouse / cursor state

  struct MouseState

  Current mouse cursor type, set to None if the cursor is hidden. (READWRITE)

  mouse_cursor_type: OptionMouseCursorType

  Current mouse cursor type, set to None if the cursor is hidden. (READWRITE)

  cursor_position: CursorPosition

  Is the mouse cursor locked to the current window (important for applications like games)? (READWRITE)

  is_cursor_locked: bool

  Is the left mouse button down? (READONLY)

  left_down: bool

  Is the right mouse button down? (READONLY)

  right_down: bool

  Is the middle mouse button down? (READONLY)

  middle_down: bool

  Scroll amount in pixels in the horizontal direction. Gets reset to 0 after every frame (READONLY)

  scroll_x: OptionF32

  Scroll amount in pixels in the vertical direction. Gets reset to 0 after every frame (READONLY)

  scroll_y: OptionF32

• Platform-specific window configuration, i.e. WM options that are not cross-platform

  struct PlatformSpecificOptions

  Windows-specific WM options

  windows_options: WindowsWindowOptions

  Linux-specific WM options

  linux_options: LinuxWindowOptions

  Mac-specific WM options

  mac_options: MacWindowOptions

  Web / WASM-specific WM options

  wasm_options: WasmWindowOptions

• Window configuration specific to Win32

  struct WindowsWindowOptions

  STARTUP ONLY: Whether the window should allow drag + drop operations (default: true)

  allow_drag_drop: bool

  STARTUP ONLY: Sets WS_EX_NOREDIRECTIONBITMAP

  no_redirection_bitmap: bool

  STARTUP ONLY: Window icon (decoded bytes), usually 32x32x4 bytes large (ICON_SMALL), appears at the top right corner of the window

  window_icon: OptionWindowIcon

  READWRITE: Taskbar icon (decoded bytes), usually 256x256x4 bytes large (ICON_BIG). Can be changed in callbacks / at runtime.

  taskbar_icon: OptionTaskBarIcon

  READWRITE: Taskbar icon (decoded bytes), usually 256x256x4 bytes large (ICON_BIG). Can be changed in callbacks / at runtime.

  parent_window: OptionHwndHandle

• CSD theme of the window title / button controls

  struct WaylandTheme

  title_bar_active_background_color: [u8;4]

  title_bar_active_separator_color: [u8;4]

  title_bar_active_text_color: [u8;4]

  title_bar_inactive_background_color: [u8;4]

  title_bar_inactive_separator_color: [u8;4]

  title_bar_inactive_text_color: [u8;4]

  maximize_idle_foreground_inactive_color: [u8;4]

  minimize_idle_foreground_inactive_color: [u8;4]

  close_idle_foreground_inactive_color: [u8;4]

  maximize_hovered_foreground_inactive_color: [u8;4]

  minimize_hovered_foreground_inactive_color: [u8;4]

  close_hovered_foreground_inactive_color: [u8;4]

  maximize_disabled_foreground_inactive_color: [u8;4]

  minimize_disabled_foreground_inactive_color: [u8;4]

  close_disabled_foreground_inactive_color: [u8;4]

  maximize_idle_background_inactive_color: [u8;4]

  minimize_idle_background_inactive_color: [u8;4]

  close_idle_background_inactive_color: [u8;4]

  maximize_hovered_background_inactive_color: [u8;4]

  minimize_hovered_background_inactive_color: [u8;4]

  close_hovered_background_inactive_color: [u8;4]

  maximize_disabled_background_inactive_color: [u8;4]

  minimize_disabled_background_inactive_color: [u8;4]

  close_disabled_background_inactive_color: [u8;4]

  maximize_idle_foreground_active_color: [u8;4]

  minimize_idle_foreground_active_color: [u8;4]

  close_idle_foreground_active_color: [u8;4]

  maximize_hovered_foreground_active_color: [u8;4]

  minimize_hovered_foreground_active_color: [u8;4]

  close_hovered_foreground_active_color: [u8;4]

  maximize_disabled_foreground_active_color: [u8;4]

  minimize_disabled_foreground_active_color: [u8;4]

  close_disabled_foreground_active_color: [u8;4]

  maximize_idle_background_active_color: [u8;4]

  minimize_idle_background_active_color: [u8;4]

  close_idle_background_active_color: [u8;4]

  maximize_hovered_background_active_color: [u8;4]

  minimize_hovered_background_active_color: [u8;4]

  close_hovered_background_active_color: [u8;4]

  maximize_disabled_background_active_color: [u8;4]

  minimize_disabled_background_active_color: [u8;4]

  close_disabled_background_active_color: [u8;4]

  Font of the title bar, "sans-serif" by default

  title_bar_font: String

  title_bar_font_size: f32

• Renderer type of the current windows OpenGL context

  enum RendererType

  Hardware rendering active (OpenGL 3.1 / OpenGL ES 3.0)

  Hardware

  Software OpenGL rendering active (swgl)

  Software

• Key-value pair, used for setting WM hints values specific to GNOME

  struct StringPair

  key: String

  value: String

• struct LinuxWindowOptions

  Which X11 visual to use for the window (unimplemented). Can only be set at window creation, can't be changed in callbacks

  x11_visual: OptionX11Visual

  Which screen to use when showing the window (unimplemented). Can only be set at window creation, can't be changed in callbacks

  x11_screen: OptionI32

  Build window with WM_CLASS hint; defaults to the name of the binary. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_wm_classes: StringPairVec

  Build window with override-redirect flag; defaults to false. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_override_redirect: bool

  Build window with _NET_WM_WINDOW_TYPE hint; defaults to Normal. Only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_window_types: XWindowTypeVec

  Build window with _GTK_THEME_VARIANT hint set to the specified value. Currently only relevant on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_gtk_theme_variant: OptionString

  Build window with resize increment hint. Only implemented on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_resize_increments: OptionLogicalSize

  Build window with base size hint. Only implemented on X11. Can only be set at window creation, can't be changed in callbacks.

  x11_base_size: OptionLogicalSize

  Build window with a given application ID. It should match the .desktop file distributed with the program. Only relevant on Wayland. Can only be set at window creation, can't be changed in callbacks.

  wayland_app_id: OptionString

  Window decoration of the window minimize / maximize / close buttons

  wayland_theme: OptionWaylandTheme

  Whether the window icon should blink to request the users attention.

  request_user_attention: bool

  Sets the window icon of the program

  window_icon: OptionWindowIcon

• struct MacWindowOptions

  Reserved empty field

  _reserved: u8

• struct WasmWindowOptions

  Reserved empty field

  _reserved: u8

• enum FullScreenMode

  - macOS: If the window is in windowed mode, transitions it slowly to fullscreen mode}
  - other: Does the same as FastFullScreen.

  SlowFullScreen

  Window should immediately go into fullscreen mode (on macOS this is not the default behaviour).

  FastFullScreen

  - macOS: If the window is in fullscreen mode, transitions slowly back to windowed state.
  - other: Does the same as FastWindowed.

  SlowWindowed

  If the window is in fullscreen mode, will immediately go back to windowed mode (on macOS this is not the default behaviour).

  FastWindowed

• Window theme, set by the operating system or WindowCreateOptions.theme on startup

  enum WindowTheme

  Dark mode theme

  DarkMode

  Light mode theme (default)

  LightMode

• Position of the top left corner of the window relative to the top left of the monitor

  union enum WindowPosition

  Window position has not been initialized yet (default, only set on startup)

  Uninitialized

  Initialized window position: modifying this value will move the window

  Initialized(PhysicalPositionI32)

• Position of the virtual keyboard necessary to insert CJK characters

  union enum ImePosition

  Uninitialized

  Initialized(LogicalPosition)

• Current state of touch devices / touch inputs

  struct TouchState

  unused: u8

• Information about a single (or many) monitors, useful for dock widgets

  struct Monitor

  Internal ID for the monitor, only useful at startup to specify which screen the window should be created on (unimplemented)

  id: usize

  Name of the Monitor

  name: OptionString

  Size of the monitor. Note that this does not say anything about DPI (i.e. the physical, real-world size of the monitor).

  size: LayoutSize

  Position relative to the top left of the "virtual" monitor size (if two or more monitors are connected, this area will usually be a union of all monitors)

  position: LayoutPoint

  HiDPI scale factor of this monitor

  scale_factor: f64

  List of video modes supported by this monitor

  video_modes: VideoModeVec

  Whether this monitor is set as the primary monitor

  is_primary_monitor: bool

• Describes a rendering configuration for a monitor

  struct VideoMode

  Screen resolution in pixels

  size: LayoutSize

  Returns the bit depth of this video mode, as in how many bits you have available per color. This is generally 24 bits or 32 bits on modern systems, depending on whether the alpha channel is counted or not.
  Wayland: always returns 32.
  iOS: always returns 32.

  bit_depth: u16

  Returns the refresh rate of this video mode. Note: the returned refresh rate is an integer approximation, and you shouldn't rely on this value to be exact.

  refresh_rate: u16

• struct WindowState

  Current title of the window

  title: String

  Current theme of the window (dark or light mode). Will emit a ThemeChanged event if it is changed in a callback.

  theme: WindowTheme

  Size of the window + max width / max height: 800 x 600 by default

  size: WindowSize

  The x and y position, or None to let the WM decide where to put the window (default)

  position: WindowPosition

  Flags such as whether the window is minimized / maximized, fullscreen, etc.

  flags: WindowFlags

  Mostly used for debugging, shows WebRender-builtin graphs on the screen. Used for performance monitoring and displaying frame times (rendering-only).

  debug_state: DebugState

  Current keyboard state - NOTE: mutating this field (currently) does nothing (doesn't get synchronized with OS-level window)!

  keyboard_state: KeyboardState

  Current mouse state

  mouse_state: MouseState

  Current touch state, stores all states of currently connected touch input devices, pencils, tablets, etc. - NOTE: readonly field - mutating this field will not get synchronized with the OS

  touch_state: TouchState

  Sets location of IME candidate box in client area coordinates (relative to the top left of the window)

  ime_position: ImePosition

  Which monitor the window is currently residing on

  monitor: Monitor

  Window options that can only be set on a certain platform (WindowsWindowOptions / LinuxWindowOptions / MacWindowOptions).

  platform_specific_options: PlatformSpecificOptions

  Whether this window has SRGB / vsync / hardware acceleration

  renderer_options: RendererOptions

  Color of the window background (can be transparent if necessary)

  background_color: ColorU

  layout_callback: LayoutCallback

  Callback to run before the window closes, if DoNothing is returned, window won't close

  close_callback: OptionCallback

  Creates a new WindowState with default settings and a custom layout callback

  • constructor new:

    • arg layout_callback: LayoutCallbackType

    • -> WindowState

  Creates a default WindowState with an empty layout callback - useful only if you use the Rust WindowState { .. WindowState::default() } intialization syntax.

  • constructor default:

    • -> WindowState

Callback type definitions + struct definitions of CallbackInfos

mod callbacks:

• union enum LayoutCallback

  Raw(LayoutCallbackInner)

  Marshaled(MarshaledLayoutCallback)

• C-ABI stable wrapper over a MarshaledLayoutCallback

  struct MarshaledLayoutCallback

  marshal_data: RefAny

  cb: MarshaledLayoutCallbackInner

• C-ABI stable wrapper over a MarshaledLayoutCallbackInner

  struct MarshaledLayoutCallbackInner

  cb: MarshaledLayoutCallbackType

• Marshaled version of LayoutCallback, carrys an extra "marshal_data" containing the (usually external) function object

  fnptr MarshaledLayoutCallbackType

  Marshal-local data (the marshal_data of the MarshaledLayoutCallback struct)

  • arg &mut RefAny

  Application state of the App

  • arg &mut RefAny

  Useful information to contitionally return the structure of the DOM based on the width / height of the window

  • arg LayoutCallbackInfo

  The styled DOM rendered from the application state

  -> StyledDom

• C-ABI stable wrapper over a LayoutCallbackType

  struct LayoutCallbackInner

  cb: LayoutCallbackType

• Main callback to layout the UI. azul will only call this callback when necessary (usually when one of the callback or timer returns RegenerateStyledDomForCurrentWindow), however azul may also call this callback at any given time, so it should be performant. This is the main entry point for your app UI.

  fnptr LayoutCallbackType

  Application state of the App

  • arg &mut RefAny

  Useful information to contitionally return the structure of the DOM based on the width / height of the window

  • arg LayoutCallbackInfo

  The styled DOM rendered from the application state

  -> StyledDom

• C-ABI stable wrapper over a CallbackType

  struct Callback

  cb: CallbackType

• Generic UI callback function pointer: called when the EventFilter is active

  fnptr CallbackType

  Reference counted opaque pointer to the data set in the CallbackData for the hit DOM node

  • arg &mut RefAny

  Context struct to allow the callback to manipulate UI structures

  • arg CallbackInfo

  Whether this callback has modified the application state in such a way that a full UI redraw is unavoidable. If any callback returns true, the LayoutCallback of the window will be called again to render the next frame.

  -> Update

• struct CallbackInfo

  css_property_cache: *const c_void

  styled_node_states: *const c_void

  previous_window_state: *const c_void

  current_window_state: *const c_void

  modifiable_window_state: *mut WindowState

  gl_context: *const OptionGl

  image_cache: *mut c_void

  system_fonts: *mut c_void

  timers: *mut c_void

  threads: *mut c_void

  new_windows: *mut c_void

  current_window_handle: *const RawWindowHandle

  node_hierarchy: *const c_void

  system_callbacks: *const SystemCallbacks

  datasets: *mut c_void

  stop_propagation: *mut bool

  focus_target: *mut c_void

  words_cache: *const c_void

  shaped_words_cache: *const c_void

  positioned_words_cache: *const c_void

  positioned_rects: *const c_void

  words_changed_in_callbacks: *mut c_void

  images_changed_in_callbacks: *mut c_void

  image_masks_changed_in_callbacks: *mut c_void

  css_properties_changed_in_callbacks: *mut c_void

  current_scroll_states: *const c_void

  nodes_scrolled_in_callback: *mut c_void

  hit_dom_node: DomNodeId

  cursor_relative_to_item: OptionLogicalPosition

  cursor_in_viewport: OptionLogicalPosition

  _reserved_ref: *const c_void

  _reserved_mut: *mut c_void

  Returns the DomNodeId of the element that the callback was attached to.

  • fn get_hit_node:

    • &self

    • -> DomNodeId

  Returns the function pointer necessary to query the current time.

  • fn get_system_time_fn:

    • &self

    • -> GetSystemTimeFn

  Returns the LayoutPoint of the cursor in the viewport (relative to the origin of the Dom). Set to None if the cursor is not in the current window.

  • fn get_cursor_relative_to_viewport:

    • &self

    • -> OptionLogicalPosition

  Returns the LayoutPoint of the cursor in the viewport (relative to the origin of the Dom). Set to None if the cursor is not hovering over the current node.

  • fn get_cursor_relative_to_node:

    • &self

    • -> OptionLogicalPosition

  Returns a copy of the current windows WindowState.

  • fn get_current_window_state:

    • &self

    • -> WindowState

  Returns a copy of the internal KeyboardState. Same as self.get_window_state().keyboard_state

  • fn get_current_keyboard_state:

    • &self

    • -> KeyboardState

  Returns a copy of the internal MouseState. Same as self.get_window_state().mouse_state

  • fn get_current_mouse_state:

    • &self

    • -> MouseState

  Returns a copy of the current windows WindowState.

  • fn get_previous_window_state:

    • &self

    • -> OptionWindowState

  Returns a copy of the internal KeyboardState. Same as self.get_window_state().keyboard_state

  • fn get_previous_keyboard_state:

    • &self

    • -> OptionKeyboardState

  Returns a copy of the internal MouseState. Same as self.get_window_state().mouse_state

  • fn get_previous_mouse_state:

    • &self

    • -> OptionMouseState

  Returns a copy of the current windows RawWindowHandle.

  • fn get_current_window_handle:

    • &self

    • -> RawWindowHandle

  Returns a reference-counted copy of the current windows' Gl (context). You can use this to render OpenGL textures.

  • fn get_gl_context:

    • &self

    • -> OptionGl

  Returns the x / y offset that this node has been scrolled to by the user or None if the node has not been scrolled.

  • fn get_scroll_position:

    • &self

    • arg node_id: DomNodeId

    • -> OptionLogicalPosition

  Returns the dataset property of the given Node or None if the node doesn't have a dataset property.

  • fn get_dataset:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionRefAny

  If the node is a Text node, returns a copy of the internal string contents.

  • fn get_string_contents:

    • &self

    • arg node_id: DomNodeId

    • -> OptionString

  If the node is a Text node, returns the layouted inline glyphs

  • fn get_inline_text:

    • &self

    • arg node_id: DomNodeId

    • -> OptionInlineText

  Returns the index of the node relative to the parent node.

  • fn get_index_in_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> usize

  Returns the parent DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the previous siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_previous_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_next_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_first_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_last_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the position of a given DOM node in the UI

  • fn get_node_position:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionPositionInfo

  Returns the size of a given DOM node in the UI

  • fn get_node_size:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionLogicalSize

  Returns the current computed CSS property of a given DOM node in the UI

  • fn get_computed_css_property:

    • &mut self

    • arg node_id: DomNodeId

    • arg property_type: CssPropertyType

    • -> OptionCssProperty

  Sets the new WindowState for the next frame. The window is updated after all callbacks are run.

  • fn set_window_state:

    • &mut self

    • arg new_state: WindowState

  Sets the new FocusTarget for the next frame. Note that this will emit a On::FocusLost and On::FocusReceived event, if the focused node has changed.

  • fn set_focus:

    • &mut self

    • arg target: FocusTarget

  Sets a CssProperty on a given node to its new value. If this property change affects the layout, this will automatically trigger a relayout and redraw of the screen.

  • fn set_css_property:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_property: CssProperty

  Sets the scroll position of the node

  • fn set_scroll_position:

    • &mut self

    • arg node_id: DomNodeId

    • arg scroll_position: LogicalPosition

  If the node is a Text node, overwrites the Text content with the new string, without requiring the entire UI to be rebuilt.

  • fn set_string_contents:

    • &mut self

    • arg node_id: DomNodeId

    • arg string: String

  Adds a new image identified by an ID to the image cache

  • fn add_image:

    • &mut self

    • arg id: String

    • arg image: ImageRef

  Returns whether an image with a given CSS ID already exists

  • fn has_image:

    • &self

    • arg id: String

    • -> bool

  Returns the image with a given CSS ID

  • fn get_image:

    • &self

    • arg id: String

    • -> OptionImageRef

  If the node is an Image, exchanges the current image with a new source

  • fn update_image:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_image: ImageRef

  Deletes an image identified by a CSS ID from the image cache

  • fn delete_image:

    • &mut self

    • arg id: String

  If the node has an ImageMask, exchanges the current mask for the new mask

  • fn update_image_mask:

    • &mut self

    • arg node_id: DomNodeId

    • arg new_mask: ImageMask

  Stops the propagation of the current callback event type to the parent. Events are bubbled from the inside out (children first, then parents), this event stops the propagation of the event to the parent.

  • fn stop_propagation:

    • &mut self

  Spawns a new window with the given WindowCreateOptions.

  • fn create_window:

    • &mut self

    • arg new_window: WindowCreateOptions

  Adds a new Timer to the runtime. See the documentation for Timer for more information.

  • fn start_timer:

    • &mut self

    • arg timer: Timer

    • -> OptionTimerId

  Starts an animation timer on a give NodeId - same as a Timer, but uses a pre-configured interpolation function to drive the animation timer

  • fn start_animation:

    • &mut self

    • arg node: DomNodeId

    • arg animation: Animation

    • -> OptionTimerId

  Stops / cancels a Timer. See the documentation for Timer for more information.

  • fn stop_timer:

    • &mut self

    • arg timer_id: TimerId

    • Returns true if the timer was successfully stopped / removed.

      -> bool

  Starts a new Thread to the runtime. See the documentation for Thread for more information.

  • fn start_thread:

    • &mut self

    • arg thread_initialize_data: RefAny

    • arg writeback_data: RefAny

    • arg callback: ThreadCallback

    • -> OptionThreadId

  Sends a message to a background thread

  • fn send_thread_msg:

    • &mut self

    • arg thread_id: ThreadId

    • arg msg: ThreadSendMsg

    • Returns true if the ThreadId is valid and the message could be sent, false otherwise

      -> bool

  Stops a thread at the nearest possible opportunity. Sends a ThreadSendMsg::TerminateThread message to the thread and joins the thread.

  • fn stop_thread:

    • &mut self

    • arg thread_id: ThreadId

    • Returns true if the ThreadId is valid, false otherwise

      -> bool

• Specifies if the screen should be updated after the callback function has returned

  enum Update

  The screen does not need to redraw after the callback has been called

  DoNothing

  After the callback is called, the screen needs to redraw (layout() function being called again)

  RefreshDom

  After the callback is called, the layout() function needs to be called again for ALL windows

  RefreshDomAllWindows

• Index of a Node in the internal NodeDataContainer

  struct NodeId

  Index of the node into the vector.
  Note: the index is offset by 1:
  
  0 = None

1 = Some(0)

2 = Some(1)

  inner: usize

• ID of a DOM - one window can contain multiple, nested DOMs (such as iframes)

  struct DomId

  Index of the dom into the StyledDomVec

  inner: usize

• Combination of node ID + DOM ID, both together can identify a node

  struct DomNodeId

  dom: DomId

  node: NodeId

• union enum PositionInfo

  Static(PositionInfoInner)

  Fixed(PositionInfoInner)

  Absolute(PositionInfoInner)

  Relative(PositionInfoInner)

• struct PositionInfoInner

  x_offset: f32

  y_offset: f32

  static_x_offset: f32

  static_y_offset: f32

• struct HidpiAdjustedBounds

  logical_size: LogicalSize

  hidpi_factor: f32

  Returns the size of the bounds in logical units

  • fn get_logical_size:

    • &self

    • -> LogicalSize

  Returns the size of the bounds in physical units

  • fn get_physical_size:

    • &self

    • -> PhysicalSizeU32

  Returns the hidpi factor of the bounds

  • fn get_hidpi_factor:

    • &self

    • -> f32

• struct InlineText

  List of lines in this text, relative to the text origin

  lines: InlineLineVec

  Content size of all text lines

  content_size: LogicalSize

  Font size in pixels used for layouting this text

  font_size_px: f32

  Index of the last Word in this text (- note that a Word can also be a Space, Return or Tab).

  last_word_index: usize

  NEGATIVE descender of the text baseline (distance from baseline of the text to the bottom of the line)

  baseline_descender_px: f32

  Hit-tests the inline text, returns detailed information about which glyph / word / line, etc. the position (usually the mouse cursor) is currently over. Result may be empty (no hits) or contain more than one result (cursor is hovering over multiple overlapping glyphs at once).

  • fn hit_test:

    • &self

    • arg position: LogicalPosition

    • -> InlineTextHitVec

• struct InlineLine

  List of words in this line (includes tabs, return and spaces)

  words: InlineWordVec

  Size and origin of the line, relative to the inline text origin (top left corner)

  bounds: LogicalRect

• union enum InlineWord

  Tab character, width depends on TextLayoutOptions.tab_width

  Tab

  Return character

  Return

  Space character

  Space

  Actual word containing renderable glyphs

  Word(InlineTextContents)

• struct InlineTextContents

  List of glyphs in this word

  glyphs: InlineGlyphVec

  origin and size of the word relative to the line origin (top left corner of the line)

  bounds: LogicalRect

• struct InlineGlyph

  origin and size of the glyph - note: origin relative to the word origin (top left corner of the word)

  bounds: LogicalRect

  Option<char>: optional unicode codepoint of this glyph

  unicode_codepoint: OptionChar

  Index of the glyph in the font

  glyph_index: u32

• struct InlineTextHit

  Option<char>, if the glyph was a character (as opposed to a diacritic mark), contains the unicode codepoint of the character

  unicode_codepoint: OptionChar

  Position of the hit relative to the top left corner of the inline text

  hit_relative_to_inline_text: LogicalPosition

  Position of the hit relative to the top left corner of the line

  hit_relative_to_line: LogicalPosition

  Position of the hit relative to the top left corner of the word

  hit_relative_to_text_content: LogicalPosition

  Position of the hit relative to the top left corner of the glyph

  hit_relative_to_glyph: LogicalPosition

  Index of the line in the text

  line_index_relative_to_text: usize

  Index of the word in the text (note: words include Space, Tab and Return)

  word_index_relative_to_text: usize

  Index of the text content in the text

  text_content_index_relative_to_text: usize

  Index of the hit glyph in the text (note: one glyph is not one character, glyphs include diacritic marks)

  glyph_index_relative_to_text: usize

  Index of the hit character (unicode codepoint) in the text.

  char_index_relative_to_text: usize

  Index of the hit word (note: includes Tab, Space, Return) in the hit line

  word_index_relative_to_line: usize

  Index of the hit text content ("word") in the hit line

  text_content_index_relative_to_line: usize

  Index of the hit glyph in the line (includes diacritic marks)

  glyph_index_relative_to_line: usize

  Index of the hit character (unicode codepoint) in the line

  char_index_relative_to_line: usize

  Index of the hit glyph in the word (includes diacritic marks)

  glyph_index_relative_to_word: usize

  Index of the hit character (unicode codepoint) in the word

  char_index_relative_to_word: usize

• Defines the keyboard input focus target

  union enum FocusTarget

  Set the focus by its DOM + Node ID

  Id(DomNodeId)

  Set the focus by a CSS path

  Path(FocusTargetPath)

  Sets the focus to the previous focusable node in the DOM or None if this was the first focusable DOM node

  Previous

  Sets the focus to the next focusable node in the DOM or None if this was the last focusable DOM node

  Next

  Set the focus to the first focusable DOM or None if no nodes are focusable

  First

  Set the focus to the last focusable DOM or None if no nodes are focusable

  Last

  Unset the keyboard focus

  NoFocus

• CSS path to set the keyboard input focus

  struct FocusTargetPath

  dom: DomId

  css_path: CssPath

• Animation struct to start a new animation

  struct Animation

  from: CssProperty

  to: CssProperty

  duration: Duration

  repeat: AnimationRepeat

  repeat_count: AnimationRepeatCount

  easing: AnimationEasing

  Whether to reconstruct the DOM when the animation is finished, useful for UI state transitions

  relayout_on_finish: bool

• How should an animation repeat (loop, ping-pong, etc.)

  enum AnimationRepeat

  Terminate the animation after the first iteration

  NoRepeat

  Loop animation, reset the animation on every iteration

  Loop

  Loop animation, invert from and to after ever iteration

  PingPong

• How many times should an animation repeat

  union enum AnimationRepeatCount

  Times(usize)

  Infinite

• Easing function of the animation (ease-in, ease-out, ease-in-out, custom)

  union enum AnimationEasing

  Ease

  Linear

  EaseIn

  EaseOut

  EaseInOut

  CubicBezier(SvgCubicCurve)

• C-ABI wrapper over an IFrameCallbackType

  struct IFrameCallback

  cb: IFrameCallbackType

• For rendering large or infinite datasets such as tables or lists, azul uses IFrameCallbacks that allow the library user to only render the visible portion of DOM nodes, not the entire set. IFrames are rendered after the screen has been laid out, but before it gets composited. IFrames can be used recursively (i.e. iframes within iframes are possible). IFrames are re-rendered once the user scrolls to the bounds (see IFrameCallbackReturn on how to set the bounds) or the parent DOM was recreated.

  fnptr IFrameCallbackType

  An IFrameCallback can have some data passed along from the parent DOM - usually this would be struct containing the widget state

  • arg &mut RefAny

  Similar to LayoutCallbackInfo, but carries an additional bounds field which has information about the size / current scroll position of the IFrame.

  • arg IFrameCallbackInfo

  Contains the returned StyledDom as well as information about the initial scroll position of the new DOM plus scrollbar / overflow information

  -> IFrameCallbackReturn

• struct IFrameCallbackInfo

  Pointer to system fonts

  system_fonts: *const c_void

  Pointer to the image cache

  image_cache: *const c_void

  Window theme, so that the IFrame can conditionally style itself

  window_theme: WindowTheme

  Bounds of the IFrame with HiDPI factor

  bounds: HidpiAdjustedBounds

  How far the user has scrolled in the virtual scroll frame - useful to set the

  scroll_size: LogicalSize

  How far the user has scrolled in the virtual scroll frame - useful to set the

  scroll_offset: LogicalPosition

  How far the user has scrolled in the virtual scroll frame - useful to set the

  virtual_scroll_size: LogicalSize

  How far the user has scrolled in the virtual scroll frame - useful to set the

  virtual_scroll_offset: LogicalPosition

  _reserved_ref: *const c_void

  _reserved_mut: *mut c_void

• <img src="../images/scrollbounds.png"/>

  struct IFrameCallbackReturn

  The DOM that is currently visible in the HidpiAdjustedBounds.

  dom: StyledDom

  The actual extent of the dom in pixels - usually larger than currently visible bounds. When the user scrolls to one of the edges of these bounds, this IFrameCallback will be called again, so you'd want to render some extra rows or columns so that the callback doesn't have to get called again on every single scrolled pixel.

  scroll_size: LogicalSize

  Position that the dom should be scrolled to, relative to the virtual_scroll_offset.

  scroll_offset: LogicalPosition

  While the scroll_size is the currently rendered part of a larger scroll area, the virtual scroll size is the total size, even of non-rendered elements. For example, a table might show 30 - 40 rows and 10 columns, but the virtual size could be much larger. This setting only affects is the size of the scrollbar thumb.

  virtual_scroll_size: LogicalSize

  Same as virtual_scroll_offset, but only affects the position of the scrollbar thumb

  virtual_scroll_offset: LogicalPosition

• struct RenderImageCallback

  cb: RenderImageCallbackType

• fnptr RenderImageCallbackType

  • arg &mut RefAny

  • arg RenderImageCallbackInfo

  -> ImageRef

• struct RenderImageCallbackInfo

  callback_node_id: DomNodeId

  bounds: HidpiAdjustedBounds

  gl_context: *const OptionGl

  image_cache: *const c_void

  system_fonts: *const c_void

  node_hierarchy: *const NodeVec

  words_cache: *const c_void

  shaped_words_cache: *const c_void

  positioned_words_cache: *const c_void

  positioned_rects: *const c_void

  _reserved_ref: *const c_void

  _reserved_mut: *mut c_void

  Returns a copy of the internal Gl

  • fn get_gl_context:

    • &self

    • -> OptionGl

  Returns a copy of the internal HidpiAdjustedBounds

  • fn get_bounds:

    • &self

    • -> HidpiAdjustedBounds

  Returns the DomNodeId that this callback was called on

  • fn get_callback_node_id:

    • &self

    • -> DomNodeId

  If the node is a Text node, returns the layouted inline glyphs

  • fn get_inline_text:

    • &self

    • arg node_id: DomNodeId

    • -> OptionInlineText

  Returns the index of the node relative to the parent node.

  • fn get_index_in_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> usize

  Returns the parent DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_parent:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the previous siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_previous_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_next_sibling:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_first_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

  Returns the next siblings DomNodeId of the given DomNodeId. Returns None on an invalid NodeId.

  • fn get_last_child:

    • &mut self

    • arg node_id: DomNodeId

    • -> OptionDomNodeId

• struct TimerCallback

  cb: TimerCallbackType

• fnptr TimerCallbackType

  • arg &mut RefAny

  • arg &mut RefAny

  • arg TimerCallbackInfo

  -> TimerCallbackReturn

• struct TimerCallbackInfo

  callback_info: CallbackInfo

  If the timer is attached to a NodeId, stores the node ID

  node_id: OptionDomNodeId

  Instant of when the current frame was started, for cancelling timers / animations if they take too long

  frame_start: Instant

  How many times this animation was called already

  call_count: usize

  Set to true on the last invocation of the timer, usually necessar to re-render the DOM only on the last frame

  is_about_to_finish: bool

  _reserved_ref: *const c_void

  _reserved_mut: *mut c_void

• struct TimerCallbackReturn

  Whether the timer affects the screen in any way

  should_update: Update

  Whether the timer should terminate itself

  should_terminate: TerminateTimer

• fnptr WriteBackCallbackType

  • arg &mut RefAny

  • arg RefAny

  • arg CallbackInfo

  -> Update

• struct WriteBackCallback

  cb: WriteBackCallbackType

• struct ThreadCallback

  cb: ThreadCallbackType

• fnptr ThreadCallbackType

  • arg RefAny

  • arg ThreadSender

  • arg ThreadReceiver

• fnptr RefAnyDestructorType

  • arg c_void

• struct RefCount

  ptr: *const c_void

  • fn can_be_shared:

    • &self

    • -> bool

  • fn can_be_shared_mut:

    • &self

    • -> bool

  • fn increase_ref:

    • &mut self

  • fn decrease_ref:

    • &mut self

  • fn increase_refmut:

    • &mut self

  • fn decrease_refmut:

    • &mut self

• RefAny is a reference-counted, opaque pointer, which stores a reference to a struct. RefAny can be up- and downcasted (this usually done via generics and can't be expressed in the Rust API)

  struct RefAny

  Pointer to the type-erased struct

  _internal_ptr: *const c_void

  Pointer to the reference count of this RefAny. Calling .clone() will not clone the data, only bump the reference count by 1. When the num_copies reaches 0, the destructor of this RefAny is called

  sharing_info: RefCount

  • constructor new_c:

    • arg ptr: c_void

    • arg len: usize

    • arg type_id: u64

    • arg type_name: String

    • arg destructor: RefAnyDestructorType

    • -> RefAny

  • fn get_type_id:

    • &self

    • -> u64

  • fn get_type_name:

    • &self

    • -> String

• struct LayoutCallbackInfo

  window_size: WindowSize

  theme: WindowTheme

  image_cache: *const c_void

  gl_context: *const OptionGl

  system_fonts: *const c_void

  _reserved_ref: *const c_void

  _reserved_mut: *mut c_void

  Returns a copy of the OpenGL context

  • fn get_gl_context:

    • &self

    • -> OptionGl

  Returns all system-native fonts with their respective file paths as values

  • fn get_system_fonts:

    • &self

    • -> StringPairVec

  Returns an ImageRef referenced by a CSS ID

  • fn get_image:

    • &self

    • arg id: String

    • -> OptionImageRef

Dom construction and configuration

mod dom:

• struct Dom

  Root node data - note that the global DOM root should be of NodeType::Body

  root: NodeData

  Child nodes of this root node

  children: DomVec

  Number of child nodes, including all child DOM trees

  total_children: usize

  • constructor new:

    • arg node_type: NodeType

    • -> Dom

  • constructor body:

    • -> Dom

  • constructor div:

    • -> Dom

  • constructor br:

    • -> Dom

  • constructor text:

    • arg string: String

    • -> Dom

  • constructor image:

    • arg image: ImageRef

    • -> Dom

  • constructor iframe:

    • arg data: RefAny

    • arg callback: IFrameCallbackType

    • -> Dom

  • fn set_node_type:

    • &mut self

    • arg node_type: NodeType

  • fn with_node_type:

    • &mut self

    • arg node_type: NodeType

    • -> Dom

  • fn set_dataset:

    • &mut self

    • arg dataset: RefAny

  • fn with_dataset:

    • &mut self

    • arg dataset: RefAny

    • -> Dom

  • fn set_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

  • fn with_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

    • -> Dom

  • fn set_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

  • fn with_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

    • -> Dom

  • fn set_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

  • fn with_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn add_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

  Same as add_child, but as a builder method.

  • fn with_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn add_child:

    • &mut self

    • arg child: Dom

  Same as add_child, but as a builder method.

  • fn with_child:

    • &mut self

    • arg child: Dom

    • -> Dom

  Adds a child node to this DOM (potentially heap-allocates in Rust code). Swaps self with a default Dom in order to prevent accidental copies.

  • fn set_children:

    • &mut self

    • arg children: DomVec

  Same as set_children, but as a builder method.

  • fn with_children:

    • &mut self

    • arg children: DomVec

    • -> Dom

  Adds an CSS ID to the DOM root node.

  • fn add_id:

    • &mut self

    • arg id: String

  Same as add_id, but as a builder method

  • fn with_id:

    • &mut self

    • arg id: String

    • -> Dom

  Adds a CSS class to the DOM root node.

  • fn add_class:

    • &mut self

    • arg class: String

  Same as add_class, but as a builder method

  • fn with_class:

    • &mut self

    • arg class: String

    • -> Dom

  Adds an inline (normal) CSS property to the DOM root node.

  • fn add_css_property:

    • &mut self

    • arg prop: CssProperty

  Same as add_class, but as a builder method

  • fn with_css_property:

    • &mut self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_hover_css_property:

    • &mut self

    • arg prop: CssProperty

  Same as add_class, but as a builder method

  • fn with_hover_css_property:

    • &mut self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_active_css_property:

    • &mut self

    • arg prop: CssProperty

  Same as add_class, but as a builder method

  • fn with_active_css_property:

    • &mut self

    • arg prop: CssProperty

    • -> Dom

  Adds an inline (hover) CSS property to the DOM root node.

  • fn add_focus_css_property:

    • &mut self

    • arg prop: CssProperty

  Same as add_class, but as a builder method

  • fn with_focus_css_property:

    • &mut self

    • arg prop: CssProperty

    • -> Dom

  Sets the clip mask for the DOM root node.

  • fn set_clip_mask:

    • &mut self

    • arg clip_mask: ImageMask

  Same as set_clip_mask, but as a builder method

  • fn with_clip_mask:

    • &mut self

    • arg clip_mask: ImageMask

    • -> Dom

  Sets the tab index for the DOM root node.

  • fn set_tab_index:

    • &mut self

    • arg tab_index: TabIndex

  Same as set_tab_index, but as a builder method

  • fn with_tab_index:

    • &mut self

    • arg tab_index: TabIndex

    • -> Dom

  Sets accessibility attributes for the DOM root node.

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  Same as set_accessibility_info, but as a builder method

  • fn with_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

    • -> Dom

  Sets the menu bar for the DOM root node. See NodeData::set_menu_bar for more information.

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  Same as set_accessibility_info, but as a builder method

  • fn with_menu_bar:

    • &mut self

    • arg menu_bar: Menu

    • -> Dom

  Sets the context menu for the DOM root node. See NodeData::set_context_menu for more information.

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  Same as set_context_menu, but as a builder method

  • fn with_context_menu:

    • &mut self

    • arg context_menu: Menu

    • -> Dom

  Calculates the hash of this node (note: in order to be truly unique, you also have to hash the DOM and Node ID).

  • fn hash:

    • &self

    • -> u64

  Returns the number of nodes in the DOM, including all child DOM trees. Result is equal to self.total_children + 1 (count of all child trees + the root node)

  • fn node_count:

    • &self

    • -> usize

  Returns a HTML for unit testing

  • fn get_html_string_test:

    • &mut self

    • -> String

  Returns a HTML string that you can write to a file in order to debug the UI structure and debug potential cascading issues

  • fn get_html_string_debug:

    • &mut self

    • -> String

  Same as StyledDom::new(dom, css): NOTE - replaces self with an empty DOM, in order to prevent cloning the DOM entirely

  • fn style:

    • &mut self

    • arg css: Css

    • -> StyledDom

• struct IFrameNode

  callback: IFrameCallback

  data: RefAny

• struct CallbackData

  event: EventFilter

  callback: Callback

  data: RefAny

• Represents one single DOM node (node type, classes, ids and callbacks are stored here)

  struct NodeData

  Stores the type of the node, i.e. div, img, p, etc.

  node_type: NodeType

  dataset attribute of the node, useful to store any UI-related data on the node itself

  dataset: OptionRefAny

  Stores the ids of the node, i.e. [#main, #something]

  ids_and_classes: IdOrClassVec

  Stores the callbacks of the node, i.e. On::MouseUp -> Callback(my_button_click_handler)

  callbacks: CallbackDataVec

  Override certain dynamic styling properties for this DOM node

  inline_css_props: NodeDataInlineCssPropertyVec

  Extra data relevant for this node: Necessary to extend the NodeData without breaking ABI as well as to efficiently store less commonly set options. Default set to nullptr (= None internally)

  extra: *const c_void

  Creates an new, empty NodeData struct

  • constructor new:

    • arg node_type: NodeType

    • -> NodeData

  • constructor body:

    • -> NodeData

  • constructor div:

    • -> NodeData

  • constructor br:

    • -> NodeData

  • constructor text:

    • arg string: String

    • -> NodeData

  • constructor image:

    • arg image: ImageRef

    • -> NodeData

  • constructor iframe:

    • arg data: RefAny

    • arg callback: IFrameCallbackType

    • -> NodeData

  • fn set_node_type:

    • &mut self

    • arg node_type: NodeType

  • fn with_node_type:

    • &mut self

    • arg node_type: NodeType

    • -> NodeData

  • fn set_dataset:

    • &mut self

    • arg dataset: RefAny

  • fn with_dataset:

    • &mut self

    • arg dataset: RefAny

    • -> NodeData

  • fn set_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

  • fn with_ids_and_classes:

    • &mut self

    • arg ids_and_classes: IdOrClassVec

    • -> NodeData

  Adds a callback this DOM (potentially heap-allocates in Rust code)

  • fn add_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

  Same as add_child, but as a builder method.

  • fn with_callback:

    • &mut self

    • arg event: EventFilter

    • arg data: RefAny

    • arg callback: CallbackType

    • -> NodeData

  • fn set_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

  • fn with_callbacks:

    • &mut self

    • arg callbacks: CallbackDataVec

    • -> NodeData

  • fn set_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

  • fn with_inline_css_props:

    • &mut self

    • arg css_properties: NodeDataInlineCssPropertyVec

    • -> NodeData

  Sets the extra.clip_mask field for this node

  • fn set_clip_mask:

    • &mut self

    • arg image_mask: ImageMask

  Sets the tab index for this node

  • fn set_tab_index:

    • &mut self

    • arg tab_index: TabIndex

  Sets accessibility attributes for this node

  • fn set_accessibility_info:

    • &mut self

    • arg accessibility_info: AccessibilityInfo

  Adds a (native) menu bar: If this node is the root node the menu bar will be added to the window, else it will be displayed using the width and position of the bounding rectangle

  • fn set_menu_bar:

    • &mut self

    • arg menu_bar: Menu

  Signalizes that this node has a (native) context-aware menu. If set, the user can left-click the node to open the menu

  • fn set_context_menu:

    • &mut self

    • arg context_menu: Menu

  Calculates the hash of this node (note: in order to be truly unique, you also have to hash the DOM and Node ID).

  • fn hash:

    • &self

    • -> u64

• List of core DOM node types built-into by azul

  union enum NodeType

  body node, usually used to indicate a root node

  Body

  Regular div with no particular type of data attached

  Div

  Creates a break in an inline text layout

  Br

  Equivalent to the HTML <p> tag, a small label that can be (optionally) be selected by the user

  Text(String)

  Equivalent to the HTML <img> tag, references an image or texture

  Image(ImageRef)

  Callback that renders a DOM when invoked with a width / height after the layout of the parent DOM is done. Can be selected in CSS with the "iframe" selector.

  IFrame(IFrameNode)

• When to call a callback action - On::MouseOver, On::MouseOut, etc.

  enum On

  Mouse cursor is hovering over the element

  MouseOver

  Mouse cursor has is over element and is pressed (not good for "click" events - use MouseUp instead)

  MouseDown

  (Specialization of MouseDown). Fires only if the left mouse button has been pressed while cursor was over the element

  LeftMouseDown

  (Specialization of MouseDown). Fires only if the middle mouse button has been pressed while cursor was over the element

  MiddleMouseDown

  (Specialization of MouseDown). Fires only if the right mouse button has been pressed while cursor was over the element

  RightMouseDown

  Mouse button has been released while cursor was over the element

  MouseUp

  (Specialization of MouseUp). Fires only if the left mouse button has been released while cursor was over the element

  LeftMouseUp

  (Specialization of MouseUp). Fires only if the middle mouse button has been released while cursor was over the element

  MiddleMouseUp

  (Specialization of MouseUp). Fires only if the right mouse button has been released while cursor was over the element

  RightMouseUp

  Mouse cursor has entered the element

  MouseEnter

  Mouse cursor has left the element

  MouseLeave

  Mousewheel / touchpad scrolling

  Scroll

  The window received a unicode character (also respects the system locale)

  TextInput

  Check keyboard_state.current_char to get the current pressed character

  VirtualKeyDown

  A virtual keycode was pressed. Note: This is only the virtual keycode, not the actual char. If you want to get the character, use TextInput instead. NOTE: A virtual key does not have to map to a printable character. You can get all currently pressed virtual keycodes in the keyboard_state.current_virtual_keycodes and / or just the last keycode in the keyboard_state.latest_virtual_keycode.

  VirtualKeyUp

  HoveredFile

  DroppedFile

  HoveredFileCancelled

  FocusReceived

  FocusLost

  Converts the On shorthand into a EventFilter

  • fn into_event_filter:

    • self

    • -> EventFilter

• union enum EventFilter

  Hover(HoverEventFilter)

  Not(NotEventFilter)

  Focus(FocusEventFilter)

  Window(WindowEventFilter)

  Component(ComponentEventFilter)

  Application(ApplicationEventFilter)

• enum HoverEventFilter

  MouseOver

  MouseDown

  LeftMouseDown

  RightMouseDown

  MiddleMouseDown

  MouseUp

  LeftMouseUp

  RightMouseUp

  MiddleMouseUp

  MouseEnter

  MouseLeave

  Scroll

  ScrollStart

  ScrollEnd

  TextInput

  VirtualKeyDown

  VirtualKeyUp

  HoveredFile

  DroppedFile

  HoveredFileCancelled

  TouchStart

  TouchMove

  TouchEnd

  TouchCancel

• enum FocusEventFilter

  MouseOver

  MouseDown

  LeftMouseDown

  RightMouseDown

  MiddleMouseDown

  MouseUp

  LeftMouseUp

  RightMouseUp

  MiddleMouseUp

  MouseEnter

  MouseLeave

  Scroll

  ScrollStart

  ScrollEnd

  TextInput

  VirtualKeyDown

  VirtualKeyUp

  FocusReceived

  FocusLost

• union enum NotEventFilter

  Hover(HoverEventFilter)

  Focus(FocusEventFilter)

• enum WindowEventFilter

  MouseOver

  MouseDown

  LeftMouseDown

  RightMouseDown

  MiddleMouseDown

  MouseUp

  LeftMouseUp

  RightMouseUp

  MiddleMouseUp

  MouseEnter

  MouseLeave

  Scroll

  ScrollStart

  ScrollEnd

  TextInput

  VirtualKeyDown

  VirtualKeyUp

  HoveredFile

  DroppedFile

  HoveredFileCancelled

  Resized

  Moved

  TouchStart

  TouchMove

  TouchEnd

  TouchCancel

  FocusReceived

  FocusLost

  CloseRequested

  ThemeChanged

• enum ComponentEventFilter

  Node has been added. Internally the DOM tree is diffed and this event fires only once.

  AfterMount

  Node has been removed (DOM tree has been exchanged)

  BeforeUnmount

  Item has been resized

  NodeResized

  Performs the "default action", necessary for accessibility

  DefaultAction

  Item has been selected using assistive technology (e.g. screen reader)

  Selected

• enum ApplicationEventFilter

  DeviceConnected

  DeviceDisconnected

• Accessibility information (MSAA wrapper). See NodeData.set_accessibility_info()

  struct AccessibilityInfo

  Get the "name" of the IAccessible, for example the name of a button, checkbox or menu item. Try to use unique names for each item in a dialog so that voice dictation software doesn't have to deal with extra ambiguity

  name: OptionString

  Get the "value" of the IAccessible, for example a number in a slider, a URL for a link, the text a user entered in a field.

  value: OptionString

  Get an enumerated value representing what this IAccessible is used for, for example is it a link, static text, editable text, a checkbox, or a table cell, etc.

  role: AccessibilityRole

  Possible on/off states, such as focused, focusable, selected, selectable, visible, protected (for passwords), checked, etc.

  states: AccessibilityStateVec

  Optional keyboard accelerator

  accelerator: OptionVirtualKeyCodeCombo

  Optional "default action" description. Only used when there is at least one ComponentEventFilter::DefaultAction callback present on this node

  default_action: OptionString

• MSAA Accessibility role constants. For information on what each role does, see the <a href="https://docs.microsoft.com/en-us/windows/win32/winauto/object-roles">MSDN Role Constants page</a>

  enum AccessibilityRole

  Inserted by operating system

  TitleBar

  MenuBar

  ScrollBar

  Grip

  Sound

  Cursor

  Caret

  Alert

  Inserted by operating system

  Window

  Client

  MenuPopup

  MenuItem

  Tooltip

  Application

  Document

  Pane

  Chart

  Dialog

  Border

  Grouping

  Separator

  Toolbar

  StatusBar

  Table

  ColumnHeader

  RowHeader

  Column

  Row

  Cell

  Link

  HelpBalloon

  Character

  List

  ListItem

  Outline

  OutlineItem

  Pagetab

  PropertyPage

  Indicator

  Graphic

  StaticText

  Text

  PushButton

  CheckButton

  RadioButton

  ComboBox

  DropList

  ProgressBar

  Dial

  HotkeyField

  Slider

  SpinButton

  Diagram

  Animation

  Equation

  ButtonDropdown

  ButtonMenu

  ButtonDropdownGrid

  Whitespace

  PageTabList

  Clock

  SplitButton

  IpAddress

  Nothing

• MSAA accessibility state. For information on what each state does, see the <a href="https://docs.microsoft.com/en-us/windows/win32/winauto/object-state-constants">MSDN State Constants page</a>.

  enum AccessibilityState

  Unavailable

  Selected

  Focused

  Checked

  Readonly

  Default

  Expanded

  Collapsed

  Busy

  Offscreen

  Focusable

  Selectable

  Linked

  Traversed

  Multiselectable

  Protected

• union enum TabIndex

  Automatic tab index, similar to simply setting focusable = "true" or tabindex = 0, (both have the effect of making the element focusable)

  Auto

  Set the tab index in relation to its parent element (tabindex = n)

  OverrideInParent(u32)

  Elements can be focused in callbacks, but are not accessible via keyboard / tab navigation (tabindex = -1 )

  NoKeyboardFocus

• union enum IdOrClass

  Id(String)

  Class(String)

• union enum NodeDataInlineCssProperty

  Normal(CssProperty)

  Active(CssProperty)

  Focus(CssProperty)

  Hover(CssProperty)

mod menu:

• Menu struct (application / window menu, dropdown menu, context menu). Modeled after the Windows API

  struct Menu

  Items in this menu

  items: MenuItemVec

• Item entry in a menu or menu bar

  union enum MenuItem

  Regular "labeled" menu item

  Label(StringMenuItem)

  Line separator, usually only rendered in vertical menus

  Separator

  Breaks items in a menu onto separate lines, usually only rendered in horizontal menu bars

  BreakLine

  Creates a new menu item

  • constructor new:

    • arg label: String

    • arg callback: OptionMenuCallback

    • -> MenuItem

• Regular labeled menu item

  struct StringMenuItem

  Label of the menu entry

  label: String

  Optional accelerator combination, (ex. "CTRL + X" = [VirtualKeyCode::Ctrl, VirtualKeyCode::X]) for keyboard shortcut

  accelerator: OptionVirtualKeyCodeCombo

  Optional callback to call when the item is activated

  callback: OptionMenuCallback

  State of the menu entry (normal, greyed, disabled)

  state: MenuItemState

  Optional icon (checkbox or custom image) of the menu entry

  icon: OptionMenuItemIcon

  Sub-menus of the window (empty by default)

  children: MenuItemVec

  Creates a new menu item

  • constructor new:

    • arg label: String

    • -> StringMenuItem

  Adds a child submenu to the current menu

  • fn add_child:

    • &mut self

    • arg child: MenuItem

  Adds a child submenu to the current menu

  • fn with_child:

    • &mut self

    • arg child: MenuItem

    • -> StringMenuItem

• Combination of virtual key codes that have to be pressed together

  struct VirtualKeyCodeCombo

  keys: VirtualKeyCodeVec

• Similar to dom.CallbackData, stores some data + a callback to call when the menu is activated

  struct MenuCallback

  Callback to be called when the menu item is clicked

  callback: Callback

  Data of the callback to be called on

  data: RefAny

• Icon of a menu entry

  union enum MenuItemIcon

  Menu item shows a checkbox (either checked or not)

  Checkbox(bool)

  Menu item shows a custom image, usually in 16x16 format

  Image(ImageRef)

• Describes the state of a menu item

  enum MenuItemState

  Normal menu item (default)

  Normal

  Menu item is greyed out and clicking it does nothing

  Greyed

  Menu item is disabled, clicking it does nothing - but NOT greyed out

  Disabled

Css parsing module

mod css:

• struct CssRuleBlock

  path: CssPath

  declarations: CssDeclarationVec

• union enum CssDeclaration

  Static(CssProperty)

  Dynamic(DynamicCssProperty)

• struct DynamicCssProperty

  dynamic_id: String

  default_value: CssProperty

• struct CssPath

  selectors: CssPathSelectorVec

• union enum CssPathSelector

  Global

  Type(NodeTypeKey)

  Class(String)

  Id(String)

  PseudoSelector(CssPathPseudoSelector)

  DirectChildren

  Children

• enum NodeTypeKey

  Body

  Div

  Br

  P

  Img

  IFrame

• union enum CssPathPseudoSelector

  First

  Last

  NthChild(CssNthChildSelector)

  Hover

  Active

  Focus

• union enum CssNthChildSelector

  Number(u32)

  Even

  Odd

  Pattern(CssNthChildPattern)

• struct CssNthChildPattern

  repeat: u32

  offset: u32

• struct Stylesheet

  rules: CssRuleBlockVec

• struct Css

  stylesheets: StylesheetVec

  Returns an empty CSS style

  • constructor empty:

    • -> Css

  Returns a CSS style parsed from a String

  • constructor from_string:

    • arg s: String

    • -> Css

• enum CssPropertyType

  TextColor

  FontSize

  FontFamily

  TextAlign

  LetterSpacing

  LineHeight

  WordSpacing

  TabWidth

  Cursor

  Display

  Float

  BoxSizing

  Width

  Height

  MinWidth

  MinHeight

  MaxWidth

  MaxHeight

  Position

  Top

  Right

  Left

  Bottom

  FlexWrap

  FlexDirection

  FlexGrow

  FlexShrink

  JustifyContent

  AlignItems

  AlignContent

  BackgroundContent

  BackgroundPosition

  BackgroundSize

  BackgroundRepeat

  OverflowX

  OverflowY

  PaddingTop

  PaddingLeft

  PaddingRight

  PaddingBottom

  MarginTop

  MarginLeft

  MarginRight

  MarginBottom

  BorderTopLeftRadius

  BorderTopRightRadius

  BorderBottomLeftRadius

  BorderBottomRightRadius

  BorderTopColor

  BorderRightColor

  BorderLeftColor

  BorderBottomColor

  BorderTopStyle

  BorderRightStyle

  BorderLeftStyle

  BorderBottomStyle

  BorderTopWidth

  BorderRightWidth

  BorderLeftWidth

  BorderBottomWidth

  BoxShadowLeft

  BoxShadowRight

  BoxShadowTop

  BoxShadowBottom

  ScrollbarStyle

  Opacity

  Transform

  TransformOrigin

  PerspectiveOrigin

  BackfaceVisibility

• union enum AnimationInterpolationFunction

  Ease

  Linear

  EaseIn

  EaseOut

  EaseInOut

  CubicBezier(SvgCubicCurve)

• struct InterpolateContext

  animation_func: AnimationInterpolationFunction

  parent_rect_width: f32

  parent_rect_height: f32

  current_rect_width: f32

  current_rect_height: f32

• struct ColorU

  r: u8

  g: u8

  b: u8

  a: u8

  • constructor from_str:

    • arg string: String

    • -> ColorU

  • fn to_hash:

    • &self

    • -> String

• enum SizeMetric

  Px

  Pt

  Em

  Percent

• struct FloatValue

  number: isize

• struct PixelValue

  metric: SizeMetric

  number: FloatValue

• struct PixelValueNoPercent

  inner: PixelValue

• enum BoxShadowClipMode

  Outset

  Inset

• struct StyleBoxShadow

  offset: [PixelValueNoPercent;2]

  color: ColorU

  blur_radius: PixelValueNoPercent

  spread_radius: PixelValueNoPercent

  clip_mode: BoxShadowClipMode

• enum LayoutAlignContent

  Default value. Lines stretch to take up the remaining space

  Stretch

  Lines are packed toward the center of the flex container

  Center

  Lines are packed toward the start of the flex container

  Start

  Lines are packed toward the end of the flex container

  End

  Lines are evenly distributed in the flex container

  SpaceBetween

  Lines are evenly distributed in the flex container, with half-size spaces on either end

  SpaceAround

• enum LayoutAlignItems

  Items are stretched to fit the container

  Stretch

  Items are positioned at the center of the container

  Center

  Items are positioned at the beginning of the container

  FlexStart

  Items are positioned at the end of the container

  FlexEnd

• struct LayoutBottom

  inner: PixelValue

• enum LayoutBoxSizing

  ContentBox

  BorderBox

• enum LayoutFlexDirection

  Row

  RowReverse

  Column

  ColumnReverse

• enum LayoutDisplay

  None

  Flex

  Block

  InlineBlock

• struct LayoutFlexGrow

  inner: FloatValue

• struct LayoutFlexShrink

  inner: FloatValue

• enum LayoutFloat

  Left

  Right

• struct LayoutHeight

  inner: PixelValue

• enum LayoutJustifyContent

  Default value. Items are positioned at the beginning of the container

  Start

  Items are positioned at the end of the container

  End

  Items are positioned at the center of the container

  Center

  Items are positioned with space between the lines

  SpaceBetween

  Items are positioned with space before, between, and after the lines

  SpaceAround

  Items are distributed so that the spacing between any two adjacent alignment subjects, before the first alignment subject, and after the last alignment subject is the same

  SpaceEvenly

• struct LayoutLeft

  inner: PixelValue

• struct LayoutMarginBottom

  inner: PixelValue

• struct LayoutMarginLeft

  inner: PixelValue

• struct LayoutMarginRight

  inner: PixelValue

• struct LayoutMarginTop

  inner: PixelValue

• struct LayoutMaxHeight

  inner: PixelValue

• struct LayoutMaxWidth

  inner: PixelValue

• struct LayoutMinHeight

  inner: PixelValue

• struct LayoutMinWidth

  inner: PixelValue

• struct LayoutPaddingBottom

  inner: PixelValue

• struct LayoutPaddingLeft

  inner: PixelValue

• struct LayoutPaddingRight

  inner: PixelValue

• struct LayoutPaddingTop

  inner: PixelValue

• enum LayoutPosition

  Static

  Relative

  Absolute

  Fixed

• struct LayoutRight

  inner: PixelValue

• struct LayoutTop

  inner: PixelValue

• struct LayoutWidth

  inner: PixelValue

• enum LayoutFlexWrap

  Wrap

  NoWrap

• enum LayoutOverflow

  Always shows a scroll bar, overflows on scroll

  Scroll

  Does not show a scroll bar by default, only when text is overflowing

  Auto

  Never shows a scroll bar, simply clips text

  Hidden

  Doesn't show a scroll bar, simply overflows the text

  Visible

• struct PercentageValue

  number: FloatValue

• enum AngleMetric

  Degree

  Radians

  Grad

  Turn

  Percent

• struct AngleValue

  metric: AngleMetric

  number: FloatValue

• struct NormalizedLinearColorStop

  offset: PercentageValue

  color: ColorU

• struct NormalizedRadialColorStop

  offset: AngleValue

  color: ColorU

• enum DirectionCorner

  Right

  Left

  Top

  Bottom

  TopRight

  TopLeft

  BottomRight

  BottomLeft

• struct DirectionCorners

  from: DirectionCorner

  to: DirectionCorner

• union enum Direction

  Angle(AngleValue)

  FromTo(DirectionCorners)

• enum ExtendMode

  Clamp

  Repeat

• struct LinearGradient

  direction: Direction

  extend_mode: ExtendMode

  stops: NormalizedLinearColorStopVec

• enum Shape

  Ellipse

  Circle

• enum RadialGradientSize

  The gradients ending shape meets the side of the box closest to its center (for circles) or meets both the vertical and horizontal sides closest to the center (for ellipses)

  ClosestSide

  The gradients ending shape is sized so that it exactly meets the closest corner of the box from its center

  ClosestCorner

  Similar to closest-side, except the ending shape is sized to meet the side of the box farthest from its center (or vertical and horizontal sides)

  FarthestSide

  The default value, the gradient's ending shape is sized so that it exactly meets the farthest corner of the box from its center

  FarthestCorner

• struct RadialGradient

  shape: Shape

  size: RadialGradientSize

  position: StyleBackgroundPosition

  extend_mode: ExtendMode

  stops: NormalizedLinearColorStopVec

• struct ConicGradient

  extend_mode: ExtendMode

  center: StyleBackgroundPosition

  angle: AngleValue

  stops: NormalizedRadialColorStopVec

• union enum StyleBackgroundContent

  LinearGradient(LinearGradient)

  RadialGradient(RadialGradient)

  ConicGradient(ConicGradient)

  Image(String)

  Color(ColorU)

• union enum BackgroundPositionHorizontal

  Left

  Center

  Right

  Exact(PixelValue)

• union enum BackgroundPositionVertical

  Top

  Center

  Bottom

  Exact(PixelValue)

• struct StyleBackgroundPosition

  horizontal: BackgroundPositionHorizontal

  vertical: BackgroundPositionVertical

• enum StyleBackgroundRepeat

  NoRepeat

  Repeat

  RepeatX

  RepeatY

• union enum StyleBackgroundSize

  ExactSize([PixelValue;2])

  Contain

  Cover

• struct StyleBorderBottomColor

  inner: ColorU

• struct StyleBorderBottomLeftRadius

  inner: PixelValue

• struct StyleBorderBottomRightRadius

  inner: PixelValue

• enum BorderStyle

  None

  Solid

  Double

  Dotted

  Dashed

  Hidden

  Groove

  Ridge

  Inset

  Outset

• struct StyleBorderBottomStyle

  inner: BorderStyle

• struct LayoutBorderBottomWidth

  inner: PixelValue

• struct StyleBorderLeftColor

  inner: ColorU

• struct StyleBorderLeftStyle

  inner: BorderStyle

• struct LayoutBorderLeftWidth

  inner: PixelValue

• struct StyleBorderRightColor

  inner: ColorU

• struct StyleBorderRightStyle

  inner: BorderStyle

• struct LayoutBorderRightWidth

  inner: PixelValue

• struct StyleBorderTopColor

  inner: ColorU

• struct StyleBorderTopLeftRadius

  inner: PixelValue

• struct StyleBorderTopRightRadius

  inner: PixelValue

• struct StyleBorderTopStyle

  inner: BorderStyle

• struct LayoutBorderTopWidth

  inner: PixelValue

• struct ScrollbarInfo

  width: LayoutWidth

  padding_left: LayoutPaddingLeft

  padding_right: LayoutPaddingRight

  track: StyleBackgroundContent

  thumb: StyleBackgroundContent

  button: StyleBackgroundContent

  corner: StyleBackgroundContent

  resizer: StyleBackgroundContent

• struct ScrollbarStyle

  horizontal: ScrollbarInfo

  vertical: ScrollbarInfo

• enum StyleCursor

  Alias

  AllScroll

  Cell

  ColResize

  ContextMenu

  Copy

  Crosshair

  Default

  EResize

  EwResize

  Grab

  Grabbing

  Help

  Move

  NResize

  NsResize

  NeswResize

  NwseResize

  Pointer

  Progress

  RowResize

  SResize

  SeResize

  Text

  Unset

  VerticalText

  WResize

  Wait

  ZoomIn

  ZoomOut

• union enum StyleFontFamily

  Postscript identifier for a system-native font (for example "Arial"). Also supports HTML-native values such as sans-serif, serif, monospace, fantasy and oblique.

  System(String)

  Path to a font loaded from a file

  File(String)

  Reference-counted font bytes - usually used on nodes that have to must be rendered with a specific font

  Ref(FontRef)

• struct StyleFontSize

  inner: PixelValue

• struct StyleLetterSpacing

  inner: PixelValue

• struct StyleLineHeight

  inner: PercentageValue

• struct StyleTabWidth

  inner: PercentageValue

• struct StyleOpacity

  inner: PercentageValue

• struct StyleTransformOrigin

  x: PixelValue

  y: PixelValue

• struct StylePerspectiveOrigin

  x: PixelValue

  y: PixelValue

• enum StyleBackfaceVisibility

  Hidden

  Visible

• union enum StyleTransform

  Matrix(StyleTransformMatrix2D)

  Matrix3D(StyleTransformMatrix3D)

  Translate(StyleTransformTranslate2D)

  Translate3D(StyleTransformTranslate3D)

  TranslateX(PixelValue)

  TranslateY(PixelValue)

  TranslateZ(PixelValue)

  Rotate(AngleValue)

  Rotate3D(StyleTransformRotate3D)

  RotateX(AngleValue)

  RotateY(AngleValue)

  RotateZ(AngleValue)

  Scale(StyleTransformScale2D)

  Scale3D(StyleTransformScale3D)

  ScaleX(PercentageValue)

  ScaleY(PercentageValue)

  ScaleZ(PercentageValue)

  Skew(StyleTransformSkew2D)

  SkewX(PercentageValue)

  SkewY(PercentageValue)

  Perspective(PixelValue)

• struct StyleTransformMatrix2D

  a: PixelValue

  b: PixelValue

  c: PixelValue

  d: PixelValue

  tx: PixelValue

  ty: PixelValue

• struct StyleTransformMatrix3D

  m11: PixelValue

  m12: PixelValue

  m13: PixelValue

  m14: PixelValue

  m21: PixelValue

  m22: PixelValue

  m23: PixelValue

  m24: PixelValue

  m31: PixelValue

  m32: PixelValue

  m33: PixelValue

  m34: PixelValue

  m41: PixelValue

  m42: PixelValue

  m43: PixelValue

  m44: PixelValue

• struct StyleTransformTranslate2D

  x: PixelValue

  y: PixelValue

• struct StyleTransformTranslate3D

  x: PixelValue

  y: PixelValue

  z: PixelValue

• struct StyleTransformRotate3D

  x: PercentageValue

  y: PercentageValue

  z: PercentageValue

  angle: AngleValue

• struct StyleTransformScale2D

  x: PercentageValue

  y: PercentageValue

• struct StyleTransformScale3D

  x: PercentageValue

  y: PercentageValue

  z: PercentageValue

• struct StyleTransformSkew2D

  x: PercentageValue

  y: PercentageValue

• enum StyleTextAlign

  Left

  Center

  Right

• struct StyleTextColor

  inner: ColorU

• struct StyleWordSpacing

  inner: PixelValue

• union enum StyleBoxShadowValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBoxShadow)

• union enum LayoutAlignContentValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutAlignContent)

• union enum LayoutAlignItemsValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutAlignItems)

• union enum LayoutBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBottom)

• union enum LayoutBoxSizingValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBoxSizing)

• union enum LayoutFlexDirectionValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexDirection)

• union enum LayoutDisplayValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutDisplay)

• union enum LayoutFlexGrowValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexGrow)

• union enum LayoutFlexShrinkValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexShrink)

• union enum LayoutFloatValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFloat)

• union enum LayoutHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutHeight)

• union enum LayoutJustifyContentValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutJustifyContent)

• union enum LayoutLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutLeft)

• union enum LayoutMarginBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginBottom)

• union enum LayoutMarginLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginLeft)

• union enum LayoutMarginRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginRight)

• union enum LayoutMarginTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMarginTop)

• union enum LayoutMaxHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMaxHeight)

• union enum LayoutMaxWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMaxWidth)

• union enum LayoutMinHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMinHeight)

• union enum LayoutMinWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutMinWidth)

• union enum LayoutPaddingBottomValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingBottom)

• union enum LayoutPaddingLeftValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingLeft)

• union enum LayoutPaddingRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingRight)

• union enum LayoutPaddingTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPaddingTop)

• union enum LayoutPositionValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutPosition)

• union enum LayoutRightValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutRight)

• union enum LayoutTopValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutTop)

• union enum LayoutWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutWidth)

• union enum LayoutFlexWrapValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutFlexWrap)

• union enum LayoutOverflowValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutOverflow)

• union enum ScrollbarStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(ScrollbarStyle)

• union enum StyleBackgroundContentVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundContentVec)

• union enum StyleBackgroundPositionVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundPositionVec)

• union enum StyleBackgroundRepeatVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundRepeatVec)

• union enum StyleBackgroundSizeVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackgroundSizeVec)

• union enum StyleBorderBottomColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomColor)

• union enum StyleBorderBottomLeftRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomLeftRadius)

• union enum StyleBorderBottomRightRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomRightRadius)

• union enum StyleBorderBottomStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderBottomStyle)

• union enum LayoutBorderBottomWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderBottomWidth)

• union enum StyleBorderLeftColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderLeftColor)

• union enum StyleBorderLeftStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderLeftStyle)

• union enum LayoutBorderLeftWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderLeftWidth)

• union enum StyleBorderRightColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderRightColor)

• union enum StyleBorderRightStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderRightStyle)

• union enum LayoutBorderRightWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderRightWidth)

• union enum StyleBorderTopColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopColor)

• union enum StyleBorderTopLeftRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopLeftRadius)

• union enum StyleBorderTopRightRadiusValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopRightRadius)

• union enum StyleBorderTopStyleValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBorderTopStyle)

• union enum LayoutBorderTopWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(LayoutBorderTopWidth)

• union enum StyleCursorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleCursor)

• union enum StyleFontFamilyVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleFontFamilyVec)

• union enum StyleFontSizeValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleFontSize)

• union enum StyleLetterSpacingValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleLetterSpacing)

• union enum StyleLineHeightValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleLineHeight)

• union enum StyleTabWidthValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTabWidth)

• union enum StyleTextAlignValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTextAlign)

• union enum StyleTextColorValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTextColor)

• union enum StyleWordSpacingValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleWordSpacing)

• union enum StyleOpacityValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleOpacity)

• union enum StyleTransformVecValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTransformVec)

• union enum StyleTransformOriginValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleTransformOrigin)

• union enum StylePerspectiveOriginValue

  Auto

  None

  Inherit

  Initial

  Exact(StylePerspectiveOrigin)

• union enum StyleBackfaceVisibilityValue

  Auto

  None

  Inherit

  Initial

  Exact(StyleBackfaceVisibility)

• Parsed CSS key-value pair

  union enum CssProperty

  TextColor(StyleTextColorValue)

  FontSize(StyleFontSizeValue)

  FontFamily(StyleFontFamilyVecValue)

  TextAlign(StyleTextAlignValue)

  LetterSpacing(StyleLetterSpacingValue)

  LineHeight(StyleLineHeightValue)

  WordSpacing(StyleWordSpacingValue)

  TabWidth(StyleTabWidthValue)

  Cursor(StyleCursorValue)

  Display(LayoutDisplayValue)

  Float(LayoutFloatValue)

  BoxSizing(LayoutBoxSizingValue)

  Width(LayoutWidthValue)

  Height(LayoutHeightValue)

  MinWidth(LayoutMinWidthValue)

  MinHeight(LayoutMinHeightValue)

  MaxWidth(LayoutMaxWidthValue)

  MaxHeight(LayoutMaxHeightValue)

  Position(LayoutPositionValue)

  Top(LayoutTopValue)

  Right(LayoutRightValue)

  Left(LayoutLeftValue)

  Bottom(LayoutBottomValue)

  FlexWrap(LayoutFlexWrapValue)

  FlexDirection(LayoutFlexDirectionValue)

  FlexGrow(LayoutFlexGrowValue)

  FlexShrink(LayoutFlexShrinkValue)

  JustifyContent(LayoutJustifyContentValue)

  AlignItems(LayoutAlignItemsValue)

  AlignContent(LayoutAlignContentValue)

  BackgroundContent(StyleBackgroundContentVecValue)

  BackgroundPosition(StyleBackgroundPositionVecValue)

  BackgroundSize(StyleBackgroundSizeVecValue)

  BackgroundRepeat(StyleBackgroundRepeatVecValue)

  OverflowX(LayoutOverflowValue)

  OverflowY(LayoutOverflowValue)

  PaddingTop(LayoutPaddingTopValue)

  PaddingLeft(LayoutPaddingLeftValue)

  PaddingRight(LayoutPaddingRightValue)

  PaddingBottom(LayoutPaddingBottomValue)

  MarginTop(LayoutMarginTopValue)

  MarginLeft(LayoutMarginLeftValue)

  MarginRight(LayoutMarginRightValue)

  MarginBottom(LayoutMarginBottomValue)

  BorderTopLeftRadius(StyleBorderTopLeftRadiusValue)

  BorderTopRightRadius(StyleBorderTopRightRadiusValue)

  BorderBottomLeftRadius(StyleBorderBottomLeftRadiusValue)

  BorderBottomRightRadius(StyleBorderBottomRightRadiusValue)

  BorderTopColor(StyleBorderTopColorValue)

  BorderRightColor(StyleBorderRightColorValue)

  BorderLeftColor(StyleBorderLeftColorValue)

  BorderBottomColor(StyleBorderBottomColorValue)

  BorderTopStyle(StyleBorderTopStyleValue)

  BorderRightStyle(StyleBorderRightStyleValue)

  BorderLeftStyle(StyleBorderLeftStyleValue)

  BorderBottomStyle(StyleBorderBottomStyleValue)

  BorderTopWidth(LayoutBorderTopWidthValue)

  BorderRightWidth(LayoutBorderRightWidthValue)

  BorderLeftWidth(LayoutBorderLeftWidthValue)

  BorderBottomWidth(LayoutBorderBottomWidthValue)

  BoxShadowLeft(StyleBoxShadowValue)

  BoxShadowRight(StyleBoxShadowValue)

  BoxShadowTop(StyleBoxShadowValue)

  BoxShadowBottom(StyleBoxShadowValue)

  ScrollbarStyle(ScrollbarStyleValue)

  Opacity(StyleOpacityValue)

  Transform(StyleTransformVecValue)

  TransformOrigin(StyleTransformOriginValue)

  PerspectiveOrigin(StylePerspectiveOriginValue)

  BackfaceVisibility(StyleBackfaceVisibilityValue)

  Returns the key of the CSS property as a string, i.e. background

  • fn get_key_string:

    • &self

    • -> String

  Returns the value of the CSS property as a string, i.e. linear-gradient(red, blue)

  • fn get_value_string:

    • &self

    • -> String

  Returns the CSS key-value pair as a string, i.e. background: linear-gradient(red, blue)

  • fn get_key_value_string:

    • &self

    • -> String

  Interpolates two CSS properties given a value t ranging from 0.0 to 1.0. The interpolation function can be set on the context (Ease, Linear, etc.).

  • fn interpolate:

    • &self

    • arg other: CssProperty

    • arg t: f32

    • arg context: InterpolateContext

    • -> CssProperty

Default, built-in widgets (button, label, textinput, etc.)

mod widgets:

• struct Button

  label: String

  image: OptionImageRef

  container_style: NodeDataInlineCssPropertyVec

  label_style: NodeDataInlineCssPropertyVec

  image_style: NodeDataInlineCssPropertyVec

  on_click: OptionButtonOnClick

  Creates a new labeled button

  • constructor new:

    • arg label: String

    • -> Button

  • fn set_on_click:

    • &mut self

    • arg data: RefAny

    • arg callback: CallbackType

  • fn with_on_click:

    • &mut self

    • arg data: RefAny

    • arg callback: CallbackType

    • -> Button

  • fn dom:

    • &mut self

    • -> Dom

• struct ButtonOnClick

  data: RefAny

  callback: Callback

• struct CheckBox

  state: CheckBoxStateWrapper

  container_style: NodeDataInlineCssPropertyVec

  content_style: NodeDataInlineCssPropertyVec

  Creates a new checkbox, disabled or enabled

  • constructor new:

    • arg checked: bool

    • -> CheckBox

  • fn set_on_toggle:

    • &mut self

    • arg data: RefAny

    • arg callback: CheckBoxOnToggleCallbackType

  • fn with_on_toggle:

    • &mut self

    • arg data: RefAny

    • arg callback: CheckBoxOnToggleCallbackType

    • -> CheckBox

  • fn dom:

    • &mut self

    • -> Dom

• struct CheckBoxStateWrapper

  inner: CheckBoxState

  on_toggle: OptionCheckBoxOnToggle

• struct CheckBoxOnToggle

  data: RefAny

  callback: CheckBoxOnToggleCallback

• struct CheckBoxOnToggleCallback

  cb: CheckBoxOnToggleCallbackType

• fnptr CheckBoxOnToggleCallbackType

  • arg &mut RefAny

  • arg & CheckBoxState

  • arg &mut CallbackInfo

  -> Update

• struct CheckBoxState

  checked: bool

• struct Label

  text: String

  style: NodeDataInlineCssPropertyVec

  • constructor new:

    • arg text: String

    • -> Label

  • fn dom:

    • &mut self

    • -> Dom

• struct ColorInput

  state: ColorInputStateWrapper

  style: NodeDataInlineCssPropertyVec

  • constructor new:

    • arg color: ColorU

    • -> ColorInput

  • fn set_on_value_change:

    • &mut self

    • arg data: RefAny

    • arg callback: ColorInputOnValueChangeCallbackType

  • fn with_on_value_change:

    • &mut self

    • arg data: RefAny

    • arg callback: ColorInputOnValueChangeCallbackType

    • -> ColorInput

  • fn dom:

    • &mut self

    • -> Dom

• struct ColorInputStateWrapper

  inner: ColorInputState

  title: String

  on_value_change: OptionColorInputOnValueChange

• struct ColorInputState

  color: ColorU

• struct ColorInputOnValueChange

  data: RefAny

  callback: ColorInputOnValueChangeCallback

• struct ColorInputOnValueChangeCallback

  cb: ColorInputOnValueChangeCallbackType

• fnptr ColorInputOnValueChangeCallbackType

  • arg &mut RefAny

  • arg & ColorInputState

  • arg &mut CallbackInfo

  -> Update

• struct TextInput

  state: TextInputStateWrapper

  placeholder_style: NodeDataInlineCssPropertyVec

  container_style: NodeDataInlineCssPropertyVec

  label_style: NodeDataInlineCssPropertyVec

  • constructor new:

    • arg initial_text: String

    • -> TextInput

  • fn set_on_text_input:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnTextInputCallbackType

  • fn with_on_text_input:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnTextInputCallbackType

    • -> TextInput

  • fn set_on_virtual_key_down:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnVirtualKeyDownCallbackType

  • fn with_on_virtual_key_down:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnVirtualKeyDownCallbackType

    • -> TextInput

  • fn set_on_focus_lost:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnFocusLostCallbackType

  • fn with_on_focus_lost:

    • &mut self

    • arg data: RefAny

    • arg callback: TextInputOnFocusLostCallbackType

    • -> TextInput

  • fn set_placeholder_style:

    • &mut self

    • arg placeholder_style: NodeDataInlineCssPropertyVec

  • fn with_placeholder_style:

    • &mut self

    • arg placeholder_style: NodeDataInlineCssPropertyVec

    • -> TextInput

  • fn set_container_style:

    • &mut self

    • arg container_style: NodeDataInlineCssPropertyVec

  • fn with_container_style:

    • &mut self

    • arg container_style: NodeDataInlineCssPropertyVec

    • -> TextInput

  • fn set_label_style:

    • &mut self

    • arg label_style: NodeDataInlineCssPropertyVec

  • fn with_label_style:

    • &mut self

    • arg label_style: NodeDataInlineCssPropertyVec

    • -> TextInput

  • fn dom:

    • &mut self

    • -> Dom

• struct TextInputStateWrapper

  inner: TextInputState

  on_text_input: OptionTextInputOnTextInput

  on_virtual_key_down: OptionTextInputOnVirtualKeyDown

  on_focus_lost: OptionTextInputOnFocusLost

  update_text_input_before_calling_focus_lost_fn: bool

  update_text_input_before_calling_vk_down_fn: bool

• struct TextInputState

  text: U32Vec

  placeholder: OptionString

  max_len: usize

  selection: OptionTextInputSelection

  cursor_pos: usize

• union enum TextInputSelection

  All

  FromTo(TextInputSelectionRange)

• struct TextInputSelectionRange

  from: usize

  to: usize

• struct TextInputOnTextInput

  data: RefAny

  callback: TextInputOnTextInputCallback

• struct TextInputOnTextInputCallback

  cb: TextInputOnTextInputCallbackType

• fnptr TextInputOnTextInputCallbackType

  • arg &mut RefAny

  • arg & TextInputState

  • arg &mut CallbackInfo

  -> OnTextInputReturn

• struct TextInputOnVirtualKeyDown

  data: RefAny

  callback: TextInputOnVirtualKeyDownCallback

• struct TextInputOnVirtualKeyDownCallback

  cb: TextInputOnVirtualKeyDownCallbackType

• fnptr TextInputOnVirtualKeyDownCallbackType

  • arg &mut RefAny

  • arg & TextInputState

  • arg &mut CallbackInfo

  -> OnTextInputReturn

• struct TextInputOnFocusLost

  data: RefAny

  callback: TextInputOnFocusLostCallback

• struct TextInputOnFocusLostCallback

  cb: TextInputOnFocusLostCallbackType

• fnptr TextInputOnFocusLostCallbackType

  • arg &mut RefAny

  • arg & TextInputState

  • arg &mut CallbackInfo

  -> Update

• struct OnTextInputReturn

  update: Update

  valid: TextInputValid

• enum TextInputValid

  Yes

  No

• struct NumberInput

  text_input: TextInput

  state: NumberInputStateWrapper

  • constructor new:

    • arg number: f32

    • -> NumberInput

• struct NumberInputStateWrapper

  inner: NumberInputState

  on_value_change: OptionNumberInputOnValueChange

• struct NumberInputState

  previous: f32

  number: f32

  min: f32

  max: f32

• struct NumberInputOnValueChange

  data: RefAny

  callback: NumberInputOnValueChangeCallback

• struct NumberInputOnValueChangeCallback

  cb: NumberInputOnValueChangeCallbackType

• fnptr NumberInputOnValueChangeCallbackType

  • arg &mut RefAny

  • arg & NumberInputState

  • arg &mut CallbackInfo

  -> Update

DOM to CSS cascading and styling module

mod style:

• struct Node

  parent: usize

  previous_sibling: usize

  next_sibling: usize

  last_child: usize

• struct CascadeInfo

  index_in_parent: u32

  is_last_child: bool

• union enum CssPropertySource

  Css(CssPath)

  Inline

• struct StyledNodeState

  normal: bool

  hover: bool

  active: bool

  focused: bool

• struct StyledNode

  state: StyledNodeState

  Optional hit-testing tag ID (NOTE: The tag ID has to be adjusted after the layout is done (to account for scroll tags))

  tag_id: OptionTagId

• struct TagId

  inner: u64

• struct TagIdToNodeIdMapping

  tag_id: TagId

  node_id: NodeId

  tab_index: OptionTabIndex

  parents: NodeIdVec

• struct ParentWithNodeDepth

  depth: usize

  node_id: NodeId

• struct CssPropertyCache

  ptr: *mut c_void

• struct StyledDom

  root: NodeId

  node_hierarchy: NodeVec

  node_data: NodeDataVec

  styled_nodes: StyledNodeVec

  cascade_info: CascadeInfoVec

  nodes_with_window_callbacks: NodeIdVec

  nodes_with_not_callbacks: NodeIdVec

  nodes_with_datasets_and_callbacks: NodeIdVec

  tag_ids_to_node_ids: TagIdToNodeIdMappingVec

  non_leaf_nodes: ParentWithNodeDepthVec

  css_property_cache: CssPropertyCache

  Styles a Dom with the given Css, returning the StyledDom - complexity O(count(dom_nodes) * count(css_blocks)): make sure that the Dom and the Css are as small as possible, use inline CSS if the performance isn't good enough

  • constructor new:

    • arg dom: Dom

    • arg css: Css

    • -> StyledDom

  Returns a default, empty Dom, usually returned if you don't want to crash in an error case.

  • constructor default:

    • -> StyledDom

  Returns a DOM loaded from an XML file

  • constructor from_xml:

    • arg xml_string: String

    • -> StyledDom

  Same as from_xml, but loads the file relative to the current directory

  • constructor from_file:

    • arg xml_file_path: String

    • -> StyledDom

  Appends an already styled list of DOM nodes to the current dom.root - complexity O(count(dom.dom_nodes))

  • fn append_child:

    • &mut self

    • arg dom: StyledDom

  Restyles an already styled DOM with a new CSS - overwrites old styles, but does not replace them, useful for implementing user styles that are applied on top of the existing application style

  • fn restyle:

    • &mut self

    • arg css: Css

  Returns the number of nodes in the styled DOM

  • fn node_count:

    • &self

    • -> usize

  Returns a HTML for unit testing

  • fn get_html_string_test:

    • &self

    • -> String

  Returns a HTML string that you can write to a file in order to debug the UI structure and debug potential cascading issues

  • fn get_html_string_debug:

    • &self

    • -> String

OpenGl helper types (Texture, Gl, etc.)

mod gl:

• struct Texture

  Raw OpenGL texture ID

  texture_id: u32

  Format of this texture (rgba, brga, etc.)

  format: RawImageFormat

  Hints and flags for optimization purposes

  flags: TextureFlags

  Size of this texture (in pixels)

  size: PhysicalSizeU32

  A reference-counted pointer to the OpenGL context (so that the texture can be deleted in the destructor)

  gl_context: Gl

  Allocates an OpenGL texture of a given size with a single red channel (used for image masks)

  • constructor allocate_clip_mask:

    • arg gl: Gl

    • arg size: LayoutSize

    • -> Texture

  Draws a vertex / index buffer (aka. &TesselatedSvgNode) to the texture

  • fn draw_clip_mask:

    • &mut self

    • arg node: TesselatedSvgNode

    • -> bool

  Applies an FXAA filter to the texture

  • fn apply_fxaa:

    • &mut self

    • -> bool

• struct GlVoidPtrConst

  ptr: *const c_void

• struct GlVoidPtrMut

  ptr: *mut c_void

• struct Gl

  Reference-counted pointer to the OpenGL context. Can not be copied between threads.

  ptr: *const c_void

  Extra flag to see whether we are using hardware OpenGL or software OpenGL

  renderer_type: RendererType

  • fn get_type:

    • &self

    • -> GlType

  • fn buffer_data_untyped:

    • &self

    • arg target: u32

    • arg size: isize

    • arg data: GlVoidPtrConst

    • arg usage: u32

  • fn buffer_sub_data_untyped:

    • &self

    • arg target: u32

    • arg offset: isize

    • arg size: isize

    • arg data: GlVoidPtrConst

  • fn map_buffer:

    • &self

    • arg target: u32

    • arg access: u32

    • -> GlVoidPtrMut

  • fn map_buffer_range:

    • &self

    • arg target: u32

    • arg offset: isize

    • arg length: isize

    • arg access: u32

    • -> GlVoidPtrMut

  • fn unmap_buffer:

    • &self

    • arg target: u32

    • -> u8

  • fn tex_buffer:

    • &self

    • arg target: u32

    • arg internal_format: u32

    • arg buffer: u32

  • fn shader_source:

    • &self

    • arg shader: u32

    • arg strings: StringVec

  • fn read_buffer:

    • &self

    • arg mode: u32

  • fn read_pixels_into_buffer:

    • &self

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg pixel_type: u32

    • arg dst_buffer: U8VecRefMut

  • fn read_pixels:

    • &self

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg pixel_type: u32

    • -> U8Vec

  • fn read_pixels_into_pbo:

    • &self

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg pixel_type: u32

  • fn sample_coverage:

    • &self

    • arg value: f32

    • arg invert: bool

  • fn polygon_offset:

    • &self

    • arg factor: f32

    • arg units: f32

  • fn pixel_store_i:

    • &self

    • arg name: u32

    • arg param: i32

  • fn gen_buffers:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn gen_renderbuffers:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn gen_framebuffers:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn gen_textures:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn gen_vertex_arrays:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn gen_queries:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn begin_query:

    • &self

    • arg target: u32

    • arg id: u32

  • fn end_query:

    • &self

    • arg target: u32

  • fn query_counter:

    • &self

    • arg id: u32

    • arg target: u32

  • fn get_query_object_iv:

    • &self

    • arg id: u32

    • arg pname: u32

    • -> i32

  • fn get_query_object_uiv:

    • &self

    • arg id: u32

    • arg pname: u32

    • -> u32

  • fn get_query_object_i64v:

    • &self

    • arg id: u32

    • arg pname: u32

    • -> i64

  • fn get_query_object_ui64v:

    • &self

    • arg id: u32

    • arg pname: u32

    • -> u64

  • fn delete_queries:

    • &self

    • arg queries: GLuintVecRef

  • fn delete_vertex_arrays:

    • &self

    • arg vertex_arrays: GLuintVecRef

  • fn delete_buffers:

    • &self

    • arg buffers: GLuintVecRef

  • fn delete_renderbuffers:

    • &self

    • arg renderbuffers: GLuintVecRef

  • fn delete_framebuffers:

    • &self

    • arg framebuffers: GLuintVecRef

  • fn delete_textures:

    • &self

    • arg textures: GLuintVecRef

  • fn framebuffer_renderbuffer:

    • &self

    • arg target: u32

    • arg attachment: u32

    • arg renderbuffertarget: u32

    • arg renderbuffer: u32

  • fn renderbuffer_storage:

    • &self

    • arg target: u32

    • arg internalformat: u32

    • arg width: i32

    • arg height: i32

  • fn depth_func:

    • &self

    • arg func: u32

  • fn active_texture:

    • &self

    • arg texture: u32

  • fn attach_shader:

    • &self

    • arg program: u32

    • arg shader: u32

  • fn bind_attrib_location:

    • &self

    • arg program: u32

    • arg index: u32

    • arg name: Refstr

  • fn get_uniform_iv:

    • &self

    • arg program: u32

    • arg location: i32

    • arg result: GLintVecRefMut

  • fn get_uniform_fv:

    • &self

    • arg program: u32

    • arg location: i32

    • arg result: GLfloatVecRefMut

  • fn get_uniform_block_index:

    • &self

    • arg program: u32

    • arg name: Refstr

    • -> u32

  • fn get_uniform_indices:

    • &self

    • arg program: u32

    • arg names: RefstrVecRef

    • -> GLuintVec

  • fn bind_buffer_base:

    • &self

    • arg target: u32

    • arg index: u32

    • arg buffer: u32

  • fn bind_buffer_range:

    • &self

    • arg target: u32

    • arg index: u32

    • arg buffer: u32

    • arg offset: isize

    • arg size: isize

  • fn uniform_block_binding:

    • &self

    • arg program: u32

    • arg uniform_block_index: u32

    • arg uniform_block_binding: u32

  • fn bind_buffer:

    • &self

    • arg target: u32

    • arg buffer: u32

  • fn bind_vertex_array:

    • &self

    • arg vao: u32

  • fn bind_renderbuffer:

    • &self

    • arg target: u32

    • arg renderbuffer: u32

  • fn bind_framebuffer:

    • &self

    • arg target: u32

    • arg framebuffer: u32

  • fn bind_texture:

    • &self

    • arg target: u32

    • arg texture: u32

  • fn draw_buffers:

    • &self

    • arg bufs: GLenumVecRef

  • fn tex_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg internal_format: i32

    • arg width: i32

    • arg height: i32

    • arg border: i32

    • arg format: u32

    • arg ty: u32

    • arg opt_data: OptionU8VecRef

  • fn compressed_tex_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg internal_format: u32

    • arg width: i32

    • arg height: i32

    • arg border: i32

    • arg data: U8VecRef

  • fn compressed_tex_sub_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg data: U8VecRef

  • fn tex_image_3d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg internal_format: i32

    • arg width: i32

    • arg height: i32

    • arg depth: i32

    • arg border: i32

    • arg format: u32

    • arg ty: u32

    • arg opt_data: OptionU8VecRef

  • fn copy_tex_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg internal_format: u32

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

    • arg border: i32

  • fn copy_tex_sub_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

  • fn copy_tex_sub_image_3d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg zoffset: i32

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

  • fn tex_sub_image_2d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg ty: u32

    • arg data: U8VecRef

  • fn tex_sub_image_2d_pbo:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg width: i32

    • arg height: i32

    • arg format: u32

    • arg ty: u32

    • arg offset: usize

  • fn tex_sub_image_3d:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg zoffset: i32

    • arg width: i32

    • arg height: i32

    • arg depth: i32

    • arg format: u32

    • arg ty: u32

    • arg data: U8VecRef

  • fn tex_sub_image_3d_pbo:

    • &self

    • arg target: u32

    • arg level: i32

    • arg xoffset: i32

    • arg yoffset: i32

    • arg zoffset: i32

    • arg width: i32

    • arg height: i32

    • arg depth: i32

    • arg format: u32

    • arg ty: u32

    • arg offset: usize

  • fn tex_storage_2d:

    • &self

    • arg target: u32

    • arg levels: i32

    • arg internal_format: u32

    • arg width: i32

    • arg height: i32

  • fn tex_storage_3d:

    • &self

    • arg target: u32

    • arg levels: i32

    • arg internal_format: u32

    • arg width: i32

    • arg height: i32

    • arg depth: i32

  • fn get_tex_image_into_buffer:

    • &self

    • arg target: u32

    • arg level: i32

    • arg format: u32

    • arg ty: u32

    • arg output: U8VecRefMut

  • fn copy_image_sub_data:

    • &self

    • arg src_name: u32

    • arg src_target: u32

    • arg src_level: i32

    • arg src_x: i32

    • arg src_y: i32

    • arg src_z: i32

    • arg dst_name: u32

    • arg dst_target: u32

    • arg dst_level: i32

    • arg dst_x: i32

    • arg dst_y: i32

    • arg dst_z: i32

    • arg src_width: i32

    • arg src_height: i32

    • arg src_depth: i32

  • fn invalidate_framebuffer:

    • &self

    • arg target: u32

    • arg attachments: GLenumVecRef

  • fn invalidate_sub_framebuffer:

    • &self

    • arg target: u32

    • arg attachments: GLenumVecRef

    • arg xoffset: i32

    • arg yoffset: i32

    • arg width: i32

    • arg height: i32

  • fn get_integer_v:

    • &self

    • arg name: u32

    • arg result: GLintVecRefMut

  • fn get_integer_64v:

    • &self

    • arg name: u32

    • arg result: GLint64VecRefMut

  • fn get_integer_iv:

    • &self

    • arg name: u32

    • arg index: u32

    • arg result: GLintVecRefMut

  • fn get_integer_64iv:

    • &self

    • arg name: u32

    • arg index: u32

    • arg result: GLint64VecRefMut

  • fn get_boolean_v:

    • &self

    • arg name: u32

    • arg result: GLbooleanVecRefMut

  • fn get_float_v:

    • &self

    • arg name: u32

    • arg result: GLfloatVecRefMut

  • fn get_framebuffer_attachment_parameter_iv:

    • &self

    • arg target: u32

    • arg attachment: u32

    • arg pname: u32

    • -> i32

  • fn get_renderbuffer_parameter_iv:

    • &self

    • arg target: u32

    • arg pname: u32

    • -> i32

  • fn get_tex_parameter_iv:

    • &self

    • arg target: u32

    • arg name: u32

    • -> i32

  • fn get_tex_parameter_fv:

    • &self

    • arg target: u32

    • arg name: u32

    • -> f32

  • fn tex_parameter_i:

    • &self

    • arg target: u32

    • arg pname: u32

    • arg param: i32

  • fn tex_parameter_f:

    • &self

    • arg target: u32

    • arg pname: u32

    • arg param: f32

  • fn framebuffer_texture_2d:

    • &self

    • arg target: u32

    • arg attachment: u32

    • arg textarget: u32

    • arg texture: u32

    • arg level: i32

  • fn framebuffer_texture_layer:

    • &self

    • arg target: u32

    • arg attachment: u32

    • arg texture: u32

    • arg level: i32

    • arg layer: i32

  • fn blit_framebuffer:

    • &self

    • arg src_x0: i32

    • arg src_y0: i32

    • arg src_x1: i32

    • arg src_y1: i32

    • arg dst_x0: i32

    • arg dst_y0: i32

    • arg dst_x1: i32

    • arg dst_y1: i32

    • arg mask: u32

    • arg filter: u32

  • fn vertex_attrib_4f:

    • &self

    • arg index: u32

    • arg x: f32

    • arg y: f32

    • arg z: f32

    • arg w: f32

  • fn vertex_attrib_pointer_f32:

    • &self

    • arg index: u32

    • arg size: i32

    • arg normalized: bool

    • arg stride: i32

    • arg offset: u32

  • fn vertex_attrib_pointer:

    • &self

    • arg index: u32

    • arg size: i32

    • arg type_: u32

    • arg normalized: bool

    • arg stride: i32

    • arg offset: u32

  • fn vertex_attrib_i_pointer:

    • &self

    • arg index: u32

    • arg size: i32

    • arg type_: u32

    • arg stride: i32

    • arg offset: u32

  • fn vertex_attrib_divisor:

    • &self

    • arg index: u32

    • arg divisor: u32

  • fn viewport:

    • &self

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

  • fn scissor:

    • &self

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

  • fn line_width:

    • &self

    • arg width: f32

  • fn use_program:

    • &self

    • arg program: u32

  • fn validate_program:

    • &self

    • arg program: u32

  • fn draw_arrays:

    • &self

    • arg mode: u32

    • arg first: i32

    • arg count: i32

  • fn draw_arrays_instanced:

    • &self

    • arg mode: u32

    • arg first: i32

    • arg count: i32

    • arg primcount: i32

  • fn draw_elements:

    • &self

    • arg mode: u32

    • arg count: i32

    • arg element_type: u32

    • arg indices_offset: u32

  • fn draw_elements_instanced:

    • &self

    • arg mode: u32

    • arg count: i32

    • arg element_type: u32

    • arg indices_offset: u32

    • arg primcount: i32

  • fn blend_color:

    • &self

    • arg r: f32

    • arg g: f32

    • arg b: f32

    • arg a: f32

  • fn blend_func:

    • &self

    • arg sfactor: u32

    • arg dfactor: u32

  • fn blend_func_separate:

    • &self

    • arg src_rgb: u32

    • arg dest_rgb: u32

    • arg src_alpha: u32

    • arg dest_alpha: u32

  • fn blend_equation:

    • &self

    • arg mode: u32

  • fn blend_equation_separate:

    • &self

    • arg mode_rgb: u32

    • arg mode_alpha: u32

  • fn color_mask:

    • &self

    • arg r: bool

    • arg g: bool

    • arg b: bool

    • arg a: bool

  • fn cull_face:

    • &self

    • arg mode: u32

  • fn front_face:

    • &self

    • arg mode: u32

  • fn enable:

    • &self

    • arg cap: u32

  • fn disable:

    • &self

    • arg cap: u32

  • fn hint:

    • &self

    • arg param_name: u32

    • arg param_val: u32

  • fn is_enabled:

    • &self

    • arg cap: u32

    • -> u8

  • fn is_shader:

    • &self

    • arg shader: u32

    • -> u8

  • fn is_texture:

    • &self

    • arg texture: u32

    • -> u8

  • fn is_framebuffer:

    • &self

    • arg framebuffer: u32

    • -> u8

  • fn is_renderbuffer:

    • &self

    • arg renderbuffer: u32

    • -> u8

  • fn check_frame_buffer_status:

    • &self

    • arg target: u32

    • -> u32

  • fn enable_vertex_attrib_array:

    • &self

    • arg index: u32

  • fn disable_vertex_attrib_array:

    • &self

    • arg index: u32

  • fn uniform_1f:

    • &self

    • arg location: i32

    • arg v0: f32

  • fn uniform_1fv:

    • &self

    • arg location: i32

    • arg values: F32VecRef

  • fn uniform_1i:

    • &self

    • arg location: i32

    • arg v0: i32

  • fn uniform_1iv:

    • &self

    • arg location: i32

    • arg values: I32VecRef

  • fn uniform_1ui:

    • &self

    • arg location: i32

    • arg v0: u32

  • fn uniform_2f:

    • &self

    • arg location: i32

    • arg v0: f32

    • arg v1: f32

  • fn uniform_2fv:

    • &self

    • arg location: i32

    • arg values: F32VecRef

  • fn uniform_2i:

    • &self

    • arg location: i32

    • arg v0: i32

    • arg v1: i32

  • fn uniform_2iv:

    • &self

    • arg location: i32

    • arg values: I32VecRef

  • fn uniform_2ui:

    • &self

    • arg location: i32

    • arg v0: u32

    • arg v1: u32

  • fn uniform_3f:

    • &self

    • arg location: i32

    • arg v0: f32

    • arg v1: f32

    • arg v2: f32

  • fn uniform_3fv:

    • &self

    • arg location: i32

    • arg values: F32VecRef

  • fn uniform_3i:

    • &self

    • arg location: i32

    • arg v0: i32

    • arg v1: i32

    • arg v2: i32

  • fn uniform_3iv:

    • &self

    • arg location: i32

    • arg values: I32VecRef

  • fn uniform_3ui:

    • &self

    • arg location: i32

    • arg v0: u32

    • arg v1: u32

    • arg v2: u32

  • fn uniform_4f:

    • &self

    • arg location: i32

    • arg x: f32

    • arg y: f32

    • arg z: f32

    • arg w: f32

  • fn uniform_4i:

    • &self

    • arg location: i32

    • arg x: i32

    • arg y: i32

    • arg z: i32

    • arg w: i32

  • fn uniform_4iv:

    • &self

    • arg location: i32

    • arg values: I32VecRef

  • fn uniform_4ui:

    • &self

    • arg location: i32

    • arg x: u32

    • arg y: u32

    • arg z: u32

    • arg w: u32

  • fn uniform_4fv:

    • &self

    • arg location: i32

    • arg values: F32VecRef

  • fn uniform_matrix_2fv:

    • &self

    • arg location: i32

    • arg transpose: bool

    • arg value: F32VecRef

  • fn uniform_matrix_3fv:

    • &self

    • arg location: i32

    • arg transpose: bool

    • arg value: F32VecRef

  • fn uniform_matrix_4fv:

    • &self

    • arg location: i32

    • arg transpose: bool

    • arg value: F32VecRef

  • fn depth_mask:

    • &self

    • arg flag: bool

  • fn depth_range:

    • &self

    • arg near: f64

    • arg far: f64

  • fn get_active_attrib:

    • &self

    • arg program: u32

    • arg index: u32

    • -> GetActiveAttribReturn

  • fn get_active_uniform:

    • &self

    • arg program: u32

    • arg index: u32

    • -> GetActiveUniformReturn

  • fn get_active_uniforms_iv:

    • &self

    • arg program: u32

    • arg indices: GLuintVec

    • arg pname: u32

    • -> GLintVec

  • fn get_active_uniform_block_i:

    • &self

    • arg program: u32

    • arg index: u32

    • arg pname: u32

    • -> i32

  • fn get_active_uniform_block_iv:

    • &self

    • arg program: u32

    • arg index: u32

    • arg pname: u32

    • -> GLintVec

  • fn get_active_uniform_block_name:

    • &self

    • arg program: u32

    • arg index: u32

    • -> String

  • fn get_attrib_location:

    • &self

    • arg program: u32

    • arg name: Refstr

    • -> i32

  • fn get_frag_data_location:

    • &self

    • arg program: u32

    • arg name: Refstr

    • -> i32

  • fn get_uniform_location:

    • &self

    • arg program: u32

    • arg name: Refstr

    • -> i32

  • fn get_program_info_log:

    • &self

    • arg program: u32

    • -> String

  • fn get_program_iv:

    • &self

    • arg program: u32

    • arg pname: u32

    • arg result: GLintVecRefMut

  • fn get_program_binary:

    • &self

    • arg program: u32

    • -> GetProgramBinaryReturn

  • fn program_binary:

    • &self

    • arg program: u32

    • arg format: u32

    • arg binary: U8VecRef

  • fn program_parameter_i:

    • &self

    • arg program: u32

    • arg pname: u32

    • arg value: i32

  • fn get_vertex_attrib_iv:

    • &self

    • arg index: u32

    • arg pname: u32

    • arg result: GLintVecRefMut

  • fn get_vertex_attrib_fv:

    • &self

    • arg index: u32

    • arg pname: u32

    • arg result: GLfloatVecRefMut

  • fn get_vertex_attrib_pointer_v:

    • &self

    • arg index: u32

    • arg pname: u32

    • -> isize

  • fn get_buffer_parameter_iv:

    • &self

    • arg target: u32

    • arg pname: u32

    • -> i32

  • fn get_shader_info_log:

    • &self

    • arg shader: u32

    • -> String

  • fn get_string:

    • &self

    • arg which: u32

    • -> String

  • fn get_string_i:

    • &self

    • arg which: u32

    • arg index: u32

    • -> String

  • fn get_shader_iv:

    • &self

    • arg shader: u32

    • arg pname: u32

    • arg result: GLintVecRefMut

  • fn get_shader_precision_format:

    • &self

    • arg shader_type: u32

    • arg precision_type: u32

    • -> GlShaderPrecisionFormatReturn

  • fn compile_shader:

    • &self

    • arg shader: u32

  • fn create_program:

    • &self

    • -> u32

  • fn delete_program:

    • &self

    • arg program: u32

  • fn create_shader:

    • &self

    • arg shader_type: u32

    • -> u32

  • fn delete_shader:

    • &self

    • arg shader: u32

  • fn detach_shader:

    • &self

    • arg program: u32

    • arg shader: u32

  • fn link_program:

    • &self

    • arg program: u32

  • fn clear_color:

    • &self

    • arg r: f32

    • arg g: f32

    • arg b: f32

    • arg a: f32

  • fn clear:

    • &self

    • arg buffer_mask: u32

  • fn clear_depth:

    • &self

    • arg depth: f64

  • fn clear_stencil:

    • &self

    • arg s: i32

  • fn flush:

    • &self

  • fn finish:

    • &self

  • fn get_error:

    • &self

    • -> u32

  • fn stencil_mask:

    • &self

    • arg mask: u32

  • fn stencil_mask_separate:

    • &self

    • arg face: u32

    • arg mask: u32

  • fn stencil_func:

    • &self

    • arg func: u32

    • arg ref_: i32

    • arg mask: u32

  • fn stencil_func_separate:

    • &self

    • arg face: u32

    • arg func: u32

    • arg ref_: i32

    • arg mask: u32

  • fn stencil_op:

    • &self

    • arg sfail: u32

    • arg dpfail: u32

    • arg dppass: u32

  • fn stencil_op_separate:

    • &self

    • arg face: u32

    • arg sfail: u32

    • arg dpfail: u32

    • arg dppass: u32

  • fn egl_image_target_texture2d_oes:

    • &self

    • arg target: u32

    • arg image: GlVoidPtrConst

  • fn generate_mipmap:

    • &self

    • arg target: u32

  • fn insert_event_marker_ext:

    • &self

    • arg message: Refstr

  • fn push_group_marker_ext:

    • &self

    • arg message: Refstr

  • fn pop_group_marker_ext:

    • &self

  • fn debug_message_insert_khr:

    • &self

    • arg source: u32

    • arg type_: u32

    • arg id: u32

    • arg severity: u32

    • arg message: Refstr

  • fn push_debug_group_khr:

    • &self

    • arg source: u32

    • arg id: u32

    • arg message: Refstr

  • fn pop_debug_group_khr:

    • &self

  • fn fence_sync:

    • &self

    • arg condition: u32

    • arg flags: u32

    • -> GLsyncPtr

  • fn client_wait_sync:

    • &self

    • arg sync: GLsyncPtr

    • arg flags: u32

    • arg timeout: u64

    • -> u32

  • fn wait_sync:

    • &self

    • arg sync: GLsyncPtr

    • arg flags: u32

    • arg timeout: u64

  • fn delete_sync:

    • &self

    • arg sync: GLsyncPtr

  • fn texture_range_apple:

    • &self

    • arg target: u32

    • arg data: U8VecRef

  • fn gen_fences_apple:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn delete_fences_apple:

    • &self

    • arg fences: GLuintVecRef

  • fn set_fence_apple:

    • &self

    • arg fence: u32

  • fn finish_fence_apple:

    • &self

    • arg fence: u32

  • fn test_fence_apple:

    • &self

    • arg fence: u32

  • fn test_object_apple:

    • &self

    • arg object: u32

    • arg name: u32

    • -> u8

  • fn finish_object_apple:

    • &self

    • arg object: u32

    • arg name: u32

  • fn get_frag_data_index:

    • &self

    • arg program: u32

    • arg name: Refstr

    • -> i32

  • fn blend_barrier_khr:

    • &self

  • fn bind_frag_data_location_indexed:

    • &self

    • arg program: u32

    • arg color_number: u32

    • arg index: u32

    • arg name: Refstr

  • fn get_debug_messages:

    • &self

    • -> DebugMessageVec

  • fn provoking_vertex_angle:

    • &self

    • arg mode: u32

  • fn gen_vertex_arrays_apple:

    • &self

    • arg n: i32

    • -> GLuintVec

  • fn bind_vertex_array_apple:

    • &self

    • arg vao: u32

  • fn delete_vertex_arrays_apple:

    • &self

    • arg vertex_arrays: GLuintVecRef

  • fn copy_texture_chromium:

    • &self

    • arg source_id: u32

    • arg source_level: i32

    • arg dest_target: u32

    • arg dest_id: u32

    • arg dest_level: i32

    • arg internal_format: i32

    • arg dest_type: u32

    • arg unpack_flip_y: u8

    • arg unpack_premultiply_alpha: u8

    • arg unpack_unmultiply_alpha: u8

  • fn copy_sub_texture_chromium:

    • &self

    • arg source_id: u32

    • arg source_level: i32

    • arg dest_target: u32

    • arg dest_id: u32

    • arg dest_level: i32

    • arg x_offset: i32

    • arg y_offset: i32

    • arg x: i32

    • arg y: i32

    • arg width: i32

    • arg height: i32

    • arg unpack_flip_y: u8

    • arg unpack_premultiply_alpha: u8

    • arg unpack_unmultiply_alpha: u8

  • fn egl_image_target_renderbuffer_storage_oes:

    • &self

    • arg target: u32

    • arg image: GlVoidPtrConst

  • fn copy_texture_3d_angle:

    • &self

    • arg source_id: u32

    • arg source_level: i32

    • arg dest_target: u32

    • arg dest_id: u32

    • arg dest_level: i32

    • arg internal_format: i32

    • arg dest_type: u32

    • arg unpack_flip_y: u8

    • arg unpack_premultiply_alpha: u8

    • arg unpack_unmultiply_alpha: u8

  • fn copy_sub_texture_3d_angle:

    • &self

    • arg source_id: u32

    • arg source_level: i32

    • arg dest_target: u32

    • arg dest_id: u32

    • arg dest_level: i32

    • arg x_offset: i32

    • arg y_offset: i32

    • arg z_offset: i32

    • arg x: i32

    • arg y: i32

    • arg z: i32

    • arg width: i32

    • arg height: i32

    • arg depth: i32

    • arg unpack_flip_y: u8

    • arg unpack_premultiply_alpha: u8

    • arg unpack_unmultiply_alpha: u8

  • fn buffer_storage:

    • &self

    • arg target: u32

    • arg size: isize

    • arg data: GlVoidPtrConst

    • arg flags: u32

  • fn flush_mapped_buffer_range:

    • &self

    • arg target: u32

    • arg offset: isize

    • arg length: isize

• struct GlShaderPrecisionFormatReturn

  _0: i32

  _1: i32

  _2: i32

• enum VertexAttributeType

  Vertex attribute has type f32

  Float

  Vertex attribute has type f64

  Double

  Vertex attribute has type u8

  UnsignedByte

  Vertex attribute has type u16

  UnsignedShort

  Vertex attribute has type u32

  UnsignedInt

• struct VertexAttribute

  name: String

  layout_location: OptionUsize

  attribute_type: VertexAttributeType

  item_count: usize

• struct VertexLayout

  fields: VertexAttributeVec

• struct VertexArrayObject

  vertex_layout: VertexLayout

  vao_id: u32

  gl_context: Gl

• enum IndexBufferFormat

  Points

  Lines

  LineStrip

  Triangles

  TriangleStrip

  TriangleFan

• struct VertexBuffer

  vertex_buffer_id: u32

  vertex_buffer_len: usize

  vao: VertexArrayObject

  index_buffer_id: u32

  index_buffer_len: usize

  index_buffer_format: IndexBufferFormat

• enum GlType

  Gl

  Gles

• struct DebugMessage

  message: String

  source: u32

  ty: u32

  id: u32

  severity: u32

• C-ABI stable reexport of &[u8]

  struct U8VecRef

  ptr: *const u8

  len: usize

• C-ABI stable reexport of &mut [u8]

  struct U8VecRefMut

  ptr: *mut u8

  len: usize

• C-ABI stable reexport of &[f32]

  struct F32VecRef

  ptr: *const f32

  len: usize

• C-ABI stable reexport of &[i32]

  struct I32VecRef

  ptr: *const i32

  len: usize

• C-ABI stable reexport of &[GLuint] aka &[u32]

  struct GLuintVecRef

  ptr: *const u32

  len: usize

• C-ABI stable reexport of &[GLenum] aka &[u32]

  struct GLenumVecRef

  ptr: *const u32

  len: usize

• C-ABI stable reexport of &mut [GLint] aka &mut [i32]

  struct GLintVecRefMut

  ptr: *mut i32

  len: usize

• C-ABI stable reexport of &mut [GLint64] aka &mut [i64]

  struct GLint64VecRefMut

  ptr: *mut i64

  len: usize

• C-ABI stable reexport of &mut [GLboolean] aka &mut [u8]

  struct GLbooleanVecRefMut

  ptr: *mut u8

  len: usize

• C-ABI stable reexport of &mut [GLfloat] aka &mut [f32]

  struct GLfloatVecRefMut

  ptr: *mut f32

  len: usize

• C-ABI stable reexport of &[Refstr] aka &mut [&str]

  struct RefstrVecRef

  ptr: *const Refstr

  len: usize

• C-ABI stable reexport of &str

  struct Refstr

  ptr: *const u8

  len: usize

• C-ABI stable reexport of (U8Vec, u32)

  struct GetProgramBinaryReturn

  _0: U8Vec

  _1: u32

• C-ABI stable reexport of (i32, u32, AzString)

  struct GetActiveAttribReturn

  _0: i32

  _1: u32

  _2: String

• C-ABI stable reexport of *const gleam::gl::GLsync

  struct GLsyncPtr

  ptr: *const c_void

• C-ABI stable reexport of (i32, u32, AzString)

  struct GetActiveUniformReturn

  _0: i32

  _1: u32

  _2: String

• struct TextureFlags

  Whether this texture contains an alpha component

  is_opaque: bool

  Optimization: use the compositor instead of OpenGL for energy efficiency

  is_video_texture: bool

  Default texture flags (not opaque, not a video texture)

  • constructor default:

    • -> TextureFlags