1. Home
  2. API
  3. Broadside
  4. PdfDocument
  5. Methods
  6. CreateAxialShading(PathPoint, PathPoint, IReadOnlyList, PdfShadingOptions?)

CreateAxialShading(PathPoint, PathPoint, IReadOnlyList, PdfShadingOptions?) Method

Definition

Namespace Broadside
Assembly Broadside.dll
View source

Creates an axial shading (Type 2) that blends between gradient stops along the line from start to end.

public PdfAxialShading CreateAxialShading(PathPoint start, PathPoint end, IReadOnlyList<PdfGradientStop> stops, PdfShadingOptions? options)

Parameters

start
PathPoint

The point where offset 0 lies, in the shading's target space.

end
PathPoint

The point where offset 1 lies; not start.

stops
IReadOnlyList<PdfGradientStop>

The stops, as for CreateGradientFunction(IReadOnlyList<PdfGradientStop>); their colour space is the shading's.

options
PdfShadingOptions

The optional entries; null for none.

Returns

PdfAxialShading
The shading, a new indirect dictionary, as read back.

Remarks

ISO 32000-2 §8.7.4.5.3, Table 79 (PDF 1.3). Coords is the axis, Domain [0 1], and the Function is written inline as CreateGradientFunction(IReadOnlyList<PdfGradientStop>) builds it. Paint it with PaintShading(PdfShading) or through CreateShadingPattern(PdfShading, Nullable<Matrix>). Records PDF 1.3. A mutation.