IXRLinearGradientBrush::GetStartPoint (Compact 2013)
3/28/2014
This method retrieves the two-dimensional coordinates of the starting point for this linear gradient.
Syntax
virtual HRESULT STDMETHODCALLTYPE GetStartPoint(
XRPoint* pStartPoint
) = 0;
Parameters
- pStartPoint
[out] Pointer to an XRPoint structure that describes the x-y coordinates of the gradient starting point.
Return Value
Returns an HRESULT that indicates success or failure.
Remarks
An IXRLinearGradientBrush paints a gradient along a line. The line's starting points and endpoints are defined by IXRLinearGradientBrush::SetStartPoint and IXRLinearGradientBrush::SetEndPoint in the IXRLinearGradientBrush class.
The default linear gradient is diagonal, and the default mode for the gradient coordinate system is XRBrushMappingMode_RelativeToBoundingBox. When the inherited method IXRGradientBrush::GetMappingMode returns the mapping mode XRBrushMappingMode_RelativeToBoundingBox, pStartPoint is a logical point, where values between 0 and 1 are mapped against the total size of the resulting bounding box. By default, the pStartPoint value of a linear gradient is an XRPoint value of (0,0), the upper-left corner of the area being painted. The colors in the resulting gradient are interpolated and applied along vectors that parallel this diagonal axis.
.NET Framework Equivalent
System.Windows.Media.LinearGradientBrush.StartPoint
Requirements
Header |
XamlRuntime.h |
sysgen |
SYSGEN_XAML_RUNTIME |
See Also
Reference
IXRLinearGradientBrush
IXRLinearGradientBrush::SetStartPoint