Azul API docs for version 1.0.0-alpha1

App construction and configuration

mod app:

• Main application class

  struct App

  Creates a new App instance from the given AppConfig

  • constructor new:

    • -> App

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

  • fn add_window:

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

  • fn add_image:

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

  • fn get_monitors:

    • 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:

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

  struct AppConfig

  Constructs a default AppConfig, uses the layout solver currently available

  • constructor new:

    • -> AppConfig

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

  struct SystemCallbacks

  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

  Creates a new window configuration with a custom layout callback

  • constructor new:

    • -> WindowCreateOptions

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

  struct LogicalPosition

  • constructor new:

    • -> LogicalPosition

  • constructor zero:

    • -> LogicalPosition

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

  struct LogicalSize

  • fn to_physical:

    • -> PhysicalSizeU32

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

  struct WindowSize

  Returns the hidpi factor of the bounds

  • fn get_hidpi_factor:

    • -> f32

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

  struct KeyboardState

  Returns if the SHIFT key is held down (left OR right shift)

  • fn shift_down:

    • -> bool

  Returns if the CTRL key is held down

  • fn ctrl_down:

    • -> bool

  Returns if the ALT key is held down

  • fn alt_down:

    • -> bool

  Returns if the SUPER ("Windows") key is held down

  • fn super_down:

    • -> bool

  Returns if a key is held down

  • fn is_key_down:

    • -> bool

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

  struct CursorPosition

  • fn get_position:

    • -> OptionLogicalPosition

• struct WindowState

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

  • constructor new:

    • -> 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:

• struct CallbackInfo

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

  • fn get_hit_node:

    • -> DomNodeId

  Returns the function pointer necessary to query the current time.

  • fn get_system_time_fn:

    • -> 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:

    • -> 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:

    • -> OptionLogicalPosition

  Returns a copy of the current windows WindowState.

  • fn get_current_window_state:

    • -> WindowState

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

  • fn get_current_keyboard_state:

    • -> KeyboardState

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

  • fn get_current_mouse_state:

    • -> MouseState

  Returns a copy of the current windows WindowState.

  • fn get_previous_window_state:

    • -> OptionWindowState

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

  • fn get_previous_keyboard_state:

    • -> OptionKeyboardState

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

  • fn get_previous_mouse_state:

    • -> OptionMouseState

  Returns a copy of the current windows RawWindowHandle.

  • fn get_current_window_handle:

    • -> RawWindowHandle

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

  • fn get_gl_context:

    • -> 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:

    • -> OptionLogicalPosition

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

  • fn get_dataset:

    • -> OptionRefAny

  Given a dataset, returns the node ID of the "root" RefAny, i.e. the RefAny with the lowest instance count that is set as a dataset on any node.

  • fn get_node_id_of_root_dataset:

    • -> OptionDomNodeId

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

  • fn get_string_contents:

    • -> OptionString

  If the node is a Text node, returns the layouted inline glyphs of the text currently rendered on the screen

  • fn get_inline_text:

    • -> OptionInlineText

  If the node is a Text node, returns the FontRef that was used to render this node. Useful for getting font metrics for a text string

  • fn get_font_ref:

    • -> OptionFontRef

  • fn get_text_layout_options:

    • -> OptionResolvedTextLayoutOptions

  Similar to get_inline_text(): If the node is a Text node, shape the text string with the same parameters as the current text and return the calculated InlineTextLayout. Necessary to calculate text cursor offsets and to detect when a line overflows content.

  • fn shape_text:

    • -> OptionInlineText

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

  • fn get_index_in_parent:

    • -> usize

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

  • fn get_parent:

    • -> OptionDomNodeId

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

  • fn get_previous_sibling:

    • -> OptionDomNodeId

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

  • fn get_next_sibling:

    • -> OptionDomNodeId

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

  • fn get_first_child:

    • -> OptionDomNodeId

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

  • fn get_last_child:

    • -> OptionDomNodeId

  Returns the position of a given DOM node in the UI

  • fn get_node_position:

    • -> OptionPositionInfo

  Returns the size of a given DOM node in the UI

  • fn get_node_size:

    • -> OptionLogicalSize

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

  • fn get_computed_css_property:

    • -> OptionCssProperty

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

  • fn set_window_state:

  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:

  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:

  Sets the scroll position of the node

  • fn set_scroll_position:

  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:

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

  • fn add_image:

  Returns whether an image with a given CSS ID already exists

  • fn has_image:

    • -> bool

  Returns the image with a given CSS ID

  • fn get_image:

    • -> OptionImageRef

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

  • fn update_image:

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

  • fn delete_image:

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

  • fn update_image_mask:

  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:

  Spawns a new window with the given WindowCreateOptions.

  • fn create_window:

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

  • fn start_timer:

    • -> TimerId

  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:

    • -> OptionTimerId

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

  • fn stop_timer:

    • 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:

    • -> OptionThreadId

  Sends a message to a background thread

  • fn send_thread_msg:

    • 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:

    • Returns true if the ThreadId is valid, false otherwise

      -> bool

• struct PositionInfo

  • fn is_positioned:

    • -> bool

  • fn get_static_offset:

    • -> LogicalPosition

  • fn get_relative_offset:

    • -> LogicalPosition

• struct HidpiAdjustedBounds

  Returns the size of the bounds in logical units

  • fn get_logical_size:

    • -> LogicalSize

  Returns the size of the bounds in physical units

  • fn get_physical_size:

    • -> PhysicalSizeU32

  Returns the hidpi factor of the bounds

  • fn get_hidpi_factor:

    • -> f32

• struct InlineText

  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:

    • -> InlineTextHitVec

• struct ResolvedTextLayoutOptions

  • constructor default:

    • -> ResolvedTextLayoutOptions

• struct RenderImageCallbackInfo

  Returns a copy of the internal Gl

  • fn get_gl_context:

    • -> OptionGl

  Returns a copy of the internal HidpiAdjustedBounds

  • fn get_bounds:

    • -> HidpiAdjustedBounds

  Returns the DomNodeId that this callback was called on

  • fn get_callback_node_id:

    • -> DomNodeId

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

  • fn get_inline_text:

    • -> OptionInlineText

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

  • fn get_index_in_parent:

    • -> usize

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

  • fn get_parent:

    • -> OptionDomNodeId

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

  • fn get_previous_sibling:

    • -> OptionDomNodeId

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

  • fn get_next_sibling:

    • -> OptionDomNodeId

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

  • fn get_first_child:

    • -> OptionDomNodeId

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

  • fn get_last_child:

    • -> OptionDomNodeId

• struct RefCount

  • fn can_be_shared:

    • -> bool

  • fn can_be_shared_mut:

    • -> bool

  • fn increase_ref:

  • fn decrease_ref:

  • fn increase_refmut:

  • fn decrease_refmut:

• 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

  • constructor new_c:

    • -> RefAny

  • fn get_type_id:

    • -> u64

  • fn get_type_name:

    • -> String

• struct LayoutCallbackInfo

  Returns a copy of the OpenGL context

  • fn get_gl_context:

    • -> OptionGl

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

  • fn get_system_fonts:

    • -> StringPairVec

  Returns an ImageRef referenced by a CSS ID

  • fn get_image:

    • -> OptionImageRef

Dom construction and configuration

mod dom:

• struct Dom

  • constructor new:

    • -> Dom

  • constructor body:

    • -> Dom

  • constructor div:

    • -> Dom

  • constructor br:

    • -> Dom

  • constructor text:

    • -> Dom

  • constructor image:

    • -> Dom

  • constructor iframe:

    • -> Dom

  • fn set_node_type:

  • fn with_node_type:

    • -> Dom

  • fn set_dataset:

  • fn with_dataset:

    • -> Dom

  • fn set_ids_and_classes:

  • fn with_ids_and_classes:

    • -> Dom

  • fn set_callbacks:

  • fn with_callbacks:

    • -> Dom

  • fn set_inline_css_props:

  • fn with_inline_css_props:

    • -> 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:

  Same as add_child, but as a builder method.

  • fn with_callback:

    • -> 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:

  Same as add_child, but as a builder method.

  • fn with_child:

    • -> 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:

  Same as set_children, but as a builder method.

  • fn with_children:

    • -> Dom

  Adds an CSS ID to the DOM root node.

  • fn add_id:

  Same as add_id, but as a builder method

  • fn with_id:

    • -> Dom

  Adds a CSS class to the DOM root node.

  • fn add_class:

  Same as add_class, but as a builder method

  • fn with_class:

    • -> Dom

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

  • fn add_css_property:

  Same as add_class, but as a builder method

  • fn with_css_property:

    • -> Dom

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

  • fn add_hover_css_property:

  Same as add_class, but as a builder method

  • fn with_hover_css_property:

    • -> Dom

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

  • fn add_active_css_property:

  Same as add_class, but as a builder method

  • fn with_active_css_property:

    • -> Dom

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

  • fn add_focus_css_property:

  Same as add_class, but as a builder method

  • fn with_focus_css_property:

    • -> Dom

  • fn set_inline_style:

  • fn with_inline_style:

    • -> Dom

  • fn set_inline_hover_style:

  • fn with_inline_hover_style:

    • -> Dom

  • fn set_inline_active_style:

  • fn with_inline_active_style:

    • -> Dom

  • fn set_inline_focus_style:

  • fn with_inline_focus_style:

    • -> Dom

  Sets the clip mask for the DOM root node.

  • fn set_clip_mask:

  Same as set_clip_mask, but as a builder method

  • fn with_clip_mask:

    • -> Dom

  Sets the tab index for the DOM root node.

  • fn set_tab_index:

  Same as set_tab_index, but as a builder method

  • fn with_tab_index:

    • -> Dom

  Sets accessibility attributes for the DOM root node.

  • fn set_accessibility_info:

  Same as set_accessibility_info, but as a builder method

  • fn with_accessibility_info:

    • -> Dom

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

  • fn set_menu_bar:

  Same as set_accessibility_info, but as a builder method

  • fn with_menu_bar:

    • -> Dom

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

  • fn set_context_menu:

  Same as set_context_menu, but as a builder method

  • fn with_context_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:

    • -> 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:

    • -> usize

  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:

    • -> String

  Returns a HTML for unit testing

  • fn get_html_string_test:

    • -> String

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

  • fn style:

    • -> StyledDom

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

  struct NodeData

  Creates an new, empty NodeData struct

  • constructor new:

    • -> NodeData

  • constructor body:

    • -> NodeData

  • constructor div:

    • -> NodeData

  • constructor br:

    • -> NodeData

  • constructor text:

    • -> NodeData

  • constructor image:

    • -> NodeData

  • constructor iframe:

    • -> NodeData

  • fn set_node_type:

  • fn with_node_type:

    • -> NodeData

  • fn set_dataset:

  • fn with_dataset:

    • -> NodeData

  • fn set_ids_and_classes:

  • fn with_ids_and_classes:

    • -> NodeData

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

  • fn add_callback:

  Same as add_child, but as a builder method.

  • fn with_callback:

    • -> NodeData

  • fn set_callbacks:

  • fn with_callbacks:

    • -> NodeData

  • fn set_inline_css_props:

  • fn with_inline_css_props:

    • -> NodeData

  • fn set_inline_style:

  • fn with_inline_style:

    • -> NodeData

  • fn set_inline_hover_style:

  • fn with_inline_hover_style:

    • -> NodeData

  • fn set_inline_active_style:

  • fn with_inline_active_style:

    • -> NodeData

  • fn set_inline_focus_style:

  • fn with_inline_focus_style:

    • -> NodeData

  Sets the extra.clip_mask field for this node

  • fn set_clip_mask:

  Sets the tab index for this node

  • fn set_tab_index:

  Sets accessibility attributes for this node

  • fn set_accessibility_info:

  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:

  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:

  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:

    • -> u64

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

  struct On

  Converts the On shorthand into a EventFilter

  • fn into_event_filter:

    • -> EventFilter

mod menu:

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

  struct Menu

  Creates an new, empty Menu

  • constructor new:

    • -> Menu

  Sets the popup position of the menu, ignored on menu bars

  • fn set_popup_position:

  Sets the popup position of the menu, ignored on menu bars (builder method)

  • fn with_popup_position:

    • -> Menu

• Regular labeled menu item

  struct StringMenuItem

  Creates a new menu item

  • constructor new:

    • -> StringMenuItem

  Adds a callback to the menu item

  • fn set_callback:

  Adds a callback to the menu item

  • fn with_callback:

    • -> StringMenuItem

  Adds a single child submenu to the current menu

  • fn add_child:

  Adds a single child submenu to the current menu

  • fn with_child:

    • -> StringMenuItem

  Sets the children of this menu

  • fn set_children:

  Adds a child submenu to the current menu

  • fn with_children:

    • -> StringMenuItem

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

  struct MenuCallback

  • constructor new:

    • -> MenuCallback

Css parsing module

mod css:

• struct Css

  Returns an empty CSS style

  • constructor empty:

    • -> Css

  Returns a CSS style parsed from a String

  • constructor from_string:

    • -> Css

• struct ColorU

  • constructor from_str:

    • -> ColorU

  • constructor transparent:

    • -> ColorU

  • constructor white:

    • -> ColorU

  • constructor black:

    • -> ColorU

  • fn to_hash:

    • -> String

• struct AngleValue

  • fn get_degrees:

    • -> f32

• Parsed CSS key-value pair

  struct CssProperty

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

  • fn get_key_string:

    • -> String

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

  • fn get_value_string:

    • -> String

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

  • fn get_key_value_string:

    • -> 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:

    • -> CssProperty

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

mod widgets:

• struct Ribbon

  • fn dom:

    • -> Dom

• struct Button

  Creates a new labeled button

  • constructor new:

    • -> Button

  • fn set_on_click:

  • fn with_on_click:

    • -> Button

  • fn dom:

    • -> Dom

• struct FileInput

  Creates a new file input button

  • constructor new:

    • -> FileInput

  • fn set_default_text:

  • fn with_default_text:

    • -> FileInput

  • fn set_on_path_change:

  • fn with_on_path_change:

    • -> FileInput

  • fn dom:

    • -> Dom

• struct CheckBox

  Creates a new checkbox, disabled or enabled

  • constructor new:

    • -> CheckBox

  • fn set_on_toggle:

  • fn with_on_toggle:

    • -> CheckBox

  • fn dom:

    • -> Dom

• struct Label

  • constructor new:

    • -> Label

  • fn dom:

    • -> Dom

• struct ColorInput

  • constructor new:

    • -> ColorInput

  • fn set_on_value_change:

  • fn with_on_value_change:

    • -> ColorInput

  • fn dom:

    • -> Dom

• struct TextInput

  • constructor new:

    • -> TextInput

  • fn set_text:

  • fn with_text:

    • -> TextInput

  • fn set_placeholder:

  • fn with_placeholder:

    • -> TextInput

  • fn set_on_text_input:

  • fn with_on_text_input:

    • -> TextInput

  • fn set_on_virtual_key_down:

  • fn with_on_virtual_key_down:

    • -> TextInput

  • fn set_on_focus_lost:

  • fn with_on_focus_lost:

    • -> TextInput

  • fn set_placeholder_style:

  • fn with_placeholder_style:

    • -> TextInput

  • fn set_container_style:

  • fn with_container_style:

    • -> TextInput

  • fn set_label_style:

  • fn with_label_style:

    • -> TextInput

  • fn dom:

    • -> Dom

• struct TextInputState

  • fn get_text:

    • -> String

• struct NumberInput

  • constructor new:

    • -> NumberInput

  • fn set_on_text_input:

  • fn with_on_text_input:

    • -> NumberInput

  • fn set_on_virtual_key_down:

  • fn with_on_virtual_key_down:

    • -> NumberInput

  • fn set_on_focus_lost:

  • fn with_on_focus_lost:

    • -> NumberInput

  • fn set_placeholder_style:

  • fn with_placeholder_style:

    • -> NumberInput

  • fn set_container_style:

  • fn with_container_style:

    • -> NumberInput

  • fn set_label_style:

  • fn with_label_style:

    • -> NumberInput

  • fn set_on_value_change:

  • fn with_on_value_change:

    • -> NumberInput

  • fn dom:

    • -> Dom

• struct ProgressBar

  • constructor new:

    • -> ProgressBar

  • fn set_height:

  • fn with_height:

    • -> ProgressBar

  • fn set_container_background:

  • fn with_container_style:

    • -> ProgressBar

  • fn set_bar_background:

  • fn with_bar_background:

    • -> ProgressBar

  • fn dom:

    • -> Dom

• struct TabHeader

  • constructor new:

    • -> TabHeader

  • fn set_active_tab:

  • fn with_active_tab:

    • -> TabHeader

  • fn set_on_click:

  • fn with_on_click:

    • -> TabHeader

  • fn dom:

    • -> Dom

• struct TabContent

  • constructor new:

    • -> TabContent

  • fn set_padding:

  • fn with_padding:

    • -> TabContent

  • fn dom:

    • -> Dom

• struct Frame

  • constructor new:

    • -> Frame

  • fn set_flex_grow:

  • fn with_flex_grow:

    • -> Frame

  • fn dom:

    • -> Dom

• struct NodeGraph

  • fn dom:

    • -> Dom

• struct ListView

  • constructor new:

    • -> ListView

  • fn with_rows:

    • -> ListView

  • fn dom:

    • -> Dom

• struct TreeView

  • constructor new:

    • -> TreeView

  • fn dom:

    • -> Dom

• struct DropDown

  • constructor new:

    • -> DropDown

  • fn dom:

    • -> Dom

DOM to CSS cascading and styling module

mod style:

• struct StyledDom

  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:

    • -> 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:

    • -> StyledDom

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

  • constructor from_file:

    • -> StyledDom

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

  • fn append_child:

  Same as append_child(), but as a builder method

  • fn with_child:

    • -> 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:

  Returns the number of nodes in the styled DOM

  • fn node_count:

    • -> usize

  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:

    • -> String

  Returns a HTML for unit testing

  • fn get_html_string_test:

    • -> String

  Adds a menu to the root node

  • fn set_menu_bar:

  Adds a menu to the root node (builder method)

  • fn with_menu_bar:

    • -> StyledDom

  Adds a context menu to the root node

  • fn set_context_menu:

  Adds a context menu to the root node (builder method)

  • fn with_context_menu:

    • -> StyledDom

OpenGl helper types (Texture, Gl, etc.)

mod gl:

• struct Texture

  • constructor new:

    • -> Texture

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

  • constructor allocate_rgba8:

    • -> Texture

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

  • constructor allocate_clip_mask:

    • -> Texture

  Clears the texture with the currently set background color

  • fn clear:

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

  • fn draw_clip_mask:

    • -> bool

  Draws a &TessellatedGPUSvgNode with the given color to the texture

  • fn draw_tesselated_svg_gpu_node:

    • -> bool

  Draws a &TessellatedColoredGPUSvgNode with the given color to the texture

  • fn draw_tesselated_colored_svg_gpu_node:

    • -> bool

  Applies an FXAA filter to the texture

  • fn apply_fxaa:

    • -> bool

• struct Gl

  • fn get_type:

    • -> GlType

  • fn buffer_data_untyped:

  • fn buffer_sub_data_untyped:

  • fn map_buffer:

    • -> GlVoidPtrMut

  • fn map_buffer_range:

    • -> GlVoidPtrMut

  • fn unmap_buffer:

    • -> u8

  • fn tex_buffer:

  • fn shader_source:

  • fn read_buffer:

  • fn read_pixels_into_buffer:

  • fn read_pixels:

    • -> U8Vec

  • fn read_pixels_into_pbo:

  • fn sample_coverage:

  • fn polygon_offset:

  • fn pixel_store_i:

  • fn gen_buffers:

    • -> GLuintVec

  • fn gen_renderbuffers:

    • -> GLuintVec

  • fn gen_framebuffers:

    • -> GLuintVec

  • fn gen_textures:

    • -> GLuintVec

  • fn gen_vertex_arrays:

    • -> GLuintVec

  • fn gen_queries:

    • -> GLuintVec

  • fn begin_query:

  • fn end_query:

  • fn query_counter:

  • fn get_query_object_iv:

    • -> i32

  • fn get_query_object_uiv:

    • -> u32

  • fn get_query_object_i64v:

    • -> i64

  • fn get_query_object_ui64v:

    • -> u64

  • fn delete_queries:

  • fn delete_vertex_arrays:

  • fn delete_buffers:

  • fn delete_renderbuffers:

  • fn delete_framebuffers:

  • fn delete_textures:

  • fn framebuffer_renderbuffer:

  • fn renderbuffer_storage:

  • fn depth_func:

  • fn active_texture:

  • fn attach_shader:

  • fn bind_attrib_location:

  • fn get_uniform_iv:

  • fn get_uniform_fv:

  • fn get_uniform_block_index:

    • -> u32

  • fn get_uniform_indices:

    • -> GLuintVec

  • fn bind_buffer_base:

  • fn bind_buffer_range:

  • fn uniform_block_binding:

  • fn bind_buffer:

  • fn bind_vertex_array:

  • fn bind_renderbuffer:

  • fn bind_framebuffer:

  • fn bind_texture:

  • fn draw_buffers:

  • fn tex_image_2d:

  • fn compressed_tex_image_2d:

  • fn compressed_tex_sub_image_2d:

  • fn tex_image_3d:

  • fn copy_tex_image_2d:

  • fn copy_tex_sub_image_2d:

  • fn copy_tex_sub_image_3d:

  • fn tex_sub_image_2d:

  • fn tex_sub_image_2d_pbo:

  • fn tex_sub_image_3d:

  • fn tex_sub_image_3d_pbo:

  • fn tex_storage_2d:

  • fn tex_storage_3d:

  • fn get_tex_image_into_buffer:

  • fn copy_image_sub_data:

  • fn invalidate_framebuffer:

  • fn invalidate_sub_framebuffer:

  • fn get_integer_v:

  • fn get_integer_64v:

  • fn get_integer_iv:

  • fn get_integer_64iv:

  • fn get_boolean_v:

  • fn get_float_v:

  • fn get_framebuffer_attachment_parameter_iv:

    • -> i32

  • fn get_renderbuffer_parameter_iv:

    • -> i32

  • fn get_tex_parameter_iv:

    • -> i32

  • fn get_tex_parameter_fv:

    • -> f32

  • fn tex_parameter_i:

  • fn tex_parameter_f:

  • fn framebuffer_texture_2d:

  • fn framebuffer_texture_layer:

  • fn blit_framebuffer:

  • fn vertex_attrib_4f:

  • fn vertex_attrib_pointer_f32:

  • fn vertex_attrib_pointer:

  • fn vertex_attrib_i_pointer:

  • fn vertex_attrib_divisor:

  • fn viewport:

  • fn scissor:

  • fn line_width:

  • fn use_program:

  • fn validate_program:

  • fn draw_arrays:

  • fn draw_arrays_instanced:

  • fn draw_elements:

  • fn draw_elements_instanced:

  • fn blend_color:

  • fn blend_func:

  • fn blend_func_separate:

  • fn blend_equation:

  • fn blend_equation_separate:

  • fn color_mask:

  • fn cull_face:

  • fn front_face:

  • fn enable:

  • fn disable:

  • fn hint:

  • fn is_enabled:

    • -> u8

  • fn is_shader:

    • -> u8

  • fn is_texture:

    • -> u8

  • fn is_framebuffer:

    • -> u8

  • fn is_renderbuffer:

    • -> u8

  • fn check_frame_buffer_status:

    • -> u32

  • fn enable_vertex_attrib_array:

  • fn disable_vertex_attrib_array:

  • fn uniform_1f:

  • fn uniform_1fv:

  • fn uniform_1i:

  • fn uniform_1iv:

  • fn uniform_1ui:

  • fn uniform_2f:

  • fn uniform_2fv:

  • fn uniform_2i:

  • fn uniform_2iv:

  • fn uniform_2ui:

  • fn uniform_3f:

  • fn uniform_3fv:

  • fn uniform_3i:

  • fn uniform_3iv:

  • fn uniform_3ui:

  • fn uniform_4f:

  • fn uniform_4i:

  • fn uniform_4iv:

  • fn uniform_4ui:

  • fn uniform_4fv:

  • fn uniform_matrix_2fv:

  • fn uniform_matrix_3fv:

  • fn uniform_matrix_4fv:

  • fn depth_mask:

  • fn depth_range:

  • fn get_active_attrib:

    • -> GetActiveAttribReturn

  • fn get_active_uniform:

    • -> GetActiveUniformReturn

  • fn get_active_uniforms_iv:

    • -> GLintVec

  • fn get_active_uniform_block_i:

    • -> i32

  • fn get_active_uniform_block_iv:

    • -> GLintVec

  • fn get_active_uniform_block_name:

    • -> String

  • fn get_attrib_location:

    • -> i32

  • fn get_frag_data_location:

    • -> i32

  • fn get_uniform_location:

    • -> i32

  • fn get_program_info_log:

    • -> String

  • fn get_program_iv:

  • fn get_program_binary:

    • -> GetProgramBinaryReturn

  • fn program_binary:

  • fn program_parameter_i:

  • fn get_vertex_attrib_iv:

  • fn get_vertex_attrib_fv:

  • fn get_vertex_attrib_pointer_v:

    • -> isize

  • fn get_buffer_parameter_iv:

    • -> i32

  • fn get_shader_info_log:

    • -> String

  • fn get_string:

    • -> String

  • fn get_string_i:

    • -> String

  • fn get_shader_iv:

  • fn get_shader_precision_format:

    • -> GlShaderPrecisionFormatReturn

  • fn compile_shader:

  • fn create_program:

    • -> u32

  • fn delete_program:

  • fn create_shader:

    • -> u32

  • fn delete_shader:

  • fn detach_shader:

  • fn link_program:

  • fn clear_color:

  • fn clear:

  • fn clear_depth:

  • fn clear_stencil:

  • fn flush:

  • fn finish:

  • fn get_error:

    • -> u32

  • fn stencil_mask:

  • fn stencil_mask_separate:

  • fn stencil_func:

  • fn stencil_func_separate:

  • fn stencil_op:

  • fn stencil_op_separate:

  • fn egl_image_target_texture2d_oes:

  • fn generate_mipmap:

  • fn insert_event_marker_ext:

  • fn push_group_marker_ext:

  • fn pop_group_marker_ext:

  • fn debug_message_insert_khr:

  • fn push_debug_group_khr:

  • fn pop_debug_group_khr:

  • fn fence_sync:

    • -> GLsyncPtr

  • fn client_wait_sync:

    • -> u32

  • fn wait_sync:

  • fn delete_sync:

  • fn texture_range_apple:

  • fn gen_fences_apple:

    • -> GLuintVec

  • fn delete_fences_apple:

  • fn set_fence_apple:

  • fn finish_fence_apple:

  • fn test_fence_apple:

  • fn test_object_apple:

    • -> u8

  • fn finish_object_apple:

  • fn get_frag_data_index:

    • -> i32

  • fn blend_barrier_khr:

  • fn bind_frag_data_location_indexed:

  • fn get_debug_messages:

    • -> DebugMessageVec

  • fn provoking_vertex_angle:

  • fn gen_vertex_arrays_apple:

    • -> GLuintVec

  • fn bind_vertex_array_apple:

  • fn delete_vertex_arrays_apple:

  • fn copy_texture_chromium:

  • fn copy_sub_texture_chromium:

  • fn egl_image_target_renderbuffer_storage_oes:

  • fn copy_texture_3d_angle:

  • fn copy_sub_texture_3d_angle:

  • fn buffer_storage:

  • fn flush_mapped_buffer_range:

• struct VertexArrayObject

  • constructor new:

    • -> VertexArrayObject

• struct VertexBuffer

  • constructor new:

    • -> VertexBuffer

• struct TextureFlags

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

  • constructor default:

    • -> TextureFlags

Struct definitions for image loading

mod image:

• struct ImageRef

  Creates an "invalid" image with a width and height that reserves an image key, but does not render anything

  • constructor null_image:

    • -> ImageRef

  Creates an image reference from a CPU-backed buffer

  • constructor raw_image:

    • -> OptionImageRef

  Creates an image reference from an OpenGL texture

  • constructor gl_texture:

    • -> ImageRef

  Creates an image reference from a callback that is going to be rendered with the given nodes computed size

  • constructor callback:

    • -> ImageRef

  Creates a new copy of the image bytes instead of shallow-copying the reference

  • fn clone_bytes:

    • -> ImageRef

  Returns whether the image is a null (invalid) image

  • fn is_invalid:

    • -> bool

  Returns whether the image is a GL texture

  • fn is_gl_texture:

    • -> bool

  Returns whether the image is a raw (CPU-decoded) image

  • fn is_raw_image:

    • -> bool

  Returns whether the image is a RenderImageCallback

  • fn is_callback:

    • -> bool

  If the image is a RawImage, returns a COPY of the internal image bytes (useful for encoding the RawImage / exporting the ImageRef to a file)

  • fn get_raw_image:

    • -> OptionRawImage

  Returns the hash of the ImageRef (fast)

  • fn get_hash:

    • -> u64

• struct RawImage

  Returns a zero-sized image

  • constructor empty:

    • -> RawImage

  Allocates a width * height, single-channel image with zeroed bytes

  • constructor allocate_clip_mask:

    • -> RawImage

  Decodes a RawImage from any supported image format - automatically guesses the format based on magic header

  • constructor decode_image_bytes_any:

    • -> ResultRawImageDecodeImageError

  • fn draw_clip_mask:

    • -> bool

  Encodes the RawImage in the BMP image format

  • fn encode_bmp:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the PNG image format

  • fn encode_png:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the JPG image format

  • fn encode_jpeg:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the TGA image format

  • fn encode_tga:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the PNM image format

  • fn encode_pnm:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the GIF image format

  • fn encode_gif:

    • -> ResultU8VecEncodeImageError

  Encodes the RawImage in the TIFF image format

  • fn encode_tiff:

    • -> ResultU8VecEncodeImageError

Font decoding / parsing module

mod font:

• struct FontMetrics

  Returns a FontMetrics struct with all fields set to 0

  • constructor zero:

    • -> FontMetrics

  If set, use OS/2.sTypoAscender - OS/2.sTypoDescender + OS/2.sTypoLineGap to calculate the height.

  • fn use_typo_metrics:

    • -> bool

  • fn get_ascender:

    • -> f32

  • fn get_descender:

    • -> f32

  • fn get_line_gap:

    • -> f32

  • fn get_x_min:

    • -> f32

  • fn get_y_min:

    • -> f32

  • fn get_x_max:

    • -> f32

  • fn get_y_max:

    • -> f32

  • fn get_advance_width_max:

    • -> f32

  • fn get_min_left_side_bearing:

    • -> f32

  • fn get_min_right_side_bearing:

    • -> f32

  • fn get_x_max_extent:

    • -> f32

  • fn get_x_avg_char_width:

    • -> f32

  • fn get_y_subscript_x_size:

    • -> f32

  • fn get_y_subscript_y_size:

    • -> f32

  • fn get_y_subscript_x_offset:

    • -> f32

  • fn get_y_subscript_y_offset:

    • -> f32

  • fn get_y_superscript_x_size:

    • -> f32

  • fn get_y_superscript_y_size:

    • -> f32

  • fn get_y_superscript_x_offset:

    • -> f32

  • fn get_y_superscript_y_offset:

    • -> f32

  • fn get_y_strikeout_size:

    • -> f32

  • fn get_y_strikeout_position:

    • -> f32

• Atomically reference-counted parsed font data

  struct FontRef

  Parses a new font from bytes. Returns None if the font could not be parsed correctly.

  • constructor parse:

    • -> OptionFontRef

  Returns the font bytes of the underlying font source

  • fn get_bytes:

    • -> U8Vec

  Returns the font metrics of the parsed font

  • fn get_font_metrics:

    • -> FontMetrics

  Returns the text layout of the shaped text

  • fn shape_text:

    • -> InlineText

  Returns the hash of the FontRef (fast)

  • fn get_hash:

    • -> u64

SVG parsing and rendering functions

mod svg:

• struct Svg

  • constructor from_string:

    • -> ResultSvgSvgParseError

  • constructor from_bytes:

    • -> ResultSvgSvgParseError

  • fn get_root:

    • -> SvgXmlNode

  • fn render:

    • -> OptionRawImage

  • fn to_string:

    • -> String

• struct SvgXmlNode

  • constructor parse_from:

    • -> ResultSvgXmlNodeSvgParseError

• struct SvgMultiPolygon

  Returns the bounds of the polygon

  • fn get_bounds:

    • -> SvgRect

  Returns whether the polygon contains a point

  • fn contains_point:

    • -> bool

  Unions two MultiPolygons, returns the unioned MultiPolygon

  • fn union:

    • -> SvgMultiPolygon

  Intersects two MultiPolygons, returns the intersected MultiPolygon

  • fn intersection:

    • -> SvgMultiPolygon

  Calculates the difference two MultiPolygons, returns a MultiPolygon

  • fn difference:

    • -> SvgMultiPolygon

  Xors two MultiPolygons, returns a MultiPolygon

  • fn xor:

    • -> SvgMultiPolygon

  • fn tessellate_fill:

    • -> TessellatedSvgNode

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgNode

  • fn tessellate_fill:

    • -> TessellatedSvgNode

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

  Returns whether the shape is closed

  • fn is_closed:

    • -> bool

  Returns the bounds of the polygon

  • fn contains_point:

    • -> bool

  • fn get_bounds:

    • -> SvgRect

• struct SvgSimpleNode

  • fn get_bounds:

    • -> SvgRect

• struct SvgStyledNode

  • fn tessellate:

    • -> TessellatedSvgNode

• struct SvgCircle

  • fn tessellate_fill:

    • -> TessellatedSvgNode

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgPath

  Returns whether the path is closed

  • fn is_closed:

    • -> bool

  Reverses the order of points in the path so that the path runs in the opposite direction afterwards

  • fn reverse:

  Returns the first point of the path (or None if path has no items)

  • fn get_start:

    • -> OptionSvgPoint

  Returns the first point of the path (or None if path has no items)

  • fn get_end:

    • -> OptionSvgPoint

  Returns the axis-aligned bounding rect of this path

  • fn get_bounds:

    • -> SvgRect

  Adds a path to the end of the current path

  • fn join_with:

  Offset the path by a certain distance. Will create bezier curves around the edges when the path is closed

  • fn offset:

    • -> SvgPath

  Round the edges with a cubic curve

  • fn bevel:

    • -> SvgPath

  • fn tessellate_fill:

    • -> TessellatedSvgNode

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgPathElement

  Reverses the order of points in the path so that the path runs in the opposite direction afterwards

  • fn reverse:

  Returns the starting point of this item

  • fn get_start:

    • -> SvgPoint

  Returns the ending point of this item

  • fn get_end:

    • -> SvgPoint

  Returns the bounding box of this item

  • fn get_bounds:

    • -> SvgRect

  Returns the length of the line or curve

  • fn get_length:

    • -> f64

  Returns the interpolation value t (between 0 and 1) at the given offset from the line or curve start

  • fn get_t_at_offset:

    • -> f64

  Returns the point on the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_x_at_t:

    • -> f64

  Returns the y position of the line or curve at t

  • fn get_y_at_t:

    • -> f64

  Returns the angle in DEGREES of the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_tangent_vector_at_t:

    • -> SvgVector

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgPoint

  Returns the euclidean distance to some other point

  • fn distance:

    • -> f64

• struct SvgVector

  Returns the angle of this vector in degrees

  • fn angle_degrees:

    • -> f64

  Normalizes the vector, returning the normalized vector

  • fn normalize:

    • -> SvgVector

  Rotates the vector 90 degrees counter clockwise, returning the rotated vector

  • fn rotate_90deg_ccw:

    • -> SvgVector

• struct SvgLine

  Reverses the order of points in the path so that the path runs in the opposite direction afterwards

  • fn reverse:

  Returns the starting point of this item

  • fn get_start:

    • -> SvgPoint

  Returns the ending point of this item

  • fn get_end:

    • -> SvgPoint

  Returns the bounding box of this item

  • fn get_bounds:

    • -> SvgRect

  Returns the length of the line or curve

  • fn get_length:

    • -> f64

  Returns the interpolation value t (between 0 and 1) at the given offset from the line or curve start

  • fn get_t_at_offset:

    • -> f64

  Returns the point on the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_x_at_t:

    • -> f64

  Returns the y position of the line or curve at t

  • fn get_y_at_t:

    • -> f64

  Returns the angle in DEGREES of the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_tangent_vector_at_t:

    • -> SvgVector

  Intersect two lines EVEN IF THEY ARE DISTINCT. Only returns None on parallel lines (never intersect)

  • fn intersect:

    • -> OptionSvgPoint

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgQuadraticCurve

  Reverses the order of points in the curve so that the curve runs in the opposite direction afterwards

  • fn reverse:

  Returns the starting point of this item

  • fn get_start:

    • -> SvgPoint

  Returns the ending point of this item

  • fn get_end:

    • -> SvgPoint

  Returns the bounding box of this item

  • fn get_bounds:

    • -> SvgRect

  Returns the length of the line or curve

  • fn get_length:

    • -> f64

  Returns the interpolation value t (between 0 and 1) at the given offset from the line or curve start

  • fn get_t_at_offset:

    • -> f64

  Returns the point on the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_x_at_t:

    • -> f64

  Returns the y position of the line or curve at t

  • fn get_y_at_t:

    • -> f64

  Returns the angle in DEGREES of the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_tangent_vector_at_t:

    • -> SvgVector

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgCubicCurve

  Reverses the order of points in the curve so that the curve runs in the opposite direction afterwards

  • fn reverse:

  Returns the starting point of this item

  • fn get_start:

    • -> SvgPoint

  Returns the ending point of this item

  • fn get_end:

    • -> SvgPoint

  Returns the bounding box of this item

  • fn get_bounds:

    • -> SvgRect

  Returns the length of the line or curve

  • fn get_length:

    • -> f64

  Returns the interpolation value t (between 0 and 1) at the given offset from the line or curve start

  • fn get_t_at_offset:

    • -> f64

  Returns the point on the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_x_at_t:

    • -> f64

  Returns the y position of the line or curve at t

  • fn get_y_at_t:

    • -> f64

  Returns the angle in DEGREES of the line or curve at t (t = interpolation value between 0 and 1)

  • fn get_tangent_vector_at_t:

    • -> SvgVector

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct SvgRect

  • fn get_center:

    • -> SvgPoint

  • fn contains_point:

    • -> bool

  • fn expand:

    • -> SvgRect

  • fn tessellate_fill:

    • -> TessellatedSvgNode

  • fn tessellate_stroke:

    • -> TessellatedSvgNode

• struct TessellatedColoredSvgNode

  Returns an empty buffer vertices / indices

  • constructor empty:

    • -> TessellatedColoredSvgNode

  Creates a new TessellatedColoredSvgNode by joining all the given nodes together into one array and inserting a GL_RESTART_INDEX (u32::MAX) into the indices (so that the resulting buffer can be drawn in one draw call).

  • constructor from_nodes:

    • -> TessellatedColoredSvgNode

• struct TessellatedColoredGPUSvgNode

  • constructor new:

    • -> TessellatedColoredGPUSvgNode

• struct TessellatedSvgNode

  Returns an empty buffer vertices / indices

  • constructor empty:

    • -> TessellatedSvgNode

  Creates a new TessellatedSvgNode by joining all the given nodes together into one array and inserting a GL_RESTART_INDEX (u32::MAX) into the indices (so that the resulting buffer can be drawn in one draw call).

  • constructor from_nodes:

    • -> TessellatedSvgNode

• struct TessellatedGPUSvgNode

  • constructor new:

    • -> TessellatedGPUSvgNode

• struct SvgParseOptions

  • constructor default:

    • -> SvgParseOptions

• struct SvgRenderOptions

  • constructor default:

    • -> SvgRenderOptions

• struct SvgFillStyle

  • constructor default:

    • -> SvgFillStyle

• struct SvgStrokeStyle

  • constructor default:

    • -> SvgStrokeStyle

XML parsing / decoding module

mod xml:

• struct Xml

  Parses an XML document with one or more root nodes

  • constructor from_str:

    • -> ResultXmlXmlError

Filesystem / file input and output module

mod fs:

• Reference-counted file handle

  struct File

  Opens a file at the given path. If the file exists, replaces it with a new file

  • constructor open:

    • -> OptionFile

  Creates a file at the given path. If the file exists, replaces it with a new file

  • constructor create:

    • -> OptionFile

  Reads the file to a UTF8-encoded String, returns None if the file can't be decoded correctly

  • fn read_to_string:

    • -> OptionString

  Reads the file as bytes, returns None if the file can't be decoded correctly

  • fn read_to_bytes:

    • -> OptionU8Vec

  Writes a string to the file, synchronizes the results before returning

  • fn write_string:

    • -> bool

  Writes some bytes to the file, synchronizes the results before returning

  • fn write_bytes:

    • -> bool

  Destructor, closes the file handle

  • fn close:

Interface for system file selection dialogs / popup message boxes, etc.

mod dialog:

• struct MsgBox

  Opens an informational message box with only an "OK" button

  • constructor ok:

    • -> bool

  Shorthand for MsgBox::ok("Info", $message, Icon::Info)

  • constructor info:

    • -> bool

  Shorthand for MsgBox::ok("Warning", $message, Icon::Warning)

  • constructor warning:

    • -> bool

  Shorthand for MsgBox::ok("Error", $message, Icon::Error)

  • constructor error:

    • -> bool

  Shorthand for MsgBox::ok("Question", $message, Icon::Question)

  • constructor question:

    • -> bool

  Opens a ok / cancel message box. Blocks the current thread.

  • constructor ok_cancel:

    • -> MsgBoxOkCancel

  Opens a yes / no message box. Blocks the current thread.

  • constructor yes_no:

    • -> MsgBoxYesNo

• File picker dialog

  struct FileDialog

  Select a single file using the system-native file picker. Blocks the current thread.

  • constructor select_file:

    • The path that the user wants to open, None if the user has cancelled or closed the dialog

      -> OptionString

  Select multiple files using the system-native file picker. Blocks the current thread.

  • constructor select_multiple_files:

    • The path(s) that the user wants to open, None if the user has cancelled or closed the dialog

      -> OptionStringVec

  Open a dialog prompting the user to select a directory to open. Blocks the current thread.

  • constructor select_folder:

    • The folder that the user wants to open, None if the user has cancelled or closed the dialog

      -> OptionString

  Open a dialog prompting the user to save a file. Blocks the current thread.

  • constructor save_file:

    • The path that the user wants to save the file to, None if the user has cancelled or closed the dialog

      -> OptionString

• struct ColorPickerDialog

  Opens a system-native color picker dialog

  • constructor open:

    • -> OptionColorU

Classes to talk to the system clipboard manager

mod clipboard:

• Connection to the system clipboard, on some systems this connection can be cached

  struct SystemClipboard

  Creates a new connection to the system clipboard manager

  • constructor new:

    • -> OptionSystemClipboard

  Returns the system clipboard contents or None if the clipboard is empty or there was an error

  • fn get_string_contents:

    • -> OptionString

  Sets the system clipboard contents to the new string, returns true if the system clipboard was updated

  • fn set_string_contents:

    • -> bool

Rust wrappers for Instant / Duration classes

mod time:

• struct Instant

  Returns the duration since and earlier instant or None if the earlier instant is later than self

  • fn duration_since:

    • -> OptionDuration

  Adds a duration to the current time instant, returning the new Instant

  • fn add_duration:

    • The new Instant with the added duration

      -> Instant

  Linearly interpolates between [start, end] if the self Instant lies between start and end. Returns values between 0.0 and 1.0

  • fn linear_interpolate:

    • Interpolation value clamped to the 0.0 - 1.0 range

      -> f32

Asyncronous timers / task / thread handlers for easy async loading

mod task:

• struct Timer

  • constructor new:

    • -> Timer

  • fn with_delay:

    • -> Timer

  • fn with_interval:

    • -> Timer

  • fn with_timeout:

    • -> Timer

• struct ThreadSender

  • fn send:

    • -> bool

• struct ThreadReceiver

  • fn receive:

    • -> OptionThreadSendMsg

Definition of azuls internal String wrappers

mod str:

• struct String

  Creates a dynamically formatted String from a fomat string + named arguments

  • constructor format:

    • -> String

  Creates a new String from an arbitary pointer, a start offset (bytes from the start pointer, usually 0) and a length (in bytes). The bytes are expected to point to a UTF-8 encoded string, no error checking is performed.

  • constructor copy_from_bytes:

    • -> String

  Trims whitespace from the start / end of the string

  • fn trim:

    • -> String

  Returns a reference to the string - NOTE: the returned value is a reference to self, you MUST NOT drop the String object that the Refstr references

  • fn as_refstr:

    • -> Refstr

Definition of azuls internal Vec<*> wrappers

mod vec:

• Wrapper over a Rust-allocated Vec<TessellatedSvgNode>

  struct TessellatedSvgNodeVec

  Returns the TessellatedSvgNodeVec as a non-owning slice, NOTE: The U8Vec that this slice was borrowed from MUST NOT be deleted before the U8VecRef

  • fn as_ref_vec:

    • -> TessellatedSvgNodeVecRef

• Wrapper over a Rust-allocated Vec<TessellatedColoredSvgNode>

  struct TessellatedColoredSvgNodeVec

  Returns the TessellatedColoredSvgNodeVec as a non-owning slice, NOTE: The TessellatedColoredSvgNodeVec that this slice was borrowed from MUST NOT be deleted before the U8VecRef

  • fn as_ref_vec:

    • -> TessellatedColoredSvgNodeVecRef

• Wrapper over a Rust-allocated U8Vec

  struct U8Vec

  Creates a new, heap-allocated U8Vec by copying the memory into Rust (heap allocation)

  • constructor copy_from_bytes:

    • -> U8Vec

  Returns the U8Vec as a non-owning slice, NOTE: The U8Vec that this slice was borrowed from MUST NOT be deleted before the U8VecRef

  • fn as_ref_vec:

    • -> U8VecRef

Definition of azuls internal Option<*> wrappers

mod option:

Definition of error and Result<T, E> types

mod error: