UpdateLayeredWindow
The UpdateLayeredWindow function updates the position, size, shape, content, and translucency of a layered window.
BOOL UpdateLayeredWindow(
HWND hwnd, // handle to layered window
HDC hdcDst, // handle to screen DC
POINT *pptDst, // new screen position
SIZE *psize, // new size of the layered window
HDC hdcSrc, // handle to surface DC
POINT *pptSrc, // layer position
COLORREF crKey, // color key
BLENDFUNCTION *pblend, // blend function
DWORD dwFlags // options
);
Parameters
hwnd
[in] Handle to a layered window. A layered window is created by specifying WS_EX_LAYERED when creating the window with the CreateWindowEx function.
hdcDst
[in] Handle to a device context (DC) for the screen. This handle is obtained by specifying NULL when calling the GetDC function. It is used for palette color matching when the window contents are updated. If hdcDst is NULL, the default palette will be used.
If hdcSrc is NULL, hdcDst must be NULL.
pptDst
[in] Pointer to a POINT structure that specifies the new screen position of the layered window. If the current position is not changing, pptDst can be NULL.
psize
[in] Pointer to a SIZE 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] Handle to a DC for the surface that defines the layered window. This handle can be obtained by calling the CreateCompatibleDC function or the IDirectDrawSurface7::GetDC method. If the shape and visual context of the window are not changing, hdcSrc can be NULL.
pptSrc
[in] Pointer to a POINT structure that specifies the location of the layer in the device context.
If hdcSrc is NULL, pptSrc should be NULL.
crKey
[in] Pointer to a COLORREF value that specifies the color key to be used when composing the layered window. To generate a COLORREF, use the RGB macro.
pblend
[in] Pointer to a BLENDFUNCTION structure that specifies the transparency value to be used when composing the layered window.
dwFlags
[in] This parameter can be one of the following values. Value Meaning
ULW_ALPHA 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 Use crKey as the transparency color.
ULW_OPAQUE Draw an opaque layered window.
If hdcSrc is NULL, dwFlags should be zero.
Return Values
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.
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 WM_DISPLAYCHANGE message and recreate its layered windows when the display's color depth changes.
For more information, see Layered Windows.
Requirements
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in Winuser.h; include Windows.h.
Library: Use User32.lib.