2008-12-17 15:59:43 +00:00
|
|
|
/*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Copyright 2006 The Android Open Source Project
|
2008-12-17 15:59:43 +00:00
|
|
|
*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
|
|
* found in the LICENSE file.
|
2008-12-17 15:59:43 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef SkGradientShader_DEFINED
|
|
|
|
#define SkGradientShader_DEFINED
|
|
|
|
|
|
|
|
#include "SkShader.h"
|
|
|
|
|
|
|
|
/** \class SkGradientShader
|
|
|
|
|
|
|
|
SkGradientShader hosts factories for creating subclasses of SkShader that
|
|
|
|
render linear and radial gradients.
|
|
|
|
*/
|
2011-03-15 21:27:08 +00:00
|
|
|
class SK_API SkGradientShader {
|
2008-12-17 15:59:43 +00:00
|
|
|
public:
|
2013-05-24 14:58:44 +00:00
|
|
|
enum Flags {
|
|
|
|
/** By default gradients will interpolate their colors in unpremul space
|
|
|
|
* and then premultiply each of the results. By setting this flag, the
|
|
|
|
* gradients will premultiply their colors first, and then interpolate
|
|
|
|
* between them.
|
|
|
|
*/
|
|
|
|
kInterpolateColorsInPremul_Flag = 1 << 0,
|
|
|
|
};
|
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Returns a shader that generates a linear gradient between the two
|
|
|
|
specified points.
|
|
|
|
<p />
|
|
|
|
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.
|
|
|
|
@param pts The start and end points for the gradient.
|
|
|
|
@param colors The array[count] of colors, to be distributed between the two points
|
|
|
|
@param 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.
|
2012-08-23 18:09:54 +00:00
|
|
|
@param count Must be >=2. The number of colors (and pos if not NULL) entries.
|
2008-12-17 15:59:43 +00:00
|
|
|
@param mode The tiling mode
|
|
|
|
*/
|
2013-05-24 14:58:44 +00:00
|
|
|
static SkShader* CreateLinear(const SkPoint pts[2],
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
|
|
|
SkShader::TileMode mode,
|
2014-05-22 12:27:41 +00:00
|
|
|
uint32_t flags, const SkMatrix* localMatrix);
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2014-05-19 15:46:09 +00:00
|
|
|
static SkShader* CreateLinear(const SkPoint pts[2],
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
2014-05-22 12:27:41 +00:00
|
|
|
SkShader::TileMode mode) {
|
|
|
|
return CreateLinear(pts, colors, pos, count, mode, 0, NULL);
|
2014-05-19 15:46:09 +00:00
|
|
|
}
|
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Returns a shader that generates a radial gradient given the center and radius.
|
|
|
|
<p />
|
|
|
|
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.
|
|
|
|
@param center The center of the circle for this gradient
|
|
|
|
@param radius Must be positive. The radius of the circle for this gradient
|
|
|
|
@param colors The array[count] of colors, to be distributed between the center and edge of the circle
|
|
|
|
@param 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.
|
|
|
|
@param count Must be >= 2. The number of colors (and pos if not NULL) entries
|
|
|
|
@param mode The tiling mode
|
|
|
|
*/
|
2013-05-24 14:58:44 +00:00
|
|
|
static SkShader* CreateRadial(const SkPoint& center, SkScalar radius,
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
|
|
|
SkShader::TileMode mode,
|
2014-05-22 12:27:41 +00:00
|
|
|
uint32_t flags, const SkMatrix* localMatrix);
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2014-05-19 15:46:09 +00:00
|
|
|
static SkShader* CreateRadial(const SkPoint& center, SkScalar radius,
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
2014-05-22 12:27:41 +00:00
|
|
|
SkShader::TileMode mode) {
|
|
|
|
return CreateRadial(center, radius, colors, pos, count, mode, 0, NULL);
|
2014-05-19 15:46:09 +00:00
|
|
|
}
|
|
|
|
|
2012-06-06 20:31:56 +00:00
|
|
|
/**
|
|
|
|
* Returns a shader that generates a conical gradient given two circles, or
|
|
|
|
* returns NULL if the inputs are invalid. The gradient interprets the
|
|
|
|
* two circles according to the following HTML spec.
|
|
|
|
* http://dev.w3.org/html5/2dcontext/#dom-context-2d-createradialgradient
|
|
|
|
*/
|
2014-05-22 12:27:41 +00:00
|
|
|
static SkShader* CreateTwoPointConical(const SkPoint& start, SkScalar startRadius,
|
|
|
|
const SkPoint& end, SkScalar endRadius,
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
2013-05-24 14:58:44 +00:00
|
|
|
SkShader::TileMode mode,
|
2014-05-22 12:27:41 +00:00
|
|
|
uint32_t flags, const SkMatrix* localMatrix);
|
|
|
|
|
|
|
|
static SkShader* CreateTwoPointConical(const SkPoint& start, SkScalar startRadius,
|
|
|
|
const SkPoint& end, SkScalar endRadius,
|
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
|
|
|
SkShader::TileMode mode) {
|
2014-05-19 15:46:09 +00:00
|
|
|
return CreateTwoPointConical(start, startRadius, end, endRadius, colors, pos, count, mode,
|
2014-05-22 12:27:41 +00:00
|
|
|
0, NULL);
|
2014-05-19 15:46:09 +00:00
|
|
|
}
|
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Returns a shader that generates a sweep gradient given a center.
|
|
|
|
<p />
|
2009-09-22 17:25:29 +00:00
|
|
|
CreateSweep returns a shader with a reference count of 1.
|
2008-12-17 15:59:43 +00:00
|
|
|
The caller should decrement the shader's reference count when done with the shader.
|
|
|
|
It is an error for colorCount to be < 2.
|
|
|
|
@param cx The X coordinate of the center of the sweep
|
|
|
|
@param cx The Y coordinate of the center of the sweep
|
|
|
|
@param colors The array[count] of colors, to be distributed around the center.
|
|
|
|
@param 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.
|
|
|
|
@param count Must be >= 2. The number of colors (and pos if not NULL) entries
|
|
|
|
*/
|
|
|
|
static SkShader* CreateSweep(SkScalar cx, SkScalar cy,
|
2014-05-22 12:27:41 +00:00
|
|
|
const SkColor colors[], const SkScalar pos[], int count,
|
|
|
|
uint32_t flags, const SkMatrix* localMatrix);
|
2011-12-15 14:16:43 +00:00
|
|
|
|
2014-05-19 15:46:09 +00:00
|
|
|
static SkShader* CreateSweep(SkScalar cx, SkScalar cy,
|
2014-05-22 12:27:41 +00:00
|
|
|
const SkColor colors[], const SkScalar pos[], int count) {
|
|
|
|
return CreateSweep(cx, cy, colors, pos, count, 0, NULL);
|
2014-05-19 15:46:09 +00:00
|
|
|
}
|
|
|
|
|
2012-03-23 19:00:34 +00:00
|
|
|
SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP()
|
2008-12-17 15:59:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|