Class TCastleUserInterfaceFont

This item has no description.

This item has no description.

This item has no description.

This item has no description.

This item has no description.

This item has no description. Showing description inherited from TCastleUserInterface.TooltipExists.

Render a tooltip of this control. If you want to have tooltip for this control detected, you have to override TooltipExists. Then the TooltipRender will be called.

TooltipRender is called in the same way as Render. TooltipRender is always called as a last (front-most) control. Argument TooltipPosition is the left-bottom (in screen space, regardless of UIScaling) suggested position of the tooltip.

It is simplest to descend from TCastleUserInterfaceFont, that implements simple TCastleUserInterfaceFont.Tooltip property and overrides these two methods as necessary.

This item has no description.

This item has no description. Showing description inherited from TCastleUserInterface.Render.

Render a control. Called only when Exists and render context is initialized.

Do not call this method. It will be automatically called by the engine when needed. It will be called when UI is part of TCastleContainer.Controls list or rendered (e.g. for off-screen rendering) by TCastleContainer.RenderControl.

You should only override this method.

See https://castle-engine.io/manual_2d_ui_custom_drawn.php for examples what you can put here.

You can depend on some OpenGL state being set before calling this method. You can depend on it being set, and you can carelessly change it. This state we set:

• Viewport is set to include whole container.

• Depth test is off.

• For ancient fixed-function pipeline (see TGLFeatures.RequestCapabilities):

  • The 2D orthographic projection is always set at the beginning. Useful for 2D controls.

  • The modelview matrix is set to identity. The matrix mode is always modelview.

  • The raster position is set to (0,0). The (deprecated) WindowPos is also set to (0,0).

  • Texturing, lighting, fog is off.

Beware that GLSL RenderContext.CurrentProgram has undefined value when this is called. You should always set it, before making direct OpenGL drawing calls (all the engine drawing routines do it already, this is only a concern if you make direct OpenGL / OpenGLES calls).

This item has no description. Showing description inherited from TCastleComponent.PropertySections.

Section where to show property in the editor.

Copy font properties from another control.

Font used for rendering and measuring this control.

Depending on which one is set, this method returns CustomFont or TCastleContainer.DefaultFont or global UIFont. It may also return a TCastleFontFamily instance that wraps (and scales) one of them.

Check does currently used font (see Font) changed, and eventually call FontChanged method now.

You only need to explicitly call this in very specific circumstances, when you just changed UIFont or TCastleContainer.DefaultFont and you want control size to be updated immediately (for example, you need EffectiveHeight to be immediately valid). Without calling this, it could be updated only at next Render call.

Changing CustomFont automatically calls this.

Force considering font changed (font instance, or glyphs, or sizes changed).

Usually, you don't need to call this explicitly from the outside. Changing font, like CustomFont or TCastleContainer.DefaultFont or UIFont, or any property that may affect the font is automatically applied.

But there are exceptions: right now, if you call Load on a font, it's measurements will change but some controls using it will not recalculate sizes automatically. In this case, call this method.

Warning: this symbol is deprecated: use TCastleAbstractFont (inherited from TComponent) owner mechanism

This item has no description.

Warning: this symbol is deprecated: use "FontScale := 0.5" or "CustomFont := MySmalFont" instead of "SmallFont := true", this is more flexible

Use smaller font. Right now this just says to scale font by 0.5.

Outline color, used only if Outline <> 0. Default is black.

See also

Outline

Outline size around the font.

Tooltip string, displayed when user hovers the mouse over a control.

Note that you can override TCastleUserInterface.TooltipExists and TCastleUserInterface.TooltipRender to customize the tooltip drawing.

Font used to render text of this control. When this is Nil then the TCastleContainer.DefaultFont is used, or (when TCastleContainer.DefaultFont is also Nil) the global UIFont.

Use given font size when drawing. Leave at default zero to use the default size of the current font.

Scale the font. This additionally scales the font defined by all other properties of this class, thus you can use it to reliably scale the font (regardless if you use CustomFont or not, regardless if you set FontSize or not).

Outline size around the font. Note that the current implementation is very simple, it will only look sensible for small outline values (like 1 or 2).

See TCastleAbstractFont.Outline for more details.

Specifying a non-zero outline for a label overrides the default outline settings for the current font. By default, fonts do not have an outline.

TODO: UI scaling (TCastleContainer.UIScaling) doesn't affect outline size now.

See also

OutlineHighQuality

Optionally force better outline quality.

Optionally force better outline quality. Used only if Outline <> 0. High quality outline looks better, but is about 2x more expensive to draw.

See also

Outline

Outline size around the font.

OutlineColor that can be visually edited in Castle Game Engine Editor, Lazarus and Delphi. Normal user code does not need to deal with this, instead read or write OutlineColor directly.

See also

OutlineColor

Outline color, used only if Outline <> 0.