SetBkMode (Compact 2013)

  • Article

3/28/2014

This function sets the background mix mode of the specified device context. The background mix mode is used with text, hatched brushes, and with non-solid pen styles.

Syntax

int SetBkMode(
  HDC hdc, 
  int iBkMode
);

Parameters

  • hdc
    [in] Handle to the device context.

  • iBkMode
    [in] Specifies the background mode.

    It is either of the following values.

    Value

    Description

    OPAQUE

    Background is filled with the current background color before the text, hatched brush, or pen is drawn.

    TRANSPARENT

    Background remains untouched.

Return Value

If the function succeeds, the return value specifies the previous background mode.

If the function fails, the return value is zero.

To get extended error information, call GetLastError.

Remarks

The SetBkMode function affects the line styles for lines drawn using a pen created by the CreatePen function.

The iBkMode parameter can also be set to driver-specific values. GDI passes such values to the device driver and otherwise ignores them.

The iBkMode parameter is stored internally as a single byte.

Requirements

Header

windows.h

Library

coredll.lib

See Also

Reference

GDI Functions
CreatePen
GetBkMode