clBitmapApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : utils
 * File        : clBitmapApi.h
 *******************************************************************************/

/******************************************************************************
 * Description :
 *
 * OpenClovis Bitmap Library API file.
 *
 ****************************************************************************/

#ifndef _CL_BITMAP_API_H_
#define _CL_BITMAP_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clBitmap.h>


/*****************************************************************************
 *  Bitmap Data types 
 *****************************************************************************/
typedef ClRcT (*ClBitmapWalkCbT) 
               (ClBitmapHandleT hBitmap, ClUint32T bitNum, 
                void *pCookie) ;

/*****************************************************************************
 *  Bitmap functions
 *****************************************************************************/

ClRcT
clBitmapCreate(CL_OUT ClBitmapHandleT  *phBitmap, 
               CL_IN  ClUint32T        bitNum);

ClRcT
clBitmapDestroy(CL_IN ClBitmapHandleT  hBitmap);

ClRcT 
clBitmapBitSet(CL_IN ClBitmapHandleT  hBitmap,
               CL_IN ClUint32T        bitNum);

ClRcT 
clBitmapAllBitsSet(ClBitmapHandleT  hBitmap);

ClRcT 
clBitmapBitClear(CL_IN ClBitmapHandleT  hBitmap,
                 CL_IN ClUint32T        bitNum);

ClRcT 
clBitmapAllBitsClear(ClBitmapHandleT  hBitmap);

ClInt32T 
clBitmapIsBitSet(CL_IN  ClBitmapHandleT  hBitmap,
                 CL_IN  ClUint32T        bitNum,
                 CL_OUT ClRcT            *pRetCode); 

ClRcT 
clBitmapWalkUnlocked(CL_IN ClBitmapHandleT  hBitmap, 
                     CL_IN ClBitmapWalkCbT  fpUserSetBitWalkCb, 
                     CL_IN void             *pCookie);

ClRcT 
clBitmapWalk(CL_IN ClBitmapHandleT  hBitmap, 
             CL_IN ClBitmapWalkCbT  fpUserSetBitWalkCb, 
             CL_IN void             *pCookie);

ClUint32T 
clBitmapLen(CL_IN ClBitmapHandleT  hBitmap);

ClRcT
clBitmapNumBitsSet(CL_IN  ClBitmapHandleT  hBitmap,
                   CL_OUT ClUint32T        *pNumBits);

ClRcT
clBitmapNextClearBitSetNGet(CL_IN  ClBitmapHandleT  hBitmap,
                            CL_IN  ClUint32T        length, 
                            CL_OUT ClUint32T        *pBitSet);

ClRcT
clBitmap2BufferGet(CL_IN  ClBitmapHandleT  hBitmap,
                   CL_OUT ClUint32T        *pListLen,
                   CL_OUT ClUint8T         **ppPositionList);

ClRcT
clBitmapBuffer2BitmapGet(CL_IN  ClUint32T        listLen, 
                         CL_IN  ClUint8T         *pPositionList,
                         CL_OUT ClBitmapHandleT  *phBitmap);

ClRcT
clBitmap2PositionListGet(CL_IN  ClBitmapHandleT  hBitmap,
                         CL_OUT ClUint32T        *pListLen,
                         CL_OUT ClUint32T        **ppPositionList);

ClRcT
clBitmapPositionList2BitmapGet(CL_IN  ClUint32T        listLen, 
                               CL_IN  ClUint32T        *pPositionList,
                               CL_OUT ClBitmapHandleT  *phBitmap);

ClRcT
clBitmapBufferBitsCopy(CL_IN ClUint32T        listLen, 
                       CL_IN ClUint8T         *pPositionList,
                       CL_IN ClBitmapHandleT  hBitmap);

#ifdef __cplusplus
}
#endif

#endif  /* _CL_BITMAP_API_H_ */