GdipGetLineBlend

 

 

Description

Gets the blend factors and their corresponding blend positions from a LinearGradientBrush object.

Syntax

GpStatus WINGDIPAPI GdipGetLineBlend(

    GpLineGradient *brush,

    REAL *blend,

    REAL* positions,

    INT count

);

PowerBASIC Syntax

DECLARE FUNCTION GdipGetLineBlend ( _

    BYVAL brush AS DWORD, _

    BYREF blend AS SINGLE, _

    BYREF positions AS SINGLE, _

    BYVAL count AS LONG _

) AS LONG

Parameters

 

brush

[in] Pointer to the LinearGradientBrush object.

blend

[out] Pointer to an array that receives the blend factors. Each number in the array indicates a percentage of the ending color and is in the range from 0.0 through 1.0.

positions

[out] Pointer to an array that receives the blend positions. Each number in the array indicates a percentage of the distance between the starting boundary and the ending boundary and is in the range from 0.0 through 1.0, where 0.0 indicates the starting boundary of the gradient and 1.0 indicates the ending boundary. A blend position between 0.0 and 1.0 indicates a line, parallel to the boundary lines, that is a certain fraction of the distance from the starting boundary to the ending boundary. For example, a blend position of 0.7 indicates the line that is 70 percent of the distance from the starting boundary to the ending boundary. The color is constant on lines that are parallel to the boundary lines.

count

[in] Long integer value that specifies the number of blend factors to retrieve. Before calling the GdipGetLineBlend method of a LinearGradientBrush object, call the GdipGetLineBlendCount method of that same LinearGradientBrush object to determine the current number of blend factors. The number of blend positions retrieved is the same as the number of blend factors retrieved.

 

Valid HTML 4.01 Transitional