iufFrameList.h File Reference

#include <iufFrame.h>

Go to the source code of this file.

Macros
#define	IUFL_INVALID   (iufl_t) NULL

Typedefs
typedef IufFrameList *	iufl_t

Functions
iufl_t	iufFrameListCreate (int numFrames)
int	iufFrameListDelete (iufl_t frameList)
int	iufFrameListDeepDelete (iufl_t frameList)
int	iufFrameListCompare (iufl_t reference, iufl_t actual)
int	iufFrameListGetSize (iufl_t frameList)
iufr_t	iufFrameListGet (iufl_t frameList, int index)
int	iufFrameListSet (iufl_t frameList, iufr_t member, int index)

Macro Definition Documentation

IUFL_INVALID

#define IUFL_INVALID   (iufl_t) NULL

Typedef Documentation

iufl_t

typedef IufFrameList* iufl_t

A frame list contains a list of IufFrame objects. Typically a frameList is created with a fixed size with iufFrameListCreate(). And then frames are set at an index with iufFrameListSet().

Function Documentation

iufFrameListCompare()

int iufFrameListCompare	(	iufl_t	reference,
		iufl_t	actual
	)

Parameters

reference	The frameList to compare to
actual	The frameList to compare with

iufFrameListCreate()

iufl_t iufFrameListCreate

(

int

numFrames

)

Parameters

numFrames

The number of frames to allocate.

iufFrameListDeepDelete()

int iufFrameListDeepDelete

(

iufl_t

frameList

)

Parameters

frameList

The frameList that is to be deleted

iufFrameListDelete()

int iufFrameListDelete

(

iufl_t

frameList

)

Parameters

frameList

The frameList that is to be deleted

iufFrameListGet()

iufr_t iufFrameListGet	(	iufl_t	frameList,
		int	index
	)

Parameters

frameList	The frameList of interest
index	The index in the list

iufFrameListGetSize()

int iufFrameListGetSize

(

iufl_t

frameList

)

Parameters

frameList

The frameList of interest

iufFrameListSet()

int iufFrameListSet	(	iufl_t	frameList,
		iufr_t	member,
		int	index
	)

Parameters

frameList	The frameList of interest
member	The IufFrame to set
index	The index in the list