D4D BMP DRAW API Functions Specification

Collaboration diagram for D4D BMP DRAW API Functions Specification:

Functions
D4D_EXTIMG_TYPE	D4D_GetImgSrcType (D4D_BMP *pBmp)
	Function returns the type of image source. More...
void	D4D_DrawRBmpXY (D4D_COOR x, D4D_COOR y, const D4D_BMP *pBmp, D4D_BOOL greyScale, D4D_COOR radius)
	Function draw the bitmap on the specify coordination. More...
void	D4D_DrawBmpRect (D4D_POINT *ppt, D4D_SIZE *psz, const D4D_BMP *pBmp, D4D_BMP_PROPERTIES bmpProp, D4D_COLOR colorBkgd, D4D_BOOL greyScale)
	Function draw the bitmap on the specify coordination into rectangle. More...
D4D_SIZE	D4D_GetBmpSize (const D4D_BMP *pBmp)
	Function gets information about bitmap size. More...
D4D_COOR	D4D_GetBmpWidth (const D4D_BMP *pBmp)
	Function gets information about bitmap width. More...
D4D_COOR	D4D_GetBmpHeight (const D4D_BMP *pBmp)
	Function gets information about bitmap height. More...
int	D4D_GetBmpHeader (D4D_BMP *pBmp, void *pBuff, int max_size)
	Function gets image file header. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

void D4D_DrawBmpRect	(	D4D_POINT *	ppt,
		D4D_SIZE *	psz,
		const D4D_BMP *	pBmp,
		D4D_BMP_PROPERTIES	bmpProp,
		D4D_COLOR	colorBkgd,
		D4D_BOOL	greyScale
	)

Function draw the bitmap on the specify coordination into rectangle.

Parameters

ppt	- pointer on point structure of top left corner on screen to specify rectangle
psz	- pointer on the size structure that defines size of the rectangle
pBmp	- pointer on the bitmap structure
bmpProp	- bitmap properties
colorBkgd	- background color of bitmap
greyScale	- drawing in greyScale

Returns

none

Note

This function draws bitmap in specified rectangle, it can draw colors in grey scale, and with round corners. There is optin to align bitmap inside the rectangle.

Definition at line 240 of file d4d_bmp.c.

Here is the call graph for this function:

void D4D_DrawRBmpXY	(	D4D_COOR	x,
		D4D_COOR	y,
		const D4D_BMP *	pBmp,
		D4D_BOOL	greyScale,
		D4D_COOR	radius
	)

Function draw the bitmap on the specify coordination.

Parameters

x	- coordination in X axis
y	- coordination in Y axis
pBmp	- pointer on the bitmap structure
greyScale	- drawing in greyScale
radius	- round corner radius

Returns

none

Note

This function draws bitmap on specified coordination, it can draw colors in grey scale, and with round corners.

Definition at line 205 of file d4d_bmp.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int D4D_GetBmpHeader	(	D4D_BMP *	pBmp,
		void *	pBuff,
		int	max_size
	)

Function gets image file header.

Parameters

pBmp	- pointer on the bitmap structure
pBuff	- buffer in application code that is prepared to store the image header
max_size	- max_buffer size

Returns

count of byte copied to buffer

Note

Function return the image header. The size and type of image header depends on input image source typeZ.

Definition at line 515 of file d4d_bmp.c.

Here is the call graph for this function:

D4D_COOR D4D_GetBmpHeight

(

const D4D_BMP *

pBmp

)

Function gets information about bitmap height.

Parameters

pBmp	- pointer on the bitmap structure

Returns

none

Note

Function tries get the height information of bitmap handled in D4D_BMP parameter. In case that there is no chance get the height, it return height 0.

Definition at line 481 of file d4d_bmp.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_SIZE D4D_GetBmpSize

(

const D4D_BMP *

pBmp

)

Function gets information about bitmap size.

Parameters

pBmp	- pointer on the bitmap structure

Returns

none

Note

Function tries get the size information of bitmap handled in D4D_BMP parameter. In case that there is no chance get the size, it return size 0,0.

Definition at line 418 of file d4d_bmp.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COOR D4D_GetBmpWidth

(

const D4D_BMP *

pBmp

)

Function gets information about bitmap width.

Parameters

pBmp	- pointer on the bitmap structure

Returns

none

Note

Function tries get the width information of bitmap handled in D4D_BMP parameter. In case that there is no chance get the width, it return width 0.

Definition at line 450 of file d4d_bmp.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_EXTIMG_TYPE D4D_GetImgSrcType

(

D4D_BMP *

pBmp

)

Function returns the type of image source.

External Bitmap support

Parameters

pBmp	- pointer on the bitmap structure

Returns

type of image

Note

This function find out the type of the image source. In case of not supported image it returns D4D_EXTIMG_UNKNOWN.

Definition at line 143 of file d4d_bmp.c.

Here is the call graph for this function:

Here is the caller graph for this function: