D4D SCHEME API Functions Specification

Collaboration diagram for D4D SCHEME API Functions Specification:

Functions
D4D_CLR_SCHEME *	D4D_ObjectGetScheme (D4D_OBJECT *pObj)
	Function return the pointer to current use object scheme of object. More...
D4D_CLR_SCHEME *	D4D_GetDefaultScheme (void)
	Function return the pointer to default color scheme. More...
void	D4D_SetDefaultScheme (D4D_CLR_SCHEME *pScheme)
	Function sets the new default color scheme. More...
D4D_COLOR	D4D_ObjectGetForeColor (D4D_OBJECT *pObj, D4D_OBJECT_DRAWFLAGS draw)
	Function return object current fore color. More...
D4D_COLOR	D4D_ObjectGetBckgColor (D4D_OBJECT *pObj, D4D_OBJECT_DRAWFLAGS draw)
	Function return object current background color. More...
D4D_COLOR	D4D_ObjectGetForeFillColor (D4D_OBJECT *pObj)
	Function return object current fill fore color. More...
D4D_COLOR	D4D_ObjectGetBckgFillColor (D4D_OBJECT *pObj)
	Function return object current fill background color. More...
D4D_COLOR	D4D_GetCrossColor (D4D_COLOR startColor, D4D_COLOR endColor, Byte value)
	Compute cross color between two basic color in 256 steps. More...
D4D_COLOR	D4D_ChangeColorIntesity (D4D_COLOR color, sByte intensity)
	Compute change of color intesity. More...
D4D_COLOR	D4D_GetGreyScale (D4D_COLOR color)
	Compute the grayscale color. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

D4D_COLOR D4D_ChangeColorIntesity	(	D4D_COLOR	color,
		sByte	intensity
	)

Compute change of color intesity.

Parameters

color	- input color to change intesity
intensity	- change of intesity - signed <-100 .. 100>

Returns

New color computed from input color and intensity change.

Note

Function compute by simple proportion the color with changed intesity in +-100% scale.

Definition at line 286 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COLOR D4D_GetCrossColor	(	D4D_COLOR	startColor,
		D4D_COLOR	endColor,
		Byte	value
	)

Compute cross color between two basic color in 256 steps.

Parameters

startColor	- starting color for computing cross color
endColor	- ending color for computing cross color
value	- crossing value <0-255>

Returns

Crrossing color between begin and end color handled in parameters by handled step(value).

Note

Function compute by simple proportion the cross color between two colors by handled step.

Definition at line 243 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_CLR_SCHEME* D4D_GetDefaultScheme

(

void

)

Function return the pointer to default color scheme.

Returns

pointer to screen current use of color scheme

Note

This function just return current used default color scheme pointer

Definition at line 133 of file d4d_scheme.c.

D4D_COLOR D4D_GetGreyScale

(

D4D_COLOR

color

)

Compute the grayscale color.

Parameters

color

- input color to change to grey scale

Returns

New grey scale color computed from input color

Note

Function compute the grey scale color from input color.

Definition at line 333 of file d4d_scheme.c.

Here is the caller graph for this function:

D4D_COLOR D4D_ObjectGetBckgColor	(	D4D_OBJECT *	pObj,
		D4D_OBJECT_DRAWFLAGS	draw
	)

Function return object current background color.

Parameters

pObj	- pointer to object
draw	- draw runtime flags handled to object by D4D_MSG_ONDRAW

Returns

Current used background color of object.

Note

Function by object flags and also draw parameter return one of object color from color scheme - normal/disable/focus/capture colors.

Definition at line 185 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COLOR D4D_ObjectGetBckgFillColor

(

D4D_OBJECT *

pObj

)

Function return object current fill background color.

Parameters

pObj	- pointer to object

Returns

Current used fill background color of object.

Note

Function by object flags return one of object color from color scheme - normal/disable colors.

Definition at line 225 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COLOR D4D_ObjectGetForeColor	(	D4D_OBJECT *	pObj,
		D4D_OBJECT_DRAWFLAGS	draw
	)

Function return object current fore color.

Parameters

pObj	- pointer to object
draw	- draw runtime flags handled to object by D4D_MSG_ONDRAW

Returns

Current used fore color of object.

Note

Function by object flags and also draw parameter return one of object color from color scheme - normal/disable/focus/capture colors.

Definition at line 161 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COLOR D4D_ObjectGetForeFillColor

(

D4D_OBJECT *

pObj

)

Function return object current fill fore color.

Parameters

pObj	- pointer to object

Returns

Current used fill fore color of object.

Note

Function by object flags return one of object color from color scheme - normal/disable colors.

Definition at line 208 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_CLR_SCHEME* D4D_ObjectGetScheme

(

D4D_OBJECT *

pObj

)

Function return the pointer to current use object scheme of object.

Parameters

pObj	- pointer to object

Returns

pointer to object current use of color scheme

Note

This function find out the current use object scheme of object. It handles with standard default scheme, screen color scheme and also directly with user object color scheme.

Definition at line 109 of file d4d_scheme.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_SetDefaultScheme

(

D4D_CLR_SCHEME *

pScheme

)

Function sets the new default color scheme.

Parameters

pScheme

- pointer to object

Returns

none

Note

This function sets the new default color scheme. If by parameter is handled NULL, then it's used default color scheme defined in d4d_usrcfg.h file.

Definition at line 145 of file d4d_scheme.c.