CreateBitmap

  • Article

This function creates a bitmap with the specified width, height, and bit depth.

HBITMAP CreateBitmap(
int nWidth, 
int nHeight, 
UINT cPlanes, 
UINT cBitsPerPel, 
CONST VOID *lpvBits
);

Parameters

  • nWidth
    [in] Specifies the bitmap width, in pixels.
  • nHeight
    [in] Specifies the bitmap height, in pixels.
  • cPlanes
    [in] Specifies the number of color planes used by the device. The value of this parameter must be 1.
  • cBitsPerPel
    [in] Specifies the number of bits required to identify the color of a single pixel.
  • lpvBits
    [in] Long void pointer to an array of color data used to set the colors in a rectangle of pixels. Each scan line in the rectangle must be word aligned (scan lines that are not word aligned must be padded with zeros). If this parameter is NULL, the new bitmap is undefined.

Return Values

A handle to a bitmap indicates success. NULL indicates failure. To get extended error information, call GetLastError.

Remarks

After a bitmap is created, it can be selected into a device context by calling the SelectObject function.

While the CreateBitmap function can be used to create color bitmaps, for performance reasons applications should use CreateBitmap to create monochrome bitmaps and CreateCompatibleBitmap to create color bitmaps. When a color bitmap returned from CreateBitmap is selected into a device context, the system must ensure that the bitmap matches the format of the device context it is being selected into. Because CreateCompatibleBitmap takes a device context, it returns a bitmap that has the same format as the specified device context. Because of this, subsequent calls to SelectObject are faster than with a color bitmap returned from CreateBitmap.

If the bitmap is monochrome, zeros represent the foreground color and ones represent the background color for the destination device context.

If an application sets the nWidth or nHeight parameters to zero, CreateBitmap returns the handle to a 1- by 1-pixel, monochrome bitmap.

When you no longer need the bitmap, call the DeleteObject function to delete it.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Wingdi.h   Mgbitmap.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CreateCompatibleBitmap, DeleteObject, GetLastError, SelectObject

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.