Function

CGShadingCreateAxial

Creates a shading object to use for axial shading.

Declaration

CGShadingRef CGShadingCreateAxial(CGColorSpaceRef space, CGPoint start, CGPoint end, CGFunctionRef function, bool extendStart, bool extendEnd);

Parameters

colorspace

The color space in which color values are expressed. Core Graphics retains this object; upon return, you may safely release it.

start

The starting point of the axis, in the shading's target coordinate space.

end

The ending point of the axis, in the shading's target coordinate space.

function

A CGFunction object created by the function CGFunctionCreate. This object refers to your function for creating an axial shading. Core Graphics retains this object; upon return, you may safely release it.

extendStart

A Boolean value that specifies whether to extend the shading beyond the starting point of the axis.

extendEnd

A Boolean value that specifies whether to extend the shading beyond the ending point of the axis.

Return Value

A new Core Graphics axial shading. You are responsible for releasing this object using CGShadingRelease.

Discussion

An axial shading is a color blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis. When you are ready to draw the shading, call the function CGContextDrawShading.

See Also

Creating Shading Objects

CGShadingCreateRadial

Creates a shading object to use for radial shading.