CAST II Game Engine

Class TTextures

Unit

Declaration

type TTextures = class

Description

Fields

	Name	Description
	`FTextures`
	`Renderer`

Methods

Overview

	`destructor Destroy; override;`
	`function APICreateTexture(Index: Integer): Boolean; virtual; abstract;`
	`procedure Apply(Stage, Index: Integer); virtual; abstract;`
	`procedure Delete(Index: Integer); virtual;`
	`procedure FreeAll;`
	`procedure HandleMessage(const Msg: TMessage);`
	`function IsEmpty(const Element: TTexture): Boolean;`
	`function Load(Index: Integer): Boolean;`
	`function Lock(AIndex, AMipLevel: Integer; const ARect: BaseTypes.PRect; out LockRectData: TLockedRectData; LockFlags: TLockFlags): Boolean; virtual; abstract;`
	`function NewProceduralTexture(AFormat: Cardinal; AWidth, AHeight, ADepth, ALevels: Integer; Options: TTextureOptions): Integer;`
	`function NewTexture(Resource: TImageResource; Options: TTextureOptions): Integer;`
	`function Read(Index: Integer; Dest: Pointer; Rect: BaseTypes.PRect3D): Boolean; virtual; abstract;`
	`function Resolve(Pass: TRenderPass; StageIndex: Integer): Boolean;`
	`procedure Unload(Index: Integer); virtual; abstract;`
	`procedure UnLock(AIndex, AMipLevel: Integer); virtual; abstract;`
	`function Update(Index: Integer; Src: Pointer; Rect: BaseTypes.PRect3D): Boolean; virtual; abstract;`

Description

destructor Destroy; override;

function APICreateTexture(Index: Integer): Boolean; virtual; abstract;

Calls an API to create API-specific texture object

procedure Apply(Stage, Index: Integer); virtual; abstract;

Applies texture with the specified index to the specified API stage

procedure Delete(Index: Integer); virtual;

Removes the specified texture

procedure FreeAll;

Deletes all textures

procedure HandleMessage(const Msg: TMessage);

Handles some related messages

function IsEmpty(const Element: TTexture): Boolean;

Returns True if the specified texture is not initialized

function Load(Index: Integer): Boolean;

Loads the specified by index texture from its associated resource. Returns True if success.

function Lock(AIndex, AMipLevel: Integer; const ARect: BaseTypes.PRect; out LockRectData: TLockedRectData; LockFlags: TLockFlags): Boolean; virtual; abstract;

Locks the specified area of the specified level of the specified texture. This call should be accompanied by a corresponding UnLock call.

function NewProceduralTexture(AFormat: Cardinal; AWidth, AHeight, ADepth, ALevels: Integer; Options: TTextureOptions): Integer;

Adds a new procedural texture entry. Does not create any API-specific objects.

function NewTexture(Resource: TImageResource; Options: TTextureOptions): Integer;

Adds a new texture entry. Does not create any API-specific objects.

function Read(Index: Integer; Dest: Pointer; Rect: BaseTypes.PRect3D): Boolean; virtual; abstract;

Reads the specified rectangle of the specified by index texture in API to the given pointer. Returns True if success. Currently not implemented.

function Resolve(Pass: TRenderPass; StageIndex: Integer): Boolean;

Resolves a texture for the given pass. Used internally.

procedure Unload(Index: Integer); virtual; abstract;

Unloads the specified by index texture from API. Currently not implemented.

procedure UnLock(AIndex, AMipLevel: Integer); virtual; abstract;

Unlocks previously locked texture

function Update(Index: Integer; Src: Pointer; Rect: BaseTypes.PRect3D): Boolean; virtual; abstract;

Updates the specified rectangle of the specified by index texture in API from the given pointer. Returns True if success.