|
Description
Gets the colors currently set to be
interpolated for this linear gradient brush and their corresponding
blend positions.
Syntax
GpStatus WINGDIPAPI GdipGetLinePresetBlend(
GpLineGradient
*brush,
ARGB *blend,
REAL* positions,
INT count
);
PowerBASIC Syntax
DECLARE FUNCTION GdipGetLinePresetBlend ( _
BYVAL brush AS
DWORD, _
BYREF blend AS
DWORD, _
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
colors. A color of a given index in the blend array
corresponds to the blend position of that same index in the positions
array.
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 elements in the blend array. This is the
same as the number of elements in the positions
array. Before calling the GdipGetLinePresetBlend
function, call the GdipGetLinePresetBlendCount
function to determine the current number of colors. The number of blend
positions retrieved is the same as the number of colors retrieved.
Return Value
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.
|
