Skip to content

IUIWorldComponent Interface

Definition

Namespace: Brine2D.UI

Extends IUIComponent for components positioned in world space. UICanvas projects WorldPosition to screen coordinates each frame via WorldCamera and writes the result into Position before rendering.

C#
public interface IUIWorldComponent : Brine2D.UI.IUIComponent

Derived
UIWorldLabel

Implements IUIComponent

Remarks

World components do not participate in tab-focus, drag-and-drop, or normal mouse-input dispatch. They render as overlays on top of all regular components.

Properties
CullWhenOffScreen Hides the component when its projected position falls outside the viewport. Defaults to true.
ScreenOffset Pixel offset applied after world-to-screen projection. Use to nudge the component relative to its anchor — e.g. new Vector2(-Size.X / 2, -40) to centre it 40 px above the world point.
WorldPosition Position in world space. Projected to screen coordinates via WorldCamera before each render pass.