Class TCastleFlashEffect

Unit

CastleFlashEffect

Declaration

type TCastleFlashEffect = class(TCastleUserInterface)

Description

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

Hierarchy

• TObject
• TPersistent
• TComponent
• TCastleComponent
• TCastleUserInterface
• TCastleFlashEffect

Overview

Fields

nested const DefaultDuration = 0.5;

Methods

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

Properties

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

Description

Fields

	nested const DefaultDuration = 0.5;

Methods

	constructor Create(AOwner: TComponent); override;

	destructor Destroy; override;

	procedure Update(const SecondsPassed: Single; var HandleInput: boolean); override;

	procedure Render; override;

	procedure Flash(const AColor: TCastleColor; const ADark: boolean);

	procedure Reset;

	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

	property Duration: Single read FDuration write FDuration default DefaultDuration;

	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.

	property FullSize default true;

---

Generated by PasDoc 0.16.0.