Synthetic types

Macros
#define	SDK_TRUE   1
#define	SDK_FALSE   0
#define	SDK_NULL   NULL

Typedefs
typedef SDK_INT2	SDK_BOOL
typedef SDK_UINT2	SDK_HDRINFO
typedef SDK_UINT4	SDK_COLOR
typedef SDK_ERROR_VALUES	SDK_ERROR

Detailed Description

Synthetic types, i.e. the user does not have to worry about, given the types above (see Basic, atomic types) are adapted.

Macro Definition Documentation

#define SDK_TRUE   1

SDK_BOOL value to represent the boolean value "true"

#define SDK_FALSE   0

SDK_BOOL value to represent the boolean value "false"

#define SDK_NULL   NULL

SDK_NULL represents a null-pointer, (void *)0. For simplicity it defaults to the system/compiler NULL...

Typedef Documentation

typedef SDK_INT2 SDK_BOOL

Instead of a 1 bit type a fallback is being used. Please check the implementation since we may choose a type bigger than sizeof(char)/1 byte to reduce alignment issues and therefore optimize the access. SDK_FALSE indicates false, SDK_TRUE true.

typedef SDK_UINT2 SDK_HDRINFO

A short abbreviation to distinguish a special type. Actually we encode all structure size/version info with this type.

typedef SDK_UINT4 SDK_COLOR

SDK uses same format for encoding as the Windows COLORREF type. So one may assign values using the RGB()-macro: SDK_COLOR myBgColor = RGB(red, green, blue);

For reference:

#define RGB(r,g,b)          ((COLORREF)(((BYTE)(r)|((WORD)((BYTE)(g))<<8))|(((DWORD)(BYTE)(b))<<16)))

Note the rendering engine of the Navigation SDK internally uses 16 bit for performance reasons. So specifying two colors which differ in a 24 bit RGB-representation may result in the very same color in output.

typedef SDK_ERROR_VALUES SDK_ERROR

Unique type for errors codes. Allows better code checking by the compiler than just using a plain type.