Class TCastleSimpleBackground

Unit

Declaration

type TCastleSimpleBackground = class(TCastleUserInterface)

Description

Warning: this symbol is deprecated: use TCastleRectangleControl with FullSize=true; note that by default it has White color, while TCastleSimpleBackground has by default Black color.

Fill the whole window with a simple color. This is very fast, but it unconditionally clears the whole window, and there is no blending (if your Color has some alpha, it is just copied to the color buffer).

To clear the rectangle with a color, with optional blending, use TCastleRectangleControl instead.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TComponent); override;
Public procedure Render; override;

Properties

Public property Width default 0;
Public property Height default 0;
Public property Color: TCastleColor read FColor write SetColor;

Description

Methods

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Public procedure Render; override;

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).

Properties

Public property Width default 0;

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

These properties determine the control size. See the EffectiveRect documentation for details how the size is calculated.

Public property Height default 0;

This item has no description.

Public property Color: TCastleColor read FColor write SetColor;

Background color. By default, this is black color with opaque alpha.


Generated by PasDoc 0.16.0-snapshot.