iufOffset.h File Reference

Go to the source code of this file.

Data Structures
struct	IufOffset

Macros
#define	IUO_INVALID   (iuo_t) NULL

Typedefs
typedef IufOffset *	iuo_t

Functions
iuo_t	iufOffsetCreate (void)
	Create an offset object initialized at {0,0,0,0}. More...
int	iufOffsetDelete (iuo_t offset)
	Delete an offset object. More...
int	iufOffsetCompare (iuo_t reference, iuo_t actual)
	Compare two offsets with each other. More...

---

Data Structure Documentation

IufOffset

struct IufOffset

Data Fields
int	t
int	x
int	y
int	z

Macro Definition Documentation

IUO_INVALID

#define IUO_INVALID   (iuo_t) NULL

Typedef Documentation

iuo_t

typedef IufOffset* iuo_t

Function Documentation

iufOffsetCompare()

int iufOffsetCompare	(	iuo_t	reference,
		iuo_t	actual
	)

Compare two offsets with each other.

Returns

Returns IUF_TRUE when the offsets are equal and IUF_FALSE otherwise.

Parameters

reference	The offset to compare to
actual	The offset to compare with

iufOffsetCreate()

iuo_t iufOffsetCreate

(

void

)

Create an offset object initialized at {0,0,0,0}.

Returns

Returns a zero offset object.

iufOffsetDelete()

int iufOffsetDelete

(

iuo_t

offset

)

Delete an offset object.

Returns

Returns IUF_E_OK in when successful or IUF_ERR_VALUE when the offset is NULL

Parameters

offset

the offset that is to be deleted.