Skip to content

IUIComponent Interface

Definition

Namespace: Brine2D.UI

Base interface for all UI components.

C#
public interface IUIComponent

Derived
IAnchoredUIComponent
IUIWorldComponent
UIButton
UICheckbox
UIDialog
UIDropdown
UIDropTarget
UIGrid
UIImage
UILabel
UIMenuBar
UIPanel
UIProgressBar
UIRadioButton
UIRichTextLabel
UIScrollView
UISlider
UISpinBox
UIStackPanel
UITabContainer
UITextArea
UITextInput
UITreeView
UIVirtualListBase
UIWorldLabel

Properties
Enabled Whether this component is enabled \(can receive input\).
Name Optional name used to look up this component by FindByName\(string\).
Position Position in screen space \(pixels\).
Size Size in pixels.
TabIndex Tab-focus order. Lower values receive focus first; equal values fall back to canvas add-order \(last\-added first\). Defaults to System.Int32.MaxValue.
Tooltip Optional tooltip for this component.
Visible Whether this component is visible.
ZOrder Visual and input stacking order. Higher values render on top; equal values fall back to canvas add-order \(last\-added on top\). Defaults to 0.
Methods
Contains\(Vector2\) Returns true if screenPosition is within this component's bounds.
Render\(IRenderer\) Renders the component.
Update\(float\) Called each frame to advance component logic.