Class TCastleFlashEffect

Unit

Declaration

type TCastleFlashEffect = class(TCastleUserInterface)

Description

Fade out, flash, and similar screen effects done by blending screen with given color.

Hierarchy

Overview

Fields

Public nested const DefaultDuration = 0.5;

Methods

Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Update(const SecondsPassed: Single; var HandleInput: boolean); override;
Public procedure Render; override;
Public procedure Flash(const AColor: TCastleColor; const ADark: boolean);
Public procedure Reset;
Public function Active: boolean;

Properties

Published property Duration: Single read FDuration write FDuration default DefaultDuration;
Published property Image: TCastleImagePersistent read FImage;
Published property FullSize default true;

Description

Fields

Public nested const DefaultDuration = 0.5;
 

Methods

Public constructor Create(AOwner: TComponent); override;
 
Public destructor Destroy; override;
 
Public procedure Update(const SecondsPassed: Single; var HandleInput: boolean); override;
 
Public procedure Render; override;
 
Public procedure Flash(const AColor: TCastleColor; const ADark: boolean);
 
Public procedure Reset;
 
Public function Active: boolean;

Is the effect in-progress. This is temporarily True after calling Flash. It automatically ends (switches to False) after the Duration has passed, and when you call Reset explicitly.

Properties

Published property Duration: Single read FDuration write FDuration default DefaultDuration;
 
Published property Image: TCastleImagePersistent read FImage;

Set this image to modulate the color with an image. The image is always stretched to cover our whole size.

Published property FullSize default true;
 

Generated by PasDoc 0.15.0.