Castle Game Engine

Class TImageBackgroundNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TImageBackgroundNode = class(TAbstractBackgroundNode)

Description

Display a 2D image as a background.

Hierarchy

Overview

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;
Public procedure SetTexCoords(const Value: array of TVector2); overload;
Public procedure SetTexCoords(const Value: TVector2List); overload;

Properties

Public property FdColor: TSFColorRGBA read FFdColor;
Public property Color: TCastleColor read GetColor write SetColor;
Public property FdTexture: TSFNode read FFdTexture;
Public property Texture: TAbstractTextureNode read GetTexture write SetTexture;
Public property FdTexCoords: TMFVec2f read FFdTexCoords;

Description

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;
 
Public procedure CreateNode; override;
 
Public class function ClassX3DType: string; override;
 
Public procedure SetTexCoords(const Value: array of TVector2); overload;

Texture coordinates of the full-screen quad. By default they use the whole texture area:

  1. Vector2(0, 0),

  2. Vector2(1, 0),

  3. Vector2(1, 1),

  4. Vector2(0, 1)

It is undefined what happens if there are not exactly 4 items.

Public procedure SetTexCoords(const Value: TVector2List); overload;

Texture coordinates of the full-screen quad. By default they use the whole texture area:

  1. Vector2(0, 0),

  2. Vector2(1, 0),

  3. Vector2(1, 1),

  4. Vector2(0, 1)

It is undefined what happens if there are not exactly 4 items.

Properties

Public property FdColor: TSFColorRGBA read FFdColor;

Internal wrapper for property Color. This wrapper API may change, we advise to access simpler Color instead.

Public property Color: TCastleColor read GetColor write SetColor;

Color that is multiplied by the texture color. Opaque white by default. Note that the alpha component of this color matters (just like the alpha channel of the texture in Texture). If the resulting image is partially-transparent, it will be mixed with black underneath.

Public property FdTexture: TSFNode read FFdTexture;

Internal wrapper for property Texture. This wrapper API may change, we advise to access simpler Texture instead.

Public property Texture: TAbstractTextureNode read GetTexture write SetTexture;

Texture displayed in a full-screen quad. Only 2D single-texture nodes are supported now. If you leave this as Nil, the TImageBackgroundNode has no visible effect.

Public property FdTexCoords: TMFVec2f read FFdTexCoords;

Internal wrapper for property TexCoords. This wrapper API may change, we advise to access simpler TexCoords instead.

Generated by PasDoc 0.16.0.