In This Topic ▼

L_DrawStarBitmap

Summary

Draws a star on the bitmap.

Syntax

#include "l_bitmap.h"

L_LTIMGSFX_API L_INT L_DrawStarBitmap(pBitmap, pStarInfo, uFlags)

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that references the bitmap on which to draw the star.

pSTARINFO pStarInfo

Pointer to an LPSTARINFO structure that contains star information.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.

If the bitmap has a region, the effect will be applied on the region only.

This function supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- and 64-bit color images is available in the Document and Medical Imaging toolkits.

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

Star Draw Function - Before

Star Draw Function - After

View additional platform support for this Star Draw function.

Required DLLs and Libraries

LTIMGSFX
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

Win32, x64.

Example

L_INT DrawStarBitmapExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */ 
   STARINFO StarInfo; 
 
   /* Load a bitmap at its own bits per pixel  */ 
   nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("Image2.cmp")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   StarInfo.uStructSize = sizeof(STARINFO); 
   StarInfo.nAngle = 0; 
   StarInfo.nAngleOpac = 0; 
   StarInfo.nBorderOpac = 0; 
   StarInfo.nDistOpac = 0; 
   StarInfo.nPhase = 0; 
   StarInfo.nSpokeDiv = 0; 
   StarInfo.pCenter.x = LeadBitmap.Width / 2; 
   StarInfo.pCenter.y = LeadBitmap.Height / 2; 
   StarInfo.uFlag = STR_INSIDE; 
   StarInfo.uHoleSize = 50; 
   StarInfo.uOpacity = 100; 
   StarInfo.uSpoke = 5; 
   StarInfo.uStarHeight = LeadBitmap.Height / 2; 
   StarInfo.uStarWidth = LeadBitmap.Width / 2; 
   StarInfo.crFillUpper = RGB(255, 0, 0); 
   StarInfo.crFillLower = RGB(0, 0, 255); 
 
   nRet = L_DrawStarBitmap(&LeadBitmap, &StarInfo, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   //free bitmap 
   if (LeadBitmap.Flags.Allocated) 
      L_FreeBitmap(&LeadBitmap); 
 
   return SUCCESS; 
}