D4D EXTERNAL RESOURCE API Macro's Specification

Collaboration diagram for D4D EXTERNAL RESOURCE API Macro's Specification:

Macros
#define	D4D_DECLARE_LOCALE_FUNCTIONS(D4DLOCALE_TranslateStr, D4DLOCALE_GetTranslateStrLength)
	Macro that define the external custom strings functionality. More...
#define	D4D_DECLARE_FILE_FUNCTIONS(D4DFILE_fopen, D4DFILE_fclose, D4DFILE_read, D4DFILE_write, D4DFILE_fseek, D4DFILE_ftell)
	Macro that define the API to external resources. More...
#define	D4D_READ8L(x)
	Macro for handling endianism - read 8bit - from Little Endian. More...
#define	D4D_READ16L(x)
	Macro for handling endianism - read 16bit - from Little Endian. More...
#define	D4D_READ32L(x)
	Macro for handling endianism - read 32bit - from Little Endian. More...
#define	D4D_READ8B(x)
	Macro for handling endianism - read 8bit - from Big Endian. More...
#define	D4D_READ16B(x)
	Macro for handling endianism - read 16bit - from Big Endian. More...
#define	D4D_READ32B(x)
	Macro for handling endianism - read 32bit - from Big Endian. More...
#define	D4D_WRITE8L(x)
	Macro for handling endianism - write 8bit - from Little Endian. More...
#define	D4D_WRITE16L(x)
	Macro for handling endianism - write 16bit - from Little Endian. More...
#define	D4D_WRITE32L(x)
	Macro for handling endianism - write 32bit - from Little Endian. More...
#define	D4D_WRITE8B(x)
	Macro for handling endianism - write 8bit - from Big Endian. More...
#define	D4D_WRITE16B(x)
	Macro for handling endianism - write 16bit - from Big Endian. More...
#define	D4D_WRITE32B(x)
	Macro for handling endianism - write 32bit - from Big Endian. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define D4D_DECLARE_FILE_FUNCTIONS	(		D4DFILE_fopen,
			D4DFILE_fclose,
			D4DFILE_read,
			D4DFILE_write,
			D4DFILE_fseek,
			D4DFILE_ftell
	)

Macro that define the API to external resources.

Parameters

D4DFILE_fopen	- pointer to open file user/system function
D4DFILE_fclose	- pointer to close file user/system function
D4DFILE_read	- pointer to read file user/system function
D4DFILE_write	- - pointer to write file user/system function
D4DFILE_fseek	- - pointer to seek file user/system function
D4DFILE_ftell	- - pointer to tell file user/system function

Note

This macro MUST be declared if the external resources are used in project.

Definition at line 230 of file d4d_extsrc.h.

#define D4D_DECLARE_LOCALE_FUNCTIONS	(		D4DLOCALE_TranslateStr,
			D4DLOCALE_GetTranslateStrLength
	)

Macro that define the external custom strings functionality.

Parameters

D4DLOCALE_TranslateStr	- pointer to user translate function
D4DLOCALE_GetTranslateStrLength	- pointer to to user get translated text function

Note

This macro MUST be declared if the D4D_EXTSRC_TEXT_ENABLE is enabled to support translated string.

Definition at line 213 of file d4d_extsrc.h.

#define D4D_READ16B

(

x

)

Macro for handling endianism - read 16bit - from Big Endian.

Definition at line 254 of file d4d_extsrc.h.

#define D4D_READ16L

(

x

)

Macro for handling endianism - read 16bit - from Little Endian.

Definition at line 247 of file d4d_extsrc.h.

#define D4D_READ32B

(

x

)

Macro for handling endianism - read 32bit - from Big Endian.

Definition at line 256 of file d4d_extsrc.h.

#define D4D_READ32L

(

x

)

Macro for handling endianism - read 32bit - from Little Endian.

Definition at line 249 of file d4d_extsrc.h.

#define D4D_READ8B

(

x

)

Macro for handling endianism - read 8bit - from Big Endian.

Definition at line 252 of file d4d_extsrc.h.

#define D4D_READ8L

(

x

)

Macro for handling endianism - read 8bit - from Little Endian.

Definition at line 245 of file d4d_extsrc.h.

#define D4D_WRITE16B

(

x

)

Macro for handling endianism - write 16bit - from Big Endian.

Definition at line 268 of file d4d_extsrc.h.

#define D4D_WRITE16L

(

x

)

Macro for handling endianism - write 16bit - from Little Endian.

Definition at line 261 of file d4d_extsrc.h.

#define D4D_WRITE32B

(

x

)

Macro for handling endianism - write 32bit - from Big Endian.

Definition at line 270 of file d4d_extsrc.h.

#define D4D_WRITE32L

(

x

)

Macro for handling endianism - write 32bit - from Little Endian.

Definition at line 263 of file d4d_extsrc.h.

#define D4D_WRITE8B

(

x

)

Macro for handling endianism - write 8bit - from Big Endian.

Definition at line 266 of file d4d_extsrc.h.

#define D4D_WRITE8L

(

x

)

Macro for handling endianism - write 8bit - from Little Endian.

Definition at line 259 of file d4d_extsrc.h.