APPENDIX 6 – X-Pert Graphics specific Class Properties, Functions, and Procedures Explained

 

TTBObject (inheritor of TObject)

TTBObject Property/Procedure/Function

Description

Objects That Use It

function Create(const ObjName: String): Constructor

Links to an existing object in the project

All

function CreateNew(const ObjType, ObjName: String): Constructor

Creates a new object in the project and links to it

All

procedure Free

Frees a TTBobject variable

All

procedure Delete

Deletes currently selected object and sets it free

All

procedure Play

Runs currently selected object

All

procedure Stop(AutoStop: Boolean = False)

Stops currently selected object

All

procedure Pause

Pauses object’s execution

All

procedure Toggle

Switches object’s status from Play to Stop and vice versa

All

procedure UpdateParams

Updates the text when formatting properties are changed through the script

Text, Roll, Crawl, Chat objects

function MoveToSlide(const SlideName: String): Boolean

Moves the object to an existing slide

All

procedure Move(IncX, IncY: Integer; Frames: Integer = 0)

Moves the selected object by <IncX> and <IncY> in the respective directions.

<IncX> and <IncY> may be positive or negative values. The movement is relative to object’s current position.

Optionally a number of frames may be specified to define the duration of the change.

All

procedure MoveTo(PosX, PosY: Integer; Frames: Integer = 0)

Same as procedure Move command except that <PosX> and <PosY> define the new position as absolute values.

All

procedure SizeTo(Width, Height: Integer; Frames: Integer = 0)

Sets object’s size according to the specified values.

If some of the values are 0, the respective property of the object is not changed.

All

procedure Rect(Left, Top, Right, Bottom: Integer)

Sets object’s position and size with one command

All

procedure RectТо(Left, Top, Width, Height: Integer; Frames: Integer = 0)

Defines a new position of the object as absolute values and sets the object’s size according to the specified values. If some of the values are 0, the respective property of the object is not changed.

All

procedure TopOne

Moves the currently selected object with 1 layer to top (Z-order)

All

procedure BackOne

Moves the currently selected object with 1 layer to bottom

All

procedure ToTop

Moves the currently selected object to top

All

procedure ToBack

Moves the currently selected object to bottom

All

procedure Loop(Start: Integer; Stop: Integer = -1)

Defines the number of loops to run. If you set ‘0’ the object will be looped endlessly.

Roll, Crawl, Animation File, Animation Sequence, Banner, Sound, Digital Clock objects

procedure TextAssign(RichEdit: TRichEdit)

Assigns an object of type TRichEdit, i.e., places its text with its formatting in the object at matter

Text, Roll, Crawl, Chat objects

procedure TextSelect(StartPos: Integer = -1; EndPos: Integer = -1)

Use this command to change the parameters of a part of the text. Selects part of the text starting at [StartPos] and ending at [EndPos], where the first letter of the text is indexed with ‘1’. Use a ‘-1’ value for selecting the text from the beginning, until the end, or both, as follows:

If [StartPos] = -1 and [EndPos] has a positive integer value, the text will be selected from the beginning to the letter with index, equal to the [EndPos] value.

If [StartPos] has a positive integer value and [EndPos] = -1, the text will be selected from the letter with index, equal to the [StartPos] value until the end

If [StartPos] = -1 and [EndPos] = -1 the whole text will be selected

Text, Roll, Crawl, Chat objects

property AutoWrap: Boolean

Enables / Disables the auto wrapping of the selected text

Text, Roll, Crawl, Chat objects

property FontSize: Integer

Sets the font size for the selected text.

Text, Roll, Crawl, Chat objects

property FontName: String

Sets the font for the selected text.

Text, Roll, Crawl, Chat objects

property FontShadowSize: Integer

Sets the font shadow size to the selected text.

Text, Roll, Crawl, Chat objects

property FontStyle: TFontStyles

Sets a variable of type TFontStyle with value fsBold, fsItalic, fsStrikeout, or fsUnderline to the selected text.

Text, Roll, Crawl, Chat objects

property FontShadowAngle: Integer

Sets the font shadow angle to the selected text.

Text, Roll, Crawl, Chat objects

property FontShadowOffset: Integer

Sets the font shadow offset to the selected text.

Text, Roll, Crawl, Chat objects

property FontShadowColor: Integer

Sets the font shadow color to the selected text.

Text, Roll, Crawl, Chat objects

property FontEdgeSize: Integer

Sets the font edge size to the selected text.

Text, Roll, Crawl, Chat objects

property FontEdgeColor: Integer

Sets the font edge color to the selected text.

Text, Roll, Crawl, Chat objects

property FontLineSpace: Integer

Sets the line space of the font to the selected text.

Text, Roll, Crawl, Chat objects

property FontColor: Integer

Sets the font color to the selected text.

Text, Roll, Crawl, Chat objects

property FontJustify: Integer

Justifies the font horizontally in accordance to the following values:

‘0’ for Center

‘1’ for Left

‘2’ for Right

Text, Roll, Crawl, Chat objects

property FontAlignment: Integer

Vertically aligns the font in accordance to the following values:

‘0’ for Bottom

‘1’ for Center

‘2’ for Right

Text, Roll, Crawl, Chat objects

property FontUseFill: Boolean

Disables / Enables fill of the text

Text, Roll, Crawl, Chat objects

property FontUseOutline: Boolean

Disables / Enables outline of the text

Text, Roll, Crawl, Chat objects

property FontUseShadow: Boolean

Disables / Enables shadow of the text

Text, Roll, Crawl, Chat objects

property Name: String

Sets or gets the name of the object

All

property Text: String

Sets or gets text data of the selected object. ANSI, UTF8 and RTF are supported.

Text, Roll, Crawl, Chat objects

property ObjectType: String

Returns the type of an object

All

property State: TObjectState

Returns the property state: autostop, pause, play, or stop

All

property Color: Integer

Sets or gets the color of the object

All

property Tag: Integer

Sets or gets the tag number of the object

All

property Top: Integer

Sets or gets the Y coordinate of an object in terms of pixels

All

property Left: Integer

Sets or gets the X coordinate of an object in terms of pixels

All

property Width: Integer

Sets or gets the width of an object in pixels

All

property Height: Integer

Sets or gets the height of an object in pixels

All

property Delay: Extended

Sets or gets a delay play time for an object in seconds

All

property Speed: Extended

Sets or gets the speed of an object. If you set a speed of ‘0’ the object will not move. If you set a negative speed value you will reverse the movement of the object.

Rolls, Crawls, Animation Files, Animation Sequences, Mesh Files, Chat Notes/Lines/Rolls

property Link: String

Links the specified file to a TEXT or GRAPHICS object. The file’s content is used as a data source for the object.

Text, Roll, Crawl objects

property LinkAutoPlay: Boolean

Disables / Enables Auto play of the object linked to a file whenever the data in the file changes.

Text, Roll, Crawl objects

property ScrollStyle: TScrollDrawStyle

Defines the scroll style of the object by setting a TScrollDrawStyle variable to it, which can have the following values:

[ssColorBlank] – the background of the current text will remain until the text disappears from the screen. The new text’s background will appear as soon as the text is displayed.

[ssEmpty] – there will be background only under the displayed text. As soon as the text ends, the background will disappear

[ssSigned] – no space between the backgrounds of two successive texts

Rolls, Crawls, Animation Files, Animation Sequences, Mesh Files, Chat objects

procedure ClockPrepare

Sets the initial clock time and waits for start command.

Digital Clock Objects

procedure ClockStart

Starts the clock.

Digital Clock Objects

procedure ClockStop

Stops the clock.

Digital Clock Objects

property ClockIntermediate: Boolean

Disables / Enables clock freeze.

Digital Clock Objects

Property ClockVisible: Boolean

Shows / hides a clock object

Analogue/Digital Clock Objects

property ClockCountdown: Boolean

Valid only in counter mode.

When enabled the counter counts down.

If disabled, the counter counts up.

Digital Clock Objects

property ClockStyle: Boolean

Defines the mode of operation for the Clock object.

If True – object is in Clock mode and runs as an ordinary digital clock

If False – object is in Counter mode counts from initial to stop time if the option ClockUseStopTime is on.

Digital Clock Objects

property ClockOffset: Extended

Used to create clocks for different time zones.

Specifies a time offset related to the current time. The format is:

<hh:mm:ss>

Analogue/Digital Clock Objects

property ClockInitTime: Extended

Sets the clock initial time in format <hh:mm:ss>

Digital Clock Objects

property ClockStopTime: Extended

Sets the clock stop time in format <hh:mm:ss>

Digital Clock Objects

property ClockUseStopTime: Boolean

Disables / Enables the use of the clock stop time.

Digital Clock Objects

property ClockMask: String

Sets a mask for the format the time will be displayed in. The following options are available: HH:MM, HH:MM:SS, HH:MM:SS:MS, HH:MM:SS:FR, MM:SS, or SS

Digital Clock Objects

procedure InEffect(Effect: TEffectType; Duration: Extended = 1.0; Motion: Integer = 0; FullScreen: Boolean = True)

Sets an IN effect for the selected object

All

procedure OutEffect(Effect: TEffectType; Duration: Extended = 1.0; Motion: Integer = 0; FullScreen: Boolean = True)

Sets an OUT effect for the selected object

All

procedure LoadImage(const FileName: String)

Loads the specified file in the selected object

Text, Picture Objects

procedureImageAssign(Bmp32: TBitmap32)

Assigns an already defined TBitmap32 image to an object

Text, Picture Objects

property ImageStyle: TStretchDrawStyle

Defines image display style from the following options:

‘1’ for Stretch

‘2’ for Tile

‘3’ for Center

Text, Picture Objects

property ImageAlpha: Integer

Defines image transparency 0 to 255, where 00 is full transparency, and 255 is solid color

Text, Picture Objects

property ImageFlip: Boolean

Disables / Enables image flip

Text, Picture Objects

procedure LoadMedia(const FileName: String)

Loads the specified media file in the selected object.

DirectShow Media Source Objects

property MediaPosX: Integer

Defines the X position of the video in the selected object

DirectShow Media Source Objects

property MediaPosY: Integer

Defines the Y position of the video in the selected object

DirectShow Media Source Objects

property MediaAlpha: Integer

Defines the transparency for the selected object from 0 to 255, where 00 is full transparency, and 255 is solid color

DirectShow Media Source Objects

property MediaStyle: Integer

Sets a style to the Media object from two options:

‘0’ for Stretch

‘1’ for Center

DirectShow Media Source Objects

property MediaColor: Integer

Defines the background color in case the object is in <Center> mode and media does not fit in the object (there is some empty space left).

DirectShow Media Source Objects

property MediaQuality: Integer

Sets video quality from the following options (note that ‘1’ is the recommended value):

‘0’for Pure

‘1’ for Low quality

‘2’for Medium quality

‘3’ for High quality

‘4’for Highest quality

DirectShow Media Source Objects

property MediaUseOwnAlpha: Boolean

Disables/ Enables the use of own ALPHA

DirectShow Media Source Objects

property MediaUseAlpha: Boolean

Disables / Enables the use of ALPHA

DirectShow Media Source Objects

property MediaKeepAspect: Boolean

Disables / Enables the <Keep aspect> option

DirectShow Media Source Objects

property MediaAudioVolume: Integer

Sets the volume for the media in decibels from 0 to 10,000, where 0 is the highest volume, and 10,000 is mute

DirectShow Media Source Objects

property MediaAudioDelay: Integer

Sets the delay value for the audio related to the video in milliseconds. This command is used to synchronize the audio with the video in the DXMedia object.

DirectShow Media Source Objects

procedure Event(EventNo: Integer)

Triggers user defined event specified by its number.

All

property OnPlay: String

Sets or gets a user defined task to an object to be executed on Play

All

property OnStop: String

Sets or gets a user defined task to an object to be executed on Stop

All

property OnPause: String

Sets or gets a user defined task to an object to be executed on Pause

All

property OnAutoStop: String

Sets or gets a user defined task to an object to be executed on AutoStop

All

property OnLoop: String

Sets or gets a user defined task to an object to be executed on Loop

All

property OnEndInputTransition: String

Sets or gets a user defined task to an object to be executed on End Input Transition

All

property OnStartOutputTransition: String

Sets or gets a user defined task to an object to be executed on Start Output Transition

All

property OnDataReady: String

Sets or gets a user defined task to an object to be executed on Data Ready

All

property OnPropertychange: String

Sets or gets a user defined task to an object to be executed on Property Change

All

property OnTransform: String

Sets or gets a user defined task to an object to be executed on Transform

All

 

TTBSlide

TTBSlide Property/Procedure/Function

Description

Used By

function Create(const Name: String): TTBSlide: Constructor

Links to an existing slide in the project

Slides

function CreateNew(const Name: String): TTBSlide: Constructor

Creates a new slide in the project

Slides

procedure Free

Frees a TTBSlide object

Slides

procedure Delete

Removes currently selected slide and sets it free. All objects from the slide are moved to the Unassigned Slide.

Slides

procedure ObjectList(List: TStrings)

Get the list of all objects currently contained in the Slide

Slides

procedure Play

Plays the specified slide (Jump to)

Slides

procedure Stop

Stops the specified slide

Slides

property Index: Integer

Sets or gets the index number of a slide

Slides

property Name: String

Sets or gets the name of a slide

Slides

property BackColor: Integer

Sets or gets the background color of a slide

Slides

property Duration: Extended

Sets or gets the duration of a slide in seconds

Slides

property Enabled: Boolean

Disables / Enables a slide

Slides

property Lock: Boolean

Locks / Unlocks a slide

Slides

property PlayMode: TPlayMode

Sets or gets a property of type TPlayMode to a slide, which can have the following values: pmAdd,pmClear,pmCrossPlay, pmStopAll, and pmStopPrevious

Slides

property State: TObjectState

Gets a property of type TObjectState, which can have the following values: osAutoStop,osPause,osPlay, and osStop

Slides

 

 

TTBSlidesManager

TTBSlidesManager Property/Procedure/Function

Description

Used By

procedure SlidesList(List: TStrings)

Lists the names of all slides in a variable of type TStrings

Slides Manager

function Count: Integer

Returns the number of the slides in Slides Manager

Slides Manager

procedure Play

Plays the slideshow

Slides Manager

procedure Stop

Stops the slideshow

Slides Manager

procedure Pause

Pauses the slideshow

Slides Manager

procedure Reset

Initializes all buffers used by the slideshow

Slides Manager

procedure Prev

Plays the previous slide in the Slides Manager

Slides Manager

procedure Next

Plays the next slide in the Slides Manager

Slides Manager

procedure Delete(Index: Integer)

Removes the slide, designated by index number from the Slides Manager. All objects from the slide are moved to the Unassigned Slide.

Slides Manager

procedure Move(OldIndex, NewIndex: Integer)

Moves the currently selected slide to a new position by shifting the indexes of the other slides from the Slides Manager.

Slides Manager

index property Slide(p0: String): Integer

Returns the index number of a Slide, distinguished by its name

Slides Manager

index property Items(p0: Integer): String

Returns the name of an item (Slide), distinguished by its index number

Slides Manager

 

TTBDataProvider

TTBDataProvider Property/Procedure/Function

Description

Used By

function Create(const Name: String): TTBDataProvider: Constructor

Links an object to a configured Data Provider

Data Providers

procedure Free

Frees a Data Provider

Data Providers

procedure Delete

Removes the Data Provider and sets it free

Data Providers

procedure ObjectsList(List: TStrings)

Lists the names of all objects, linked to a given Data Provider in a variable of type TStrings

Data Providers

procedure Play

Plays all objects, linked to a Data Provider

Data Providers

procedure Stop

Stops all objects, linked to a Data Provider

Data Providers

procedure CursorStart

Starts the cursor in a Data Provider

Data Providers

procedure CursorStop

Stops the cursor in a Data Provider

Data Providers

procedure Top

Moves the cursor to the top line in the Data Provider

Data Providers

procedure Bottom

Moves the cursor to the bottom line in the Data Provider

Data Providers

procedure Prev

Moves the cursor to the previous line in the Data Provider

Data Providers

procedure Next

Moves the cursor to the next line in the Data Provider

Data Providers

procedure Scroll(Lines: Integer = 1)

Moves the cursor with a given number of lines forward.

Data Providers

procedure Update

Refreshes the information, sent from the Data Provider

Data Providers

procedure ColumnsList(List: TStrings)

Lists the names of the columns from the Data Provider to a variable of type TStrings

Data Providers

function LinkObject(Obj: TTBObject; DataColumn: String; Offset: Integer = 0; UseEffects: Boolean = False): Boolean

Sets the properties of a link between an object and a Data Provider as in the Object Link Properties Dialog

Data Providers

procedure DeleteObjectLink(Obj: TTBObject)

Removes a link between a Data Provider and an object

Data Providers

function GetValue(Col, Row: Integer; var Data: Variant; var DataType: TDPDataType): Boolean

Gets the value of a particular entry in a Data Provider, designated by its row and column number

Data Providers

function GetColumn(Col: Integer; var DataType: TDPDataType): Variant

Gets the whole column from a Data Provider

Data Providers

property Distributor: TTBDataDistributor

Sets a Data Distributor to a Data Provider

Data Providers

property Name: String

Sets the name of a Data Distributor

Data Providers

property State: TObjectState

Sets a variable of type TObjectState, which can have the following values: osAutoStop, osPause ,osPlay, and osStop

Data Providers

property ColCount: Integer

Sets the number of columns in a particular Data Provider to an integer variable

Data Providers

property RowCount: Integer

Sets the number of rows in a particular Data Provider to an integer variable

Data Providers

index property Columns(p0: Integer): String

Sets the name of a column, distinguished by its number, to a string variable

Data Providers

 

TTBDataDistributor

TTBDataDistributor Property/Procedure/Function

Description

Used By

property Update: Integer

Sets how often to update the source information from a Data Provider in seconds. If you enter ‘0’, the updating will be Automatic

Data Distributors

property Scroll: Integer

Sets the time in seconds, by which to scroll the cursor in the Data Provider. If you enter ‘0’ the scrolling will be Manual

Data Distributors

property ScrollBy: Integer

Sets the number of rows, by which the cursor scrolls within a Data Provider

Data Distributors

property ResetOnDatasetChange: Boolean

Disables / Enables the Reset On Dataset Change property for the scroll options of the Data Distributor

Data Distributors

property ResetOnFieldChange: Boolean

Disables / Enables the Reset On Field Change property for the scroll options of the Data Distributor

Data Distributors

property StartCursorOnPlay: Boolean

Disables / Enables the Start Cursor On Play property for the scroll options of the Data Distributor

Data Distributors

property NextSlideOnBottom: Boolean

Disables / Enables the Next Slide On Bottom property for the scroll options of the Data Distributor

Data Distributors

property StopObjectsOnBottom: Boolean

Disables / Enables the Stop Objects On Bottom property for the scroll options of the Data Distributor

Data Distributors

property StopObjectsOnAnyStop: Boolean

Disables / Enables the Stop Objects On Any Stops property for the scroll options of the Data Distributor

Data Distributors

property StartObjectsOnAnyPlay: Boolean

Disables / Enables the Start Objects On Any Play property for the scroll options of the Data Distributor

Data Distributors

property StartObjectsOnUpdate: Boolean

Disables / Enables the Start Objects On Update property for the scroll options of the Data Distributor

Data Distributors

 

TTBProject

TTBProject Property/Procedure/Function

Description

Used By

procedure New

Opens a new project

Projects

procedure Start

Starts the project

Projects

procedure Stop

Stops the project

Projects

procedure Clear

Clears the project

Projects

procedure Close

Closes X-Pert Graphics

Projects

function Load(const TemplateName: String): Boolean

Loads a project in X-Pert Graphics

Projects

function Merge(const TemplateName: String): Boolean

Merges a new project to the existing one

Projects

procedure SaveAs(const TemplateName: String)

Saves a project under a given name

Projects

procedure NetStart

Switches to Net Control mode of operation

Projects

procedure NetStop

Switches off Net Control mode of operation

Projects

procedure StopAll

Stops all objects in the project

Projects

procedure MoveAll(IncX, IncY: Integer; ExcludeList: String = “)

Moves all objects in the project. The ExcludeList variable is optional. If you enter a value for it, the objects, listed there will not be moved.

Projects

procedure ObjectsList(List: TStrings)

Gets the list of all objects currently loaded in X-Pert Graphics.

Projects

procedure TagsList(Tag: Integer; List: TStrings)

Gets the list of all objects with a given tag. If you enter a negative value, a list of all existing tags will be returned.

Projects

procedure TasksList(List: TStrings)

Gets the list of all tasks currently set in X-Pert Graphics.

Projects

procedure DataProvidersList(List: TStrings)

Gets the list of all Data Providers currently set in X-Pert Graphics.

Projects

property State: TObjectState

Gets a variable of type TObjectState, which can have the following values: osPlay, and osStop

Projects

property StateStr: String

Gets the current state of the project in a string variable

Projects

property Modified: Boolean

Returns a true / false value, designating if the project has been modified since the last time it has been saved or opened

Projects

property AspectRatio: Extended

Gets the Aspect Ratio, in which the project is set

Projects

property ResolutionX: Integer

Gets the X resolution, in which the project is set

Projects

property ResolutionY: Integer

Gets the Y resolution, in which the project is set

Projects

property Version: String

Gets the last X-Pert Graphics version, in which the project has been saved

Projects

 

X-Pert Graphics Functions

Function

Description

Execute(const CommandScript: String)

Executes a script, written for the Command Script

LoadScript(const FileName: String): Boolean

Loads any script, written for X-Pert Graphics. If you use the name of an existing script, it will be overwritten by the new script

SetScript(const Name, Script: String)

Saves a script with a given name. If you use the name of an existing script, it will be overwritten by the new script

RunTask(const Task: String)

Runs a task, saved in the Task Manager, designated by its name

TBVersion: String

Returns the version number of the currently opened X-Pert Graphics

Pause(Objects: array of String)

Pauses an array of objects, designated by their names

PauseList(List: TStrings)

Pauses a list of objects

Play(Objects: array of String)

Plays an array of objects, designated by their names

PlayList(List: TStrings)

Plays a list of objects

Stop(Objects: array of String)

Stops an array of objects, designated by their names

StopList(List: TStrings)

Stops a list of objects

Toggle(Objects: array of String)

Toggles an array of objects, designated by their names

ToggleList(List: TStrings)

Toggles a list of objects

 

 

TBitmap32 (inheritor of TObject)

TBitmap32 Property/Procedure/Function

Description

function Create: Constructor

Creates a TBitmap32 item

procedure Free

Frees a TBitmap32 item

function ClassName: String

Returns the class name of an item in a String variable

procedure Assign(Bmp32: TBitmap32)

Assigns a Bmp32 object to a TBitmap32 item

procedure AssignFrom(Bmp: TBitmap; Flip: Boolean = True)

Assigns a Bmp32 object to the current TBitmap32 item. The image can be flipped.

procedure AssignTo(Bmp: TBitmap; Flip: Boolean = True)

Assigns the current TBitmap32 item to another Bmp32 object. The image can be flipped.

procedure Draw(X, Y: Integer; Bmp32: TBitmap32; Mix: Boolean = False; Flip: Boolean = False)

Draws a TBitmap32 item in given X and Y coordinates. The image can be flipped. It can also be mixed with the current image if it has a defined alpha value.

procedure DrawFrom(X, Y: Integer; Bmp: TBitmap; Flip: Boolean = False)

Copies a Bmp32 object in the current item in given X and Y coordinates. The image can be flipped.

procedure DrawTo(X, Y: Integer; Bmp: TBitmap; Mix: Boolean = False; Flip: Boolean = False)

Copies the current item in given X and Y coordinates to another Bmp32 object. The image can be flipped. It can also be mixed with the current image if it has a defined alpha value.

procedure Fill(Color:TRGBA)

Fills a TBitmap32 item with a given color

procedure FillRect(Left, Top, Right, Bottom: Integer; Color: TRGBA; Mix: Boolean = False)

Creates a Rectangle by giving it coordinates and fills it with a given color. The rectangle can be mixed with the current image if it has an alpha value.

procedure LoadFromFile(const FileName: String)

Loads a TBitmap32 item from a file

procedure LoadFromStream(const S: TStream)

Loads a TBitmap32 item from a stream

procedure SaveToFile(const FileName: String)

Saves a TBitmap32 item to a file

procedure SaveToStream(const S: TStream)

Saves a TBitmap32 item to a stream

procedure SetSize(Width, Height: Integer; PixelFormat: TPixelFormat = pf32bit)

Sets width, height, and pixel format, defined by a TPixelFormat class, to a TBitmap32 item

procedure SetTransparent(Color: TRGBA; Alpha, NoAlpha: Integer)

Searches in an object for a color by its RGB value and sets an alpha value to it in [Alpha], as well as an alpha value for the remaining part of the object, i.e., the one that does not contain the searched color, in [NoAlpha]

property Alpha: Integer

Defines image transparency 0 to 255, where 00 is full transparency, and 255 is solid color

property Canvas: TCanvas

Return the canvas object of class TCanvas for a TBitmap32 item

property Force32bit: Boolean

Formats an image to 32-bit

property Height: Integer

Gets/ sets the height of a TBitmap32 item

property Pixel(p0: Integer; p1: Integer): TRGBA

Gets / sets the pixel value at coordinates X, Y

property PixelFormat: TPixelFormat

Sets a pixel format, defined by a TPixelFormat class to a TBitmap32 item

property Pixels: Variant

Returns the address of the pixel buffer

property ScanLine(p0: Integer): Pointer

Returns the address for the first pixel in Line

property Size: Integer

Returns the pixel size of a TBitmap32 item

property Width: Integer

Gets / Sets the width of a TBitmap32 item

 

TBitmap32 (inheritor of TObject)

TBitmap32 Property/Procedure/Function

Description

function Create: Constructor

Creates a TBitmap32 item

procedure Free

Frees a TBitmap32 item

function ClassName: String

Returns the class name of an item in a String variable

procedure Assign(Bmp32: TBitmap32)

Assigns a Bmp32 object to a TBitmap32 item

procedure AssignFrom(Bmp: TBitmap; Flip: Boolean = True)

Assigns a Bmp32 object to the current TBitmap32 item. The image can be flipped.

procedure AssignTo(Bmp: TBitmap; Flip: Boolean = True)

Assigns the current TBitmap32 item to another Bmp32 object. The image can be flipped.

procedure Draw(X, Y: Integer; Bmp32: TBitmap32; Mix: Boolean = False; Flip: Boolean = False)

Draws a TBitmap32 item in given X and Y coordinates. The image can be flipped. It can also be mixed with the current image if it has a defined alpha value.

procedure DrawFrom(X, Y: Integer; Bmp: TBitmap; Flip: Boolean = False)

Copies a Bmp32 object in the current item in given X and Y coordinates. The image can be flipped.

procedure DrawTo(X, Y: Integer; Bmp: TBitmap; Mix: Boolean = False; Flip: Boolean = False)

Copies the current item in given X and Y coordinates to another Bmp32 object. The image can be flipped. It can also be mixed with the current image if it has a defined alpha value.

procedure Fill(Color:TRGBA)

Fills a TBitmap32 item with a given color

procedure FillRect(Left, Top, Right, Bottom: Integer; Color: TRGBA; Mix: Boolean = False)

Creates a Rectangle by giving it coordinates and fills it with a given color. The rectangle can be mixed with the current image if it has an alpha value.

procedure LoadFromFile(const FileName: String)

Loads a TBitmap32 item from a file

procedure LoadFromStream(const S: TStream)

Loads a TBitmap32 item from a stream

procedure SaveToFile(const FileName: String)

Saves a TBitmap32 item to a file

procedure SaveToStream(const S: TStream)

Saves a TBitmap32 item to a stream

procedure SetSize(Width, Height: Integer; PixelFormat: TPixelFormat = pf32bit)

Sets width, height, and pixel format, defined by a TPixelFormat class, to a TBitmap32 item

procedure SetTransparent(Color: TRGBA; Alpha, NoAlpha: Integer)

Searches in an object for a color by its RGB value and sets an alpha value to it in [Alpha], as well as an alpha value for the remaining part of the object, i.e., the one that does not contain the searched color, in [NoAlpha]

property Alpha: Integer

Defines image transparency 0 to 255, where 00 is full transparency, and 255 is solid color

property Canvas: TCanvas

Return the canvas object of class TCanvas for a TBitmap32 item

property Force32bit: Boolean

Formats an image to 32-bit

property Height: Integer

Gets/ sets the height of a TBitmap32 item

property Pixel(p0: Integer; p1: Integer): TRGBA

Gets / sets the pixel value at coordinates X, Y

property PixelFormat: TPixelFormat

Sets a pixel format, defined by a TPixelFormat class to a TBitmap32 item

property Pixels: Variant

Returns the address of the pixel buffer

property ScanLine(p0: Integer): Pointer

Returns the address for the first pixel in Line

property Size: Integer

Returns the pixel size of a TBitmap32 item

property Width: Integer

Gets / Sets the width of a TBitmap32 item

 

TTBStorage

TTBStorage Property/Procedure/Function

Description

procedure Clear

Clears the TTBStorage class, i.e., removes all variables saved in it

function Count: Integer

Returns the number of variables saved TTBStorage

index property Items(p0: Integer): Variant

Gets / sets an item in TTBStorage, distinguished by its index

 

For a detailed description of all other classes, supported by the X-Pert Graphics Program Script Engine, please, visit:

http://docwiki.embarcadero.com/VCL/en/Classes

http://docwiki.embarcadero.com/VCL/en/Controls

http://docwiki.embarcadero.com/VCL/en/Graphics