UILabel

Simple area with text.

Members

Functions

font
Font font()
font
Font font(Font font_)

Sets text size.

text
string text()
text
string text(string text_)

Sets displayed text.

textColor
RGBA textColor()
textColor
RGBA textColor(RGBA textColor_)

Sets diffuse color of displayed text.

textSize
float textSize()
textSize
float textSize(float textSize_)

Sets size of displayed text.

Variables

_font
Font _font;

The font used for text.

_letterSpacing
float _letterSpacing;

Additional space between letters, in pixels.

_text
string _text;

Text to draw

_textColor
RGBA _textColor;

Diffuse color of displayed text.

_textSize
float _textSize;

Size of displayed text in pixels.

clickable
bool clickable;

Sets to true if this is clickable

Inherited Members

From UIElement

renderRaw
void renderRaw(ImageRef!RGBA rawMap, in box2i[] areasToUpdate)

This method is called for each item in the drawlist that was visible and has a dirty Raw layer. This is called after compositing, starting from the buffer output by the Compositor.

renderPBR
void renderPBR(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, in box2i[] areasToUpdate)
reflow
void reflow(box2i availableSpace)

TODO: useless until we have resizeable UIs. Meant to be overriden almost everytime for custom behaviour. Default behaviour is to span the whole area and reflow children. Any layout algorithm is up to you. Like in the DOM, children elements don't need to be inside _position of their parent.

position
box2i position()
position
box2i position(box2i p)

Forces the position of the element. It is typically used in the parent reflow() method IMPORTANT: As of today you are not allowed to assign a position outside the extent of

removeChild
void removeChild(UIElement element)

Removes a child (but does not destroy it, you take back the ownership of it). Useful for creating dynamic UI's. MAYDO: there are restrictions for where this is allowed. Find them.

setDirtyWhole
void setDirtyWhole(UILayer layer = UILayer.guessFromFlags)

Mark this element as wholly dirty.

setDirty
void setDirty(box2i rect, UILayer layer = UILayer.guessFromFlags)

Mark a part of the element dirty. This part must be a subrect of its _position.

parent
UIElement parent()
topLevelParent
UIElement topLevelParent()
getDrawLists
void getDrawLists(ref Vec!UIElement listRaw, ref Vec!UIElement listPBR)

Appends the Elements that should be drawn, in order. You should empty it before calling this function. Everything visible get into the draw list, but that doesn't mean they will get drawn if they don't overlap with a dirty area.

onDrawRaw
void onDrawRaw(ImageRef!RGBA rawMap, box2i[] dirtyRects)

Raw layer draw method. This gives you 1 surface cropped by _position for drawing. Note that you are not forced to draw all to the surfacs at all.

onDrawPBR
void onDrawPBR(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, box2i[] dirtyRects)

PBR layer draw method. This gives you 3 surfaces cropped by _position for drawing. Note that you are not forced to draw all to the surfaces at all, in which case the below UIElement will be displayed.

onAnimate
void onAnimate(double dt, double time)

Called periodically for every UIElement. Override this to create animations. Using setDirty there allows to redraw an element continuously (like a meter or an animated object). Warning: Summing dt will not lead to a time that increase like time. time can go backwards if the window was reopen. time is guaranteed to increase as fast as system time but is not synced to audio time.

_parent
UIElement _parent;

Parent element. Following this chain gets to the root element.

_position
box2i _position;

Position is the graphical extent of the element, or something larger. An UIElement is not allowed though to draw further than its _position. For efficiency it's best to keep _position as small as feasible.

_children
Vec!UIElement _children;

The list of children UI elements.

_visible
bool _visible;

If _visible is false, neither the Element nor its children are drawn.

_flags
immutable(uint) _flags;

Flags, for now immutable

_zOrder
int _zOrder;

Higher z-order = above other UIElement. By default, every UIElement have the same z-order. Because the sort is stable, tree traversal order is the default order (depth first).

Meta