Bitmap

Data Structures
struct	GSM_BinaryPicture
struct	GSM_Bitmap
struct	GSM_MultiBitmap

Enumerations
enum	GSM_BinaryPicture_Types {   PICTURE_BMP = 1, PICTURE_GIF, PICTURE_JPG, PICTURE_ICN,   PICTURE_PNG }
enum	GSM_Bitmap_Types {   GSM_None = 1, GSM_ColourStartupLogo_ID, GSM_StartupLogo, GSM_ColourOperatorLogo_ID,   GSM_OperatorLogo, GSM_ColourWallPaper_ID, GSM_CallerGroupLogo, GSM_DealerNote_Text,   GSM_WelcomeNote_Text, GSM_PictureImage, GSM_PictureBinary }

Functions
GSM_Error	GSM_GetBitmap (GSM_StateMachine *s, GSM_Bitmap *Bitmap)
GSM_Error	GSM_SetBitmap (GSM_StateMachine *s, GSM_Bitmap *Bitmap)
void	GSM_PrintBitmap (FILE *file, GSM_Bitmap *bitmap)
GSM_Error	GSM_SaveBitmapFile (char *FileName, GSM_MultiBitmap *bitmap)
GSM_Error	GSM_ReadBitmapFile (char *FileName, GSM_MultiBitmap *bitmap)
gboolean	GSM_IsPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_SetPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_ClearPointBitmap (GSM_Bitmap *bmp, int x, int y)
void	GSM_ClearBitmap (GSM_Bitmap *bmp)
GSM_Error	GSM_GetScreenshot (GSM_StateMachine *s, GSM_BinaryPicture *picture)

Detailed Description

Bitmaps manipulations.

Enumeration Type Documentation

enum GSM_BinaryPicture_Types

Binary picture types.

Enumerator:

PICTURE_BMP
PICTURE_GIF
PICTURE_JPG
PICTURE_ICN
PICTURE_PNG

Definition at line 26 of file gammu-bitmap.h.

             {
        PICTURE_BMP = 1,
        PICTURE_GIF,
        PICTURE_JPG,
        PICTURE_ICN,
        PICTURE_PNG
} GSM_BinaryPicture_Types;

enum GSM_Bitmap_Types

Enum to handle all possible bitmaps, which are not saved in various filesystems.

Enumerator:

GSM_None
GSM_ColourStartupLogo_ID	ID of static file in filesystem displayed during startup
GSM_StartupLogo	Static mono bitmap/ID of animated mono bitmap displayed during startup
GSM_ColourOperatorLogo_ID	ID of static file in filesystem displayed instead of operator name
GSM_OperatorLogo	Mono bitmap displayed instead of operator name
GSM_ColourWallPaper_ID	ID of static file in filesystem displayed as wallpaper
GSM_CallerGroupLogo	Mono bitmap assigned to caller group
GSM_DealerNote_Text	Text displayed during startup, which can't be removed from phone menu
GSM_WelcomeNote_Text	Text displayed during startup
GSM_PictureImage	Image defined in Smart Messaging specification
GSM_PictureBinary	Binary picture (BMP, GIF, etc.)

Definition at line 50 of file gammu-bitmap.h.

             {
        GSM_None = 1,
        GSM_ColourStartupLogo_ID,
        GSM_StartupLogo,
        GSM_ColourOperatorLogo_ID,
        GSM_OperatorLogo,
        GSM_ColourWallPaper_ID,
        GSM_CallerGroupLogo,
        GSM_DealerNote_Text,
        GSM_WelcomeNote_Text,
        GSM_PictureImage,
        GSM_PictureBinary
} GSM_Bitmap_Types;

Function Documentation

void GSM_ClearBitmap

(

GSM_Bitmap *

bmp

)

Clears bitmap.

Parameters

bmp

Bitmap

void GSM_ClearPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Clears point in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.

GSM_Error GSM_GetBitmap	(	GSM_StateMachine *	s,
		GSM_Bitmap *	Bitmap
	)

Gets bitmap from phone.

GSM_Error GSM_GetScreenshot	(	GSM_StateMachine *	s,
		GSM_BinaryPicture *	picture
	)

Gets phone screenshot.

Parameters

s	State machine pointer.
picture	Structure which will hold data.

gboolean GSM_IsPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Checks whether point is set in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.

Returns

True if point is set.

void GSM_PrintBitmap	(	FILE *	file,
		GSM_Bitmap *	bitmap
	)

Prints bitmap to file descriptor.

Parameters

file	Where to print.
bitmap	Bitmap to print.

GSM_Error GSM_ReadBitmapFile	(	char *	FileName,
		GSM_MultiBitmap *	bitmap
	)

Reads bitmap from file.

Parameters

FileName	Where to load from.
bitmap	Pointer where to load bitmap.

Returns

Error code

GSM_Error GSM_SaveBitmapFile	(	char *	FileName,
		GSM_MultiBitmap *	bitmap
	)

Saves bitmap to file.

Parameters

FileName	Where to save.
bitmap	Bitmap to save.

Returns

Error code

GSM_Error GSM_SetBitmap	(	GSM_StateMachine *	s,
		GSM_Bitmap *	Bitmap
	)

Sets bitmap in phone.

void GSM_SetPointBitmap	(	GSM_Bitmap *	bmp,
		int	x,
		int	y
	)

Sets point in bitmap.

Parameters

bmp	Bitmap
x	Horizontal coordinate.
y	Vertical coordinate.