clBitmapApi.h File Reference

Header file of Bitmap related APIs. More...

#include <clBitmap.h>

Go to the source code of this file.

Typedefs
typedef ClRcT(*	ClBitmapWalkCbT )(ClBitmapHandleT hBitmap, ClUint32T bitNum, void *pCookie)
	Callback function type, which is executed during the walk on a bitmap.

Functions
ClRcT	clBitmap2BufferGet (CL_IN ClBitmapHandleT hBitmap, CL_OUT ClUint32T *pListLen, CL_OUT ClUint8T **ppPositionList)
	Get the buffer corresponding to a bitmap.
ClRcT	clBitmap2PositionListGet (CL_IN ClBitmapHandleT hBitmap, CL_OUT ClUint32T *pListLen, CL_OUT ClUint32T **ppPositionList)
	Get the position list corresponding to a bitmap.
ClRcT	clBitmapBitClear (CL_IN ClBitmapHandleT hBitmap, CL_IN ClUint32T bitNum)
	Clear a bit of the bitmap.
ClRcT	clBitmapBitSet (CL_IN ClBitmapHandleT hBitmap, CL_IN ClUint32T bitNum)
	Set a bit of the bitmap.
ClRcT	clBitmapBuffer2BitmapGet (CL_IN ClUint32T listLen, CL_IN ClUint8T *pPositionList, CL_OUT ClBitmapHandleT *phBitmap)
	Get the bitmap corresponding to a bitmap buffer.
ClRcT	clBitmapBufferBitsCopy (CL_IN ClUint32T listLen, CL_IN ClUint8T *pPositionList, CL_IN ClBitmapHandleT hBitmap)
	Set the bitmap bits corresponding to the bits in buffer.
ClRcT	clBitmapCreate (CL_OUT ClBitmapHandleT *phBitmap, CL_IN ClUint32T bitNum)
	Create a bitmap.
ClRcT	clBitmapDestroy (CL_IN ClBitmapHandleT hBitmap)
	Destroy a bitmap.
ClInt32T	clBitmapIsBitSet (CL_IN ClBitmapHandleT hBitmap, CL_IN ClUint32T bitNum, CL_OUT ClRcT *pRetCode)
	Find the status of a bit (Set or Clear) in a bitmap.
ClUint32T	clBitmapLen (CL_IN ClBitmapHandleT hBitmap)
	Get the length of a bitmap.
ClRcT	clBitmapNextClearBitSetNGet (CL_IN ClBitmapHandleT hBitmap, CL_IN ClUint32T length, CL_OUT ClUint32T *pBitSet)
	Set the next clear bit and get that bit number.
ClRcT	clBitmapNumBitsSet (CL_IN ClBitmapHandleT hBitmap, CL_OUT ClUint32T *pNumBits)
	Number of bits set in a bitmap.
ClRcT	clBitmapPositionList2BitmapGet (CL_IN ClUint32T listLen, CL_IN ClUint32T *pPositionList, CL_OUT ClBitmapHandleT *phBitmap)
	Get the bitmap corresponding to a bitmap position list.
ClRcT	clBitmapWalk (CL_IN ClBitmapHandleT hBitmap, CL_IN ClBitmapWalkCbT fpUserSetBitWalkCb, CL_IN void *pCookie)
	Perform locked walk on a bitmap.
ClRcT	clBitmapWalkUnlocked (CL_IN ClBitmapHandleT hBitmap, CL_IN ClBitmapWalkCbT fpUserSetBitWalkCb, CL_IN void *pCookie)
	Perform unlocked walk on a bitmap.

Detailed Description

Header file of Bitmap related APIs.