Expand Minimize

UpdateLayeredWindow function

Updates the position, size, shape, content, and translucency of a layered window.

Syntax


BOOL WINAPI UpdateLayeredWindow(
  _In_      HWND hwnd,
  _In_opt_  HDC hdcDst,
  _In_opt_  POINT *pptDst,
  _In_opt_  SIZE *psize,
  _In_opt_  HDC hdcSrc,
  _In_opt_  POINT *pptSrc,
  _In_      COLORREF crKey,
  _In_opt_  BLENDFUNCTION *pblend,
  _In_      DWORD dwFlags
);

Parameters

hwnd [in]

Type: HWND

A handle to a layered window. A layered window is created by specifying WS_EX_LAYERED when creating the window with the CreateWindowEx function.

Windows 8:  The WS_EX_LAYERED style is supported for top-level windows and child windows. Previous Windows versions support WS_EX_LAYERED only for top-level windows.

hdcDst [in, optional]

Type: HDC

A handle to a DC for the screen. This handle is obtained by specifying NULL when calling the function. It is used for palette color matching when the window contents are updated. If hdcDst isNULL, the default palette will be used.

If hdcSrc is NULL, hdcDst must be NULL.

pptDst [in, optional]

Type: POINT*

A pointer to a structure that specifies the new screen position of the layered window. If the current position is not changing, pptDst can be NULL.

psize [in, optional]

Type: SIZE*

A pointer to a structure that specifies the new size of the layered window. If the size of the window is not changing, psize can be NULL. If hdcSrc is NULL, psize must be NULL.

hdcSrc [in, optional]

Type: HDC

A handle to a DC for the surface that defines the layered window. This handle can be obtained by calling the CreateCompatibleDC function. If the shape and visual context of the window are not changing, hdcSrc can be NULL.

pptSrc [in, optional]

Type: POINT*

A pointer to a structure that specifies the location of the layer in the device context. If hdcSrc is NULL, pptSrc should be NULL.

crKey [in]

Type: COLORREF

A structure that specifies the color key to be used when composing the layered window. To generate a COLORREF, use the RGB macro.

pblend [in, optional]

Type: BLENDFUNCTION*

A pointer to a structure that specifies the transparency value to be used when composing the layered window.

dwFlags [in]

Type: DWORD

This parameter can be one of the following values.

ValueMeaning
ULW_ALPHA
0x00000002

Use pblend as the blend function. If the display mode is 256 colors or less, the effect of this value is the same as the effect of ULW_OPAQUE.

ULW_COLORKEY
0x00000001

Use crKey as the transparency color.

ULW_OPAQUE
0x00000004

Draw an opaque layered window.

 

If hdcSrc is NULL, dwFlags should be zero.

Return value

Type:

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The source DC should contain the surface that defines the visible contents of the layered window. For example, you can select a bitmap into a device context obtained by calling the CreateCompatibleDC function.

An application should call SetLayout on the hdcSrc device context to properly set the mirroring mode. SetLayout will properly mirror all drawing into an HDC while properly preserving text glyph and (optionally) bitmap direction order. It cannot modify drawing directly into the bits of a device-independent bitmap (DIB). For more information, see Window Layout and Mirroring.

The UpdateLayeredWindow function maintains the window's appearance on the screen. The windows underneath a layered window do not need to be repainted when they are uncovered due to a call to UpdateLayeredWindow, because the system will automatically repaint them. This permits seamless animation of the layered window.

UpdateLayeredWindow always updates the entire window. To update part of a window, use the traditional WM_PAINT and set the blend value using SetLayeredWindowAttributes.

For best drawing performance by the layered window and any underlying windows, the layered window should be as small as possible. An application should also process the message and re-create its layered windows when the display's color depth changes.

For more information, see Layered Windows.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
SetWindowLong
SetWindowPos
UpdateLayeredWindowIndirect
Conceptual
Windows
Other Resources
AlphaBlend
CreateCompatibleBitmap
TransparentBlt

 

 

Community Additions

ADD
Show:
© 2014 Microsoft