HatchBrush Functions (GDI+)

An HatchBrush defines a rectangular brush with a hatch style, a foreground color, and a background color. There are six hatch styles. The foreground color defines the color of the hatch lines; the background color defines the color over which the hatch lines are drawn.

Return Values

If the function succeeds, it returns Ok, which is an element of the Status enumeration.

 

If the function fails, it returns one of the other elements of the Status enumeration.

GdipCreateHatchBrush

Description

Creates a HatchBrush object based on a hatch style, a foreground color, and a background color.

Syntax

GpStatus WINGDIPAPI GdipCreateHatchBrush(

    GpHatchStyle hatchstyle,

    ARGB forecol,

    ARGB backcol,

    GpHatch **brush

);

PowerBASIC Syntax

DECLARE FUNCTION GdipCreateHatchBrush ( _

    BYVAL hatchStyle AS LONG, _

    BYVAL forecol AS DWORD, _

    BYVAL backcol AS DWORD, _

    BYREF brush AS DWORD _

) AS LONG

Parameters

hatchStyle

[in] Element of the HatchStyle enumeration that specifies the pattern of hatch lines that will be used.

foreColor

[in] ARGB color to use for the hatch lines.

backColor

[in]  ARGB color to use for the background.

brush

[in] Pointer to a variable that receives a pointer to the new created HatchBrush.

GdipGetHatchBackgroundColor

Description

Gets the background color of this hatch brush.

Syntax

GpStatus WINGDIPAPI GdipGetHatchBackgroundColor(

    GpHatch *brush,

    ARGB* backcol

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetHatchBackgroundColor ( _

    BYVAL brush AS DWORD, _

    BYREF backcol AS DWORD _

) AS LONG

Parameters

brush

[in] Pointer to the HatchBrush object.

color

[out] Pointer to a variable that receives the background color. The background color defines the color over which the hatch lines are drawn.

GdipGetHatchForegroundColor

Description

Gets the foreground color of this hatch brush.

Syntax

GpStatus WINGDIPAPI GdipGetHatchForegroundColor(

    GpHatch *brush,

    ARGB* forecol

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetHatchForegroundColor ( _

    BYVAL brush AS DWORD, _

    BYREF forecol AS DWORD _

) AS LONG

Parameters

brush

[in] Pointer to the HatchBrush object.

color

[out] Pointer to a variable that receives the foreground color. The foreground color defines the color of the hatch lines.

GdipGetHatchStyle

Description

Gets the hatch style of this hatch brush.

Syntax

GpStatus WINGDIPAPI GdipGetHatchStyle(

    GpHatch *brush,

    GpHatchStyle *hatchstyle

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetHatchStyle ( _

    BYVAL brush AS DWORD, _

    BYREF hatchStyle AS LONG _

) AS LONG

Parameters

brush

[in] Pointer to the HatchBrush object.

hatchstyle

[out] Pointer to a variable that receives the hatch style, which is one of the elements of the HatchStyle enumeration.