L_GetOverlayCount

#include "l_bitmap.h"

L_LTKRN_API L_INT L_GetOverlayCount (pBitmap, puCount, uFlags)

pBITMAPHANDLE pBitmap;

/* pointer to the main bitmap handle */

L_UINT *puCount;

/* variable to be updated with the overlay count */

L_UINT uFlags;

/* reserved for future use */

Gets the number of overlays that have been defined for the specified main bitmap.

Parameter

Description

pBitmap

Pointer to the bitmap handle referencing the main bitmap.

puCount

Pointer to a variable to be updated with the number of overlays.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function will count how many overlays have been defined. The overlays are defined by calling L_SetOverlayBitmap or L_SetOverlayAttributes.

Required DLLs and Libraries

LTKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Windows 2000 / XP/Vista.

See Also

Functions:

L_SizeBitmap, L_StartResize, L_Resize, L_StopResize, L_SetOverlayBitmap, L_GetOverlayBitmap, L_SetOverlayAttributes, L_GetOverlayAttributes, L_UpdateBitmapOverlayBits, L_BricksTextureBitmap, L_CanvasBitmap, L_DisplaceMapBitmap, L_FragmentBitmap, L_VignetteBitmap

Topics:

Raster Image Functions: Combining Images

 

Overlay Overview

Example

This example will return the count of the overlays from pBitmap.

L_INT  GetOverlayCountExample(pBITMAPHANDLE pBitmap)
{
   L_INT nRet;
   L_UINT uCount;

   nRet  = L_GetOverlayCount(pBitmap, &uCount, 0); 
   if(nRet != SUCCESS)
      return nRet;

   /* now uCount contains the number of overlays */
   return SUCCESS ;
}