ID2D1BitmapBrush::SetExtendModeY method (d2d1.h)

Specifies how the brush vertically tiles those areas that extend past its bitmap.

Syntax

void SetExtendModeY(
  D2D1_EXTEND_MODE extendModeY
);

Parameters

extendModeY

Type: D2D1_EXTEND_MODE

A value that specifies how the brush vertically tiles those areas that extend past its bitmap.

Return value

None

Remarks

Sometimes, the bitmap for a bitmap brush doesn't completely fill the area being painted. When this happens, Direct2D uses the brush's horizontal (SetExtendModeX) and vertical (SetExtendModeY) extend mode settings to determine how to fill the remaining area.

The following illustration shows the results from every possible combination of the extend modes for an ID2D1BitmapBrush: D2D1_EXTEND_MODE_CLAMP (CLAMP), D2D1_EXTEND_MODE_WRAP (WRAP), and D2D1_EXTEND_MIRROR (MIRROR).

Examples

The following example shows how to set the bitmap brush's x- and y-extend modes to D2D1_EXTEND_MIRROR. It then paints the rectangle with the ID2D1BitmapBrush.

It produces the following output.

m_pBitmapBrush->SetExtendModeX(D2D1_EXTEND_MODE_MIRROR);
m_pBitmapBrush->SetExtendModeY(D2D1_EXTEND_MODE_MIRROR);

m_pRenderTarget->FillRectangle(exampleRectangle, m_pBitmapBrush);

For more information about bitmap brushes, see the Brushes Overview.

Requirements

See also

ID2D1BitmapBrush

ID2D1BitmapBrush::GetExtendModeY