Unit AdClasses

DescriptionusesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

AdClasses.pas contains all classes and types shared between the host and the plugin.

Overview

Classes, Interfaces, Objects and Records

Name Description
record TAd2dResolution Specifies the dimensions of the display.
record TAd2dMaterial A record which represents a mesh material.
record TAd2dLightData A record that contains light source settings.
record TAd2DLibInfo A record that returns information about the current library.
record TAd2dProperty The "TAd2dProperty"-Record contains informations about the settings that are published by the dll.
record TAd2dPropertyValue "TAd2dPropertyValue" is used to send value information to the plugin dll.
Class TAd2DApplication Abstract class which represents an Andorra 2D application.
Class TAd2DTexture An class which represents a texture in Andorra's engine.
Class TAd2DMesh An abstract class which represents a mesh (a set of vertices) in Andorra's engine.
Class TAd2DBitmapTexture An abstract class which represents a bitmap texture in Andorra's engine.
Class TAd2DRenderTargetTexture An abstract class that represents a texture that can act as a render target.
Class TAd2dPixelCounter Used for counting the count of pixels that passed the Z-Buffer test.
Class TAd2dLight A class that represents a light in the current scene.

Types

TAd2dLogSeverity = (...);
TAd2dLogCallback = procedure(AModule: PChar; ASeverity: TAd2dLogSeverity; AMsg: PChar) of object;
PAd2dResolution = ˆTAd2dResolution;
PAd2dMaterial = ˆTAd2dMaterial;
TAd2dLightType = (...);
PAd2dLight = ˆTAd2dLightData;
TAd2dBlendMode = (...);
TAd2dDrawMode = (...);
TAd2dTextureFilter = (...);
TAd2dOption = (...);
TAd2dOptions = set of TAd2dOption;
TAd2dSurfaceLayer = (...);
TAd2dStencilFunction = (...);
TAd2dStencilOperation = (...);
TAd2dStencilEvent = (...);
TAd2dSurfaceLayers = set of TAd2dSurfaceLayer;
TAd2dPropertyType = (...);
PAd2dPropertyValue = ˆTAd2dPropertyValue;
TAd2dPropertyProc = procedure(const ASender: TObject; const AProp: TAd2dProperty); stdcall;
TAndorra2DLibraryInformation = procedure(var libinfo:TAd2DLibInfo); stdcall;
TAndorra2DApplicationProperties = procedure(const ASender: TObject; const AddPropertyProc: TAd2dPropertyProc); stdcall;
TAdCreateApplicationProc = function:TAd2dApplication; stdcall;

Constants

LibraryVersion = 'VER 0.4.5.003';

Description

Types

TAd2dLogSeverity = (...);

Specifies the severity of a log message.

Values
  • lsInfo: The log entry contains only some basic information.
  • lsWarning: The log entry warns of somthing, that could later be a problem.
  • lsError: An error occured, that does not prevent the program from further executing.
  • lsFatalError: An fatal error occured. The application will stop now.
TAd2dLogCallback = procedure(AModule: PChar; ASeverity: TAd2dLogSeverity; AMsg: PChar) of object;

Callback function that is used to send log entries from the plugin to the host application.

PAd2dResolution = ˆTAd2dResolution;

Pointer on TAd2dResolution

PAd2dMaterial = ˆTAd2dMaterial;

Pointer on TAd2dMaterial

TAd2dLightType = (...);

Used to set the type of a lightsource.

Values
  • altDirectional: All light rays are parallel. This type of light can for example be used to simulate sunlight.
  • altPoint: The light is emitted by a point light source with limited range.
PAd2dLight = ˆTAd2dLightData;

Pointer on TAd2dLightData.

TAd2dBlendMode = (...);

Declares, how a mesh is blended

Values
  • bmAlpha: Normal mode
  • bmAdd: Additive blending
  • bmSub: Substractive blending
  • bmMask: The mesh apears black
TAd2dDrawMode = (...);

Specifies how the vertices are drawn

Values
  • adPoints: The vertices are drawn as single points
  • adLines: The vertices are drawn as lines
  • adLineStrips: The vertices are drawn as a line strip
  • adTriangles: The vertices are drawn as a list of triangles
  • adTriangleStrips: The vertices are drawn as a triangle strip
  • adTriangleFan: The vertices are drawn as a triangle fan
  • adPointSprites: The vertices are drawn as point sprites
TAd2dTextureFilter = (...);

Specifies the way textures are filtered.

Values
  • atPoint: The filter with worst quality. The pixels won't be interpolated.
  • atLinear: The pixels will be interpolated using a linear filter.
  • atAnisotropic: The pixels will be interpolated using an anisotropic filter.
TAd2dOption = (...);

These options are used to en- or disable specific parts of the graphic system in order to have more FPS.

Values
  • aoLight: If this option is turned on, lights can be used
  • aoTextures: If this option is turned on, textures are used
  • aoBlending: If this option is turned on, the transparency effects are used
  • aoAlphaMask: If enabled, pixels with an alpha value of 0 will not be written in the Z-Buffer.
  • aoMipmaps: If this option is turned on, all textures loaded are equiped with a mipmap
  • aoZBuffer: If this option is turned on, the engine will write in the Z-Buffer
  • aoStencilBuffer: Enables the stencil buffer.
  • aoAntialias: If this option is turned on, antialias is used. Remember that this option is not available on all plugins and has to be setuped before initializing the graphic system using the "Properties" interface.
  • aoCulling: If this option is turned on, culling is enabled.
TAd2dOptions = set of TAd2dOption;

Set of TAd2dOption used in TAdRenderingSurface. See TAd2dOption for more details.

TAd2dSurfaceLayer = (...);

TAd2dSurfaceLayer is used by the TAd2dApplication.ClearSurface method. A set of TAd2dSurfaceLayer specifies, which parts of the surface should actually be cleared.

Values
  • alColorBuffer: Clears the visible color buffer.
  • alZBuffer: Clears the Z-Buffer, which holds the Z-Position of each pixel on the surface
  • alStencilBuffer: Clears the stencil buffer, that is used by some special effects
TAd2dStencilFunction = (...);

This type is used in the stencil buffer functions in order to set when a stencil buffer operation fails or not.

See also
TAd2dApplication.SetStencilOptions
Use this method to setup the stencil buffer.
TAd2dOption
These options are used to en- or disable specific parts of the graphic system in order to have more FPS.
Values
  • asfNever: The stencil buffer comparison can never be achived.
  • asfLessThan: The pixel is set if the reference value is smaller than the stencil buffer value
  • asfLessThanOrEqual: The pixel is set if the reference value is smaller or equal to the stencil value
  • asfEqual: The stencil buffer comparison passes if the stencil value is equal to the reference value
  • asfGreaterThanOrEqual: The pixel is set if the reference value is greater or equal to the stencil value
  • asfGreaterThan: The pixel is set if the reference value is greater than the stencil buffer.
  • asfAlways: The stencil buffer operation will always pass
TAd2dStencilOperation = (...);

The operation that will be performed on the stencil buffer if a stencil event is triggered.

Values
  • asoKeep: The current stencil value is kept
  • asoReplace: The stencil value is replaced by the reference value
  • asoIncrement: The current stencil value is incremented
  • asoDecrase: The current stencil value decrased
  • asoZero: The stencil value is set to zero
TAd2dStencilEvent = (...);

TAd2dStencilEvent represents the stencil states that can be triggered when the stencil test takes place.

Values
  • aseFail: Triggered if the stencil test fails
  • aseZFail: The stencil test didn't fail, but the Z-Buffer test did.
  • asePass: The stencil test and the Z-Buffer test didn't were passed
TAd2dSurfaceLayers = set of TAd2dSurfaceLayer;

A set of TAd2dSurfaceLayer, that specifies, which parts of the surface should actually be cleared.

See also
TAd2dSurfaceLayer
TAd2dSurfaceLayer is used by the TAd2dApplication.ClearSurface method.
TAd2dPropertyType = (...);

Speifies the type of the property.

See also
TAd2dProperty
The "TAd2dProperty"-Record contains informations about the settings that are published by the dll.
Values
  • ptInteger: The property is a number
  • ptBoolean: The property is a boolean
  • ptResolution: The property is a TAd2dResolution structure
  • ptReadOnly: The property is used to transfer plugin capabilities
PAd2dPropertyValue = ˆTAd2dPropertyValue;

Pointer on TAc2dPropertyValue.

TAd2dPropertyProc = procedure(const ASender: TObject; const AProp: TAd2dProperty); stdcall;

Callback procedure used to store the properties.

See also
TAd2dProperty
The "TAd2dProperty"-Record contains informations about the settings that are published by the dll.
TAndorra2DLibraryInformation = procedure(var libinfo:TAd2DLibInfo); stdcall;

Procedure used in the dll to receive information about the library.

TAndorra2DApplicationProperties = procedure(const ASender: TObject; const AddPropertyProc: TAd2dPropertyProc); stdcall;

Procedure used in the dll to receive the abilities of the library and to set properties before initialization.

TAdCreateApplicationProc = function:TAd2dApplication; stdcall;

Used to import the CreateApplication function form the DLL.

Constants

LibraryVersion = 'VER 0.4.5.003';

The current Andorra 2D version. If version between Plugin and Source is different, loading stops.

SourceForge.net Logo

Generated by PasDoc 0.11.0 on 2008-12-31 14:31:58