mgeff-common.h File Reference

common macro and type define. More...

#include "mgeffconfig.h"

Go to the source code of this file.

Data Structures
struct	_EffPoint
	Structure defines a int point. More...
struct	_EffPointF
	Structure defines a float point. More...
struct	_EffPoint3D
	Structure defines a int 3D point. More...
struct	_EffPointF3D
	Structure defines a float 3D point. More...
struct	_EffRect
	Structure defines a rectangle. More...

Macros
#define	MGEFF_EXPORT
#define	MGEFF_TRUE   1
	type of MGEFF_TRUE
#define	MGEFF_FALSE   0
	type of MGEFF_FALSE
#define	MGEFF_DECLARE_HANDLE(name)
	type of MGEFF_DECLARE_HANDLE More...
#define	BITBLT(shdc, sx, sy, sw, sh, dhdc, dx, dy, rop)
	BITBLT macro define. More...
#define	STRETCHBLT(shdc, sx, sy, sw, sh, dhdc, dx, dy, dw, dh, rop)
	STRETCHBLT macro define. More...

Typedefs
typedef int	MGEFF_BOOL
	type of MGEFF_BOOL
typedef void *	MGEFF_HANDLE
	type of MGEFF_HANDLE More...
typedef struct _EffPoint	EffPoint
	Structure defines a int point.
typedef struct _EffPointF	EffPointF
	Structure defines a float point.
typedef struct _EffPoint3D	EffPoint3D
	Structure defines a int 3D point.
typedef struct _EffPointF3D	EffPointF3D
	Structure defines a float 3D point.
typedef struct _EffRect	EffRect
	Structure defines a rectangle.
typedef unsigned int	EffColor
	type defines a color

Functions
MGEFF_EXPORT int	mGEffInit (void)
MGEFF_EXPORT void	mGEffDeinit (void)

Detailed Description

common macro and type define.

============================================================================

Author

WanZheng

Version

1.0

Date

02/03/2010 05:22:39 PM

   This file is part of mGEff, a component for MiniGUI.

   Copyright (C) 2008~2018, Beijing FMSoft Technologies Co., Ltd.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

   Or,

   As this program is a library, any link to this program must follow
   GNU General Public License version 3 (GPLv3). If you cannot accept
   GPLv3, you need to be licensed from FMSoft.

   If you have got a commercial license of this program, please use it
   under the terms and conditions of the commercial license.

   For more information about the commercial license, please refer to
   <http://www.minigui.com/en/about/licensing-policy/>.

Macro Definition Documentation

#define BITBLT	(		shdc,
			sx,
			sy,
			sw,
			sh,
			dhdc,
			dx,
			dy,
			rop
	)

Value:

do { \
        if (0 != sw && 0 != sh) BitBlt(shdc, sx, sy, sw, sh, dhdc, dx, dy, rop); \
    } while(0)

BITBLT macro define.

#define MGEFF_DECLARE_HANDLE

(

name

)

Value:

struct _mgeff_##name##___{int unused;}; \
typedef struct _mgeff_##name##___ * name

type of MGEFF_DECLARE_HANDLE

#define MGEFF_EXPORT

define MGEFF_EXPORT to NULL

#define STRETCHBLT	(		shdc,
			sx,
			sy,
			sw,
			sh,
			dhdc,
			dx,
			dy,
			dw,
			dh,
			rop
	)

Value:

do { \
        if (0 != sw && 0 != sh && 0 != dw && 0 != dh)   \
        StretchBlt(shdc, sx, sy, sw, sh, dhdc, dx, dy, dw, dh, rop); \
    } while(0)

STRETCHBLT macro define.

Typedef Documentation

typedef void* MGEFF_HANDLE

type of MGEFF_HANDLE

MGEFF_DECLARE_HANDLE

Function Documentation

void mGEffDeinit

(

void

)

This function de-initializes the mgeff library. It will desktroy the default scheduar.

See also

mGEffInit

int mGEffInit

(

void

)

This function initializes the mgeff library. It creates the default schedular.

Returns

If succeed, return 0; otherwise return -1;

See also

mGEffDeinit