CAST II Game Engine

   MAIN       FEATURES       SCREENSHOTS       FORUMS       MANUAL       DOWNLOADS       CONTACTS   
Units
Class Hierarchy
Classes, Interfaces and Objects
Types
Enumerations
Variables
Constants
Functions and Procedures
Identifiers

Class TImageResource

Unit

Resources

Declaration

type TImageResource = class(TResource)

Description

Stores an image

Hierarchy

TResource > TItem > TBaseItem

Fields

 NameDescription
ProtectedFBitsPerPixelNumber of bits per pixel
ProtectedFHeightImage height
ProtectedFLevelsInformation about mip levels
ProtectedFMagFilterFilter used when the image size is increased. Image width have more priority than height when choosing filter.
ProtectedFMagFilterParameterParameter value for magnification filter
ProtectedFMinFilterFilter used when the image size is decreased and for mipmaps calculation
ProtectedFMinFilterParameterParameter value for minification filter
ProtectedFMipPolicyMip levels policy
ProtectedFRequestedLevelsNumber of mip levels requested (via properties). 0 to use FSuggestedLevels.
ProtectedFSuggestedLevelsSuggested number of mip levels based on dimensions
ProtectedFWidthImage width
PublicPaletteResourceResource containing image's palette (for paletted image formats only).

Methods

Overview

Publicconstructor Create(AManager: TItemsManager); override;
Publicprocedure AddProperties(const Result: Props.TProperties); override;
Protectedfunction Convert(OldFormat, NewFormat: Cardinal): Boolean; override;
Publicprocedure CreateEmpty(AWidth, AHeight: Integer); virtual;
Publicprocedure GenerateMipLevels(ARect: BaseTypes.TRect);
Protectedfunction GetDataSizeInStream: Integer; override;
Publicfunction GetElementSize: Integer; override;
Protectedfunction GetLevelInfo(Index: Integer): TImageLevel;
Publicfunction Load(Stream: Basics.TStream): Boolean; override;
Publicfunction Save(Stream: Basics.TStream): Boolean; override;
Publicprocedure SetDimensions(AWidth, AHeight: Integer); virtual;
Publicprocedure SetProperties(Properties: Props.TProperties); override;

Description

Publicconstructor Create(AManager: TItemsManager); override;

 

Publicprocedure AddProperties(const Result: Props.TProperties); override;

 

Protectedfunction Convert(OldFormat, NewFormat: Cardinal): Boolean; override;

Performs image conversion from one format to another

Publicprocedure CreateEmpty(AWidth, AHeight: Integer); virtual;

Creates an empty image with the specified dimensions

Publicprocedure GenerateMipLevels(ARect: BaseTypes.TRect);

Generates mip data

Protectedfunction GetDataSizeInStream: Integer; override;

Images with generated mipmaps needs less space in storage stream

Publicfunction GetElementSize: Integer; override;

 

Protectedfunction GetLevelInfo(Index: Integer): TImageLevel;

Returns information about specified mip level

Publicfunction Load(Stream: Basics.TStream): Boolean; override;

 

Publicfunction Save(Stream: Basics.TStream): Boolean; override;

 

Publicprocedure SetDimensions(AWidth, AHeight: Integer); virtual;

Sets width and height of the image. Data should be initialized. deprecated: MinFilter/MagFilter will be used to resize.

Publicprocedure SetProperties(Properties: Props.TProperties); override;

 

Properties

Overview

Publicproperty ActualLevels: Integer;
Publicproperty Height: Integer;
Publicproperty LevelInfo[Index: Integer]: TImageLevel;
Publicproperty MagFilter: TImageResizeFilter;
Publicproperty MagFilterParameter: Single;
Publicproperty MinFilter: TImageResizeFilter;
Publicproperty MinFilterParameter: Single;
Publicproperty MipPolicy: TMipPolicy;
Publicproperty SuggestedLevels: Integer;
Publicproperty Width: Integer;

Description

Publicproperty ActualLevels: Integer;

Actual number of mip levels

Publicproperty Height: Integer;

Image height

Publicproperty LevelInfo[Index: Integer]: TImageLevel;

Mip levels information

Publicproperty MagFilter: TImageResizeFilter;

Filter used when the image size is increased. Image width have more priority than height when choosing filter.

Publicproperty MagFilterParameter: Single;

Parameter value for magnification filter

Publicproperty MinFilter: TImageResizeFilter;

Filter used when the image size is decreased and for mipmaps calculation

Publicproperty MinFilterParameter: Single;

Parameter value for minification filter

Publicproperty MipPolicy: TMipPolicy;

Mip levels policy

Publicproperty SuggestedLevels: Integer;

Suggested mip levels

Publicproperty Width: Integer;

Image width

Last modified: Jan 6, 2010
Copyright (C) 2006-2010, casteng.com