SkGradientShader Class Reference

#include <SkGradientShader.h>

List of all members.

Static Public Member Functions

static SkShaderCreateLinear (const SkPoint pts[2], const SkColor colors[], const SkScalar pos[], int count, SkShader::TileMode mode, SkUnitMapper *mapper=NULL)
static SkShaderCreateRadial (const SkPoint &center, SkScalar radius, const SkColor colors[], const SkScalar pos[], int count, SkShader::TileMode mode, SkUnitMapper *mapper=NULL)
static SkShaderCreateTwoPointRadial (const SkPoint &start, SkScalar startRadius, const SkPoint &end, SkScalar endRadius, const SkColor colors[], const SkScalar pos[], int count, SkShader::TileMode mode, SkUnitMapper *mapper=NULL)
static SkShaderCreateSweep (SkScalar cx, SkScalar cy, const SkColor colors[], const SkScalar pos[], int count, SkUnitMapper *mapper=NULL)

Detailed Description

SkGradientShader hosts factories for creating subclasses of SkShader that render linear and radial gradients.

Definition at line 29 of file SkGradientShader.h.


Member Function Documentation

static SkShader* SkGradientShader::CreateLinear ( const SkPoint  pts[2],
const SkColor  colors[],
const SkScalar  pos[],
int  count,
SkShader::TileMode  mode,
SkUnitMapper mapper = NULL 
) [static]

Returns a shader that generates a linear gradient between the two specified points.

CreateLinear returns a shader with a reference count of 1. The caller should decrement the shader's reference count when done with the shader. It is an error for count to be < 2.

Parameters:
pts The start and end points for the gradient.
colors The array[count] of colors, to be distributed between the two points
pos May be NULL. array[count] of SkScalars, or NULL, of the relative position of each corresponding color in the colors array. If this is NULL, the the colors are distributed evenly between the start and end point. If this is not null, the values must begin with 0, end with 1.0, and intermediate values must be strictly increasing.
count Must be >=2. The number of colors (and pos if not NULL) entries.
mode The tiling mode
mapper May be NULL. Callback to modify the spread of the colors.
static SkShader* SkGradientShader::CreateRadial ( const SkPoint center,
SkScalar  radius,
const SkColor  colors[],
const SkScalar  pos[],
int  count,
SkShader::TileMode  mode,
SkUnitMapper mapper = NULL 
) [static]

Returns a shader that generates a radial gradient given the center and radius.

CreateRadial returns a shader with a reference count of 1. The caller should decrement the shader's reference count when done with the shader. It is an error for colorCount to be < 2, or for radius to be <= 0.

Parameters:
center The center of the circle for this gradient
radius Must be positive. The radius of the circle for this gradient
colors The array[count] of colors, to be distributed between the center and edge of the circle
pos May be NULL. The array[count] of SkScalars, or NULL, of the relative position of each corresponding color in the colors array. If this is NULL, the the colors are distributed evenly between the center and edge of the circle. If this is not null, the values must begin with 0, end with 1.0, and intermediate values must be strictly increasing.
count Must be >= 2. The number of colors (and pos if not NULL) entries
mode The tiling mode
mapper May be NULL. Callback to modify the spread of the colors.
static SkShader* SkGradientShader::CreateSweep ( SkScalar  cx,
SkScalar  cy,
const SkColor  colors[],
const SkScalar  pos[],
int  count,
SkUnitMapper mapper = NULL 
) [static]

Returns a shader that generates a sweep gradient given a center.

CreateSweep returns a shader with a reference count of 1. The caller should decrement the shader's reference count when done with the shader. It is an error for colorCount to be < 2.

Parameters:
cx The X coordinate of the center of the sweep
cx The Y coordinate of the center of the sweep
colors The array[count] of colors, to be distributed around the center.
pos May be NULL. The array[count] of SkScalars, or NULL, of the relative position of each corresponding color in the colors array. If this is NULL, the the colors are distributed evenly between the center and edge of the circle. If this is not null, the values must begin with 0, end with 1.0, and intermediate values must be strictly increasing.
count Must be >= 2. The number of colors (and pos if not NULL) entries
mapper May be NULL. Callback to modify the spread of the colors.
static SkShader* SkGradientShader::CreateTwoPointRadial ( const SkPoint start,
SkScalar  startRadius,
const SkPoint end,
SkScalar  endRadius,
const SkColor  colors[],
const SkScalar  pos[],
int  count,
SkShader::TileMode  mode,
SkUnitMapper mapper = NULL 
) [static]

Returns a shader that generates a radial gradient given the start position, start radius, end position and end radius.

CreateTwoPointRadial returns a shader with a reference count of 1. The caller should decrement the shader's reference count when done with the shader. It is an error for colorCount to be < 2, for startRadius or endRadius to be < 0, or for startRadius to be equal to endRadius.

Parameters:
start The center of the start circle for this gradient
startRadius Must be positive. The radius of the start circle for this gradient.
end The center of the end circle for this gradient
endRadius Must be positive. The radius of the end circle for this gradient.
colors The array[count] of colors, to be distributed between the center and edge of the circle
pos May be NULL. The array[count] of SkScalars, or NULL, of the relative position of each corresponding color in the colors array. If this is NULL, the the colors are distributed evenly between the center and edge of the circle. If this is not null, the values must begin with 0, end with 1.0, and intermediate values must be strictly increasing.
count Must be >= 2. The number of colors (and pos if not NULL) entries
mode The tiling mode
mapper May be NULL. Callback to modify the spread of the colors.

The documentation for this class was generated from the following file:

Generated on Tue Oct 20 11:03:42 2009 for Skia by  doxygen 1.6.1