D4D ICON API Functions Specification

Collaboration diagram for D4D ICON API Functions Specification:

Functions
D4D_ICON_INDEX	D4D_IconGetBmpCount (D4D_OBJECT_PTR pThis)
	Function returns the icon bitmap count. More...
void	D4D_IconSetIndex (D4D_OBJECT_PTR pThis, D4D_ICON_INDEX index)
	Function sets the new bitmap of icon by icon index. More...
void	D4D_IconChangeIndex (D4D_OBJECT_PTR pThis, sByte incr)
	Function sets the new bitmap of icon by icon index difference. More...
D4D_ICON_INDEX	D4D_IconGetIndex (D4D_OBJECT_PTR pThis)
	Function returns current visible bitmap index. More...
void	D4D_IconAnimationStart (D4D_OBJECT_PTR pThis)
	Function starts the animation of icon. More...
void	D4D_IconAnimationStop (D4D_OBJECT_PTR pThis)
	Function stops the animation of icon. More...
void	D4D_IconAnimationSetCounts (D4D_OBJECT_PTR pThis, Word cnt)
	Function sets the time tick tresholds for animation speed. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

void D4D_IconAnimationSetCounts	(	D4D_OBJECT_PTR	pThis,
		Word	cnt
	)

Function sets the time tick tresholds for animation speed.

Parameters

pThis	- pointer to the icon object that should be sets.
cnt	- count of time ticks to change the bitmap

Returns

none

Note

The speed of animation is done by period of D4D 1 / (time ticks * count of treshold)

Definition at line 258 of file d4d_icon.c.

void D4D_IconAnimationStart

(

D4D_OBJECT_PTR

pThis

)

Function starts the animation of icon.

Parameters

pThis

- pointer to the icon object that should be sets.

Returns

none

Note

In fact starts periodic changes of ICON bitmap, time is specified by D4D Time Ticks and defined ticks treshold.

Definition at line 221 of file d4d_icon.c.

Here is the call graph for this function:

void D4D_IconAnimationStop

(

D4D_OBJECT_PTR

pThis

)

Function stops the animation of icon.

Parameters

pThis

- pointer to the icon object that should be sets.

Returns

none

Note

In fact stops periodic changes of ICON bitmap, time is specified by D4D Time Ticks and defined ticks treshold.

Definition at line 241 of file d4d_icon.c.

Here is the call graph for this function:

void D4D_IconChangeIndex	(	D4D_OBJECT_PTR	pThis,
		sByte	incr
	)

Function sets the new bitmap of icon by icon index difference.

Parameters

pThis	- pointer to the icon object that should be sets.
incr	- sign value for compute of new bitmap index relative to current one

Returns

none

Note

none

Definition at line 189 of file d4d_icon.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_ICON_INDEX D4D_IconGetBmpCount

(

D4D_OBJECT_PTR

pThis

)

Function returns the icon bitmap count.

Parameters

pThis

- pointer to the icon object that should be sets.

Returns

count of icon bitmaps

Note

none

Definition at line 136 of file d4d_icon.c.

Here is the caller graph for this function:

D4D_ICON_INDEX D4D_IconGetIndex

(

D4D_OBJECT_PTR

pThis

)

Function returns current visible bitmap index.

Parameters

pThis

- pointer to the icon object that should be sets.

Returns

index of current visible index

Note

none

Definition at line 206 of file d4d_icon.c.

void D4D_IconSetIndex	(	D4D_OBJECT_PTR	pThis,
		D4D_ICON_INDEX	index
	)

Function sets the new bitmap of icon by icon index.

Parameters

pThis	- pointer to the icon object that should be sets.
index	- index of new bitmpa that should be shown

Returns

none

Note

none

Definition at line 157 of file d4d_icon.c.

Here is the call graph for this function:

Here is the caller graph for this function: