Class TGUIInOutFader

DescriptionHierarchyFieldsMethodsProperties

Unit

Irrlicht

Declaration

type TGUIInOutFader = class(TGUIElement)

Description

Element for fading out or in.
Here is a small example on how the class is used. In this example we fade in from a total red screen in the beginning. As you can see, the fader is not only useful for dramatic in and out fading, but also to show that the player is hit in a first person shooter game for example. 

    with GUIEnvironment.AddInOutFader do begin
        fader.Color := ARGBColor(0,255,0,0);
        fader.FadeIn(4000);
    end;

Hierarchy

Overview

Methods

Public function IsReady: Boolean; inline;
Public procedure FadeIn(Time: LongWord); inline;
Public procedure FadeOut(Time: LongWord); inline;
Public procedure SetColor(Source, Dest: TARGBColor); inline;

Properties

Public property Color: TARGBColor read GetColor write Set1Color;

Description

Methods

Public function IsReady: Boolean; inline;

Tells whether the fade in or out process is complete.

Public procedure FadeIn(Time: LongWord); inline;

Starts the fade in process.
In the beginning the whole rect is drawn by the set color (black by default) and at the end of the overgiven time the color has faded out.

Parameters
Time
Time specifying how long it should need to fade in, in milliseconds.
Public procedure FadeOut(Time: LongWord); inline;

Starts the fade out process.
In the beginning everything is visible, and at the end of the time only the set color (black by the fault) will be drawn.

Parameters
Time
Time specifying how long it should need to fade out, in milliseconds.
Public procedure SetColor(Source, Dest: TARGBColor); inline;

Sets the color to fade out to and to fade in from separately.

Properties

Public property Color: TARGBColor read GetColor write Set1Color;

The color to fade out to or to fade in from or sets both colors.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22