CGpLinearGradientBrush.SetBlendTriangularShapemethod

Sets the blend triangular shape.

Syntax

FUNCTION SetBlendTriangularShape (BYVAL focus AS SINGLE, BYVAL scale AS SINGLE = 1.0) AS GpStatus

Parameters

Return value

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

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

Description

Sets the blend shape of this path gradient brush.

Remarks

By default, the color changes gradually from the starting color (color at the starting boundary of the linear gradient brush) to the ending color (color at the ending boundary of the linear gradient brush) as you move from the starting boundary to the ending boundary. You can customize the positioning and blending of the starting and ending colors by using the SetBlendTriangularShape method.

The SetBlendTriangularShape method customizes the blend so that it follows a triangular shape with the extremes of the triangle's base at the gradient's boundaries. The starting color, which, in a default blend, is at the starting boundary of a linear gradient brush, appears at the starting and ending boundaries of the linear gradient brush when a triangular-shaped blend is applied. The position of the ending color, which, in a default blend, is at the ending boundary, is somewhere between the boundaries and is determined by the value of the focus. In other words, the focus specifies the position of the peak of the triangle. For example, a focus value of 0.5 places the peak half way between the starting and ending boundaries. The ending color appears at this peak.

The ending color in a triangular-shaped blend is a percentage of the gamut between the gradient's default-blend starting color and default-blend ending color. For example, suppose a linear gradient brush is constructed with red as the starting color and blue as the ending color. If SetBlendTriangularShape is called with a scale value of 0.3, the ending color in the triangular-shaped blend is a hue that is 30 percent between red and blue (70 percent red, 30 percent blue). A scale value of 1.0 produces an ending color that is 100 percent blue.

Example

' ======================================================================================== ' The following example creates a linear gradient brush, sets a triangular-shaped blend, ' and uses the brush to fill a rectangle. Twice more, the code sets a triangular-shaped ' blend with different values and, each time, uses the brush to fill a rectangle. ' ======================================================================================== SUB Example_SetBlendTriangularShape (BYVAL hdc AS HDC)

' // Create a graphics object from the window device context DIM graphics AS CGpGraphics = hdc ' // Set the scale transform graphics.ScaleTransformForDpi

DIM pt1 AS GpPoint = (0, 0) DIM pt2 AS GpPoint = (500, 0)

DIM linGrBrush AS CGpLinearGradientBrush = CGpLinearGradientBrush(@pt1, @pt2, ARGB_RED, ARGB_BLUE)

linGrBrush.SetBlendTriangularShape(0.5, 0.6) graphics.FillRectangle(@linGrBrush, 0, 0, 500, 50)

linGrBrush.SetBlendTriangularShape(0.5, 0.8) graphics.FillRectangle(@linGrBrush, 0, 75, 500, 50)

linGrBrush.SetBlendTriangularShape(0.5, 1.0) graphics.FillRectangle(@linGrBrush, 0, 150, 500, 50)

END SUB ' ========================================================================================

Reference

• Include file CGpBrush.inc
• Defined in AfxNova/CGpBrush.inc:445
• Documented in Graphics/GdiPlus Classes/CGpBrush Classes.md
• Topic: CGpBrush Class