mirror of https://github.com/axmolengine/axmol.git
313 lines
13 KiB
C++
313 lines
13 KiB
C++
/*
|
|
* Copyright (C) 2006 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef SkShader_DEFINED
|
|
#define SkShader_DEFINED
|
|
|
|
#include "SkBitmap.h"
|
|
#include "SkFlattenable.h"
|
|
#include "SkMask.h"
|
|
#include "SkMatrix.h"
|
|
#include "SkPaint.h"
|
|
|
|
class SkPath;
|
|
|
|
/** \class SkShader
|
|
*
|
|
* SkShader is the based class for objects that return horizontal spans of
|
|
* colors during drawing. A subclass of SkShader is installed in a SkPaint
|
|
* calling paint.setShader(shader). After that any object (other than a bitmap)
|
|
* that is drawn with that paint will get its color(s) from the shader.
|
|
*/
|
|
class SK_API SkShader : public SkFlattenable {
|
|
public:
|
|
SkShader();
|
|
virtual ~SkShader();
|
|
|
|
/**
|
|
* Return true if the shader has a non-identity local matrix.
|
|
* @param localM Optional: If not null, return the shader's local matrix
|
|
* @return true if the shader has a non-identity local matrix.
|
|
*/
|
|
bool getLocalMatrix(SkMatrix* localM) const;
|
|
|
|
/**
|
|
* Set the shader's local matrix.
|
|
* @param localM The shader's new local matrix.
|
|
*/
|
|
void setLocalMatrix(const SkMatrix& localM);
|
|
|
|
/**
|
|
* Reset the shader's local matrix to identity.
|
|
*/
|
|
void resetLocalMatrix();
|
|
|
|
enum TileMode {
|
|
kClamp_TileMode, //!< replicate the edge color if the shader draws outside of its original bounds
|
|
kRepeat_TileMode, //!< repeat the shader's image horizontally and vertically
|
|
kMirror_TileMode, //!< repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam
|
|
|
|
kTileModeCount
|
|
};
|
|
|
|
// override these in your subclass
|
|
|
|
enum Flags {
|
|
//!< set if all of the colors will be opaque
|
|
kOpaqueAlpha_Flag = 0x01,
|
|
|
|
//! set if this shader's shadeSpan16() method can be called
|
|
kHasSpan16_Flag = 0x02,
|
|
|
|
/** Set this bit if the shader's native data type is instrinsically 16
|
|
bit, meaning that calling the 32bit shadeSpan() entry point will
|
|
mean the the impl has to up-sample 16bit data into 32bit. Used as a
|
|
a means of clearing a dither request if the it will have no effect
|
|
*/
|
|
kIntrinsicly16_Flag = 0x04,
|
|
|
|
/** set (after setContext) if the spans only vary in X (const in Y).
|
|
e.g. an Nx1 bitmap that is being tiled in Y, or a linear-gradient
|
|
that varies from left-to-right. This flag specifies this for
|
|
shadeSpan().
|
|
*/
|
|
kConstInY32_Flag = 0x08,
|
|
|
|
/** same as kConstInY32_Flag, but is set if this is true for shadeSpan16
|
|
which may not always be the case, since shadeSpan16 may be
|
|
predithered, which would mean it was not const in Y, even though
|
|
the 32bit shadeSpan() would be const.
|
|
*/
|
|
kConstInY16_Flag = 0x10
|
|
};
|
|
|
|
/**
|
|
* Called sometimes before drawing with this shader. Return the type of
|
|
* alpha your shader will return. The default implementation returns 0.
|
|
* Your subclass should override if it can (even sometimes) report a
|
|
* non-zero value, since that will enable various blitters to perform
|
|
* faster.
|
|
*/
|
|
virtual uint32_t getFlags() { return 0; }
|
|
|
|
/**
|
|
* Return the alpha associated with the data returned by shadeSpan16(). If
|
|
* kHasSpan16_Flag is not set, this value is meaningless.
|
|
*/
|
|
virtual uint8_t getSpan16Alpha() const { return fPaintAlpha; }
|
|
|
|
/**
|
|
* Called once before drawing, with the current paint and device matrix.
|
|
* Return true if your shader supports these parameters, or false if not.
|
|
* If false is returned, nothing will be drawn.
|
|
*/
|
|
virtual bool setContext(const SkBitmap& device, const SkPaint& paint,
|
|
const SkMatrix& matrix);
|
|
|
|
/**
|
|
* Called for each span of the object being drawn. Your subclass should
|
|
* set the appropriate colors (with premultiplied alpha) that correspond
|
|
* to the specified device coordinates.
|
|
*/
|
|
virtual void shadeSpan(int x, int y, SkPMColor[], int count) = 0;
|
|
|
|
/**
|
|
* Called only for 16bit devices when getFlags() returns
|
|
* kOpaqueAlphaFlag | kHasSpan16_Flag
|
|
*/
|
|
virtual void shadeSpan16(int x, int y, uint16_t[], int count);
|
|
|
|
/**
|
|
* Similar to shadeSpan, but only returns the alpha-channel for a span.
|
|
* The default implementation calls shadeSpan() and then extracts the alpha
|
|
* values from the returned colors.
|
|
*/
|
|
virtual void shadeSpanAlpha(int x, int y, uint8_t alpha[], int count);
|
|
|
|
/**
|
|
* Helper function that returns true if this shader's shadeSpan16() method
|
|
* can be called.
|
|
*/
|
|
bool canCallShadeSpan16() {
|
|
return SkShader::CanCallShadeSpan16(this->getFlags());
|
|
}
|
|
|
|
/**
|
|
* Helper to check the flags to know if it is legal to call shadeSpan16()
|
|
*/
|
|
static bool CanCallShadeSpan16(uint32_t flags) {
|
|
return (flags & kHasSpan16_Flag) != 0;
|
|
}
|
|
|
|
/**
|
|
* Called before a session using the shader begins. Some shaders override
|
|
* this to defer some of their work (like calling bitmap.lockPixels()).
|
|
* Must be balanced by a call to endSession.
|
|
*/
|
|
virtual void beginSession();
|
|
virtual void endSession();
|
|
|
|
/**
|
|
Gives method bitmap should be read to implement a shader.
|
|
Also determines number and interpretation of "extra" parameters returned
|
|
by asABitmap
|
|
*/
|
|
enum BitmapType {
|
|
kNone_BitmapType, //<! Shader is not represented as a bitmap
|
|
kDefault_BitmapType,//<! Access bitmap using local coords transformed
|
|
// by matrix. No extras
|
|
kRadial_BitmapType, //<! Access bitmap by transforming local coordinates
|
|
// by the matrix and taking the distance of result
|
|
// from (0,0) as bitmap column. Bitmap is 1 pixel
|
|
// tall. No extras
|
|
kSweep_BitmapType, //<! Access bitmap by transforming local coordinates
|
|
// by the matrix and taking the angle of result
|
|
// to (0,0) as bitmap x coord, where angle = 0 is
|
|
// bitmap left edge of bitmap = 2pi is the
|
|
// right edge. Bitmap is 1 pixel tall. No extras
|
|
kTwoPointRadial_BitmapType,
|
|
//<! Matrix transforms to space where (0,0) is
|
|
// the center of the starting circle. The second
|
|
// circle will be centered (x, 0) where x may be
|
|
// 0. The post-matrix space is normalized such
|
|
// that 1 is the second radius - first radius.
|
|
// Three extra parameters are returned:
|
|
// 0: x-offset of second circle center
|
|
// to first.
|
|
// 1: radius of first circle in post-matrix
|
|
// space
|
|
// 2: the second radius minus the first radius
|
|
// in pre-transformed space.
|
|
|
|
kLast_BitmapType = kTwoPointRadial_BitmapType
|
|
};
|
|
/** Optional methods for shaders that can pretend to be a bitmap/texture
|
|
to play along with opengl. Default just returns kNone_BitmapType and
|
|
ignores the out parameters.
|
|
|
|
@param outTexture if non-NULL will be the bitmap representing the shader
|
|
after return.
|
|
@param outMatrix if non-NULL will be the matrix to apply to vertices
|
|
to access the bitmap after return.
|
|
@param xy if non-NULL will be the tile modes that should be
|
|
used to access the bitmap after return.
|
|
@param twoPointRadialParams Two extra return values needed for two point
|
|
radial bitmaps. The first is the x-offset of
|
|
the second point and the second is the radius
|
|
about the first point.
|
|
*/
|
|
virtual BitmapType asABitmap(SkBitmap* outTexture, SkMatrix* outMatrix,
|
|
TileMode xy[2], SkScalar* twoPointRadialParams) const;
|
|
|
|
/**
|
|
* If the shader subclass can be represented as a gradient, asAGradient
|
|
* returns the matching GradientType enum (or kNone_GradientType if it
|
|
* cannot). Also, if info is not null, asAGradient populates info with
|
|
* the relevant (see below) parameters for the gradient. fColorCount
|
|
* is both an input and output parameter. On input, it indicates how
|
|
* many entries in fColors and fColorOffsets can be used, if they are
|
|
* non-NULL. After asAGradient has run, fColorCount indicates how
|
|
* many color-offset pairs there are in the gradient. If there is
|
|
* insufficient space to store all of the color-offset pairs, fColors
|
|
* and fColorOffsets will not be altered. fColorOffsets specifies
|
|
* where on the range of 0 to 1 to transition to the given color.
|
|
* The meaning of fPoint and fRadius is dependant on the type of gradient.
|
|
*
|
|
* None:
|
|
* info is ignored.
|
|
* Color:
|
|
* fColorOffsets[0] is meaningless.
|
|
* Linear:
|
|
* fPoint[0] and fPoint[1] are the end-points of the gradient
|
|
* Radial:
|
|
* fPoint[0] and fRadius[0] are the center and radius
|
|
* Radial2:
|
|
* fPoint[0] and fRadius[0] are the center and radius of the 1st circle
|
|
* fPoint[1] and fRadius[1] are the center and radius of the 2nd circle
|
|
* Sweep:
|
|
* fPoint[0] is the center of the sweep.
|
|
*/
|
|
|
|
enum GradientType {
|
|
kNone_GradientType,
|
|
kColor_GradientType,
|
|
kLinear_GradientType,
|
|
kRadial_GradientType,
|
|
kRadial2_GradientType,
|
|
kSweep_GradientType,
|
|
kLast_GradientType = kSweep_GradientType
|
|
};
|
|
|
|
struct GradientInfo {
|
|
int fColorCount; //!< In-out parameter, specifies passed size
|
|
// of fColors/fColorOffsets on input, and
|
|
// actual number of colors/offsets on
|
|
// output.
|
|
SkColor* fColors; //!< The colors in the gradient.
|
|
SkScalar* fColorOffsets; //!< The unit offset for color transitions.
|
|
SkPoint fPoint[2]; //!< Type specific, see above.
|
|
SkScalar fRadius[2]; //!< Type specific, see above.
|
|
TileMode fTileMode; //!< The tile mode used.
|
|
};
|
|
|
|
virtual GradientType asAGradient(GradientInfo* info) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////
|
|
// Factory methods for stock shaders
|
|
|
|
/** Call this to create a new shader that will draw with the specified bitmap.
|
|
@param src The bitmap to use inside the shader
|
|
@param tmx The tiling mode to use when sampling the bitmap in the x-direction.
|
|
@param tmy The tiling mode to use when sampling the bitmap in the y-direction.
|
|
@return Returns a new shader object. Note: this function never returns null.
|
|
*/
|
|
static SkShader* CreateBitmapShader(const SkBitmap& src,
|
|
TileMode tmx, TileMode tmy);
|
|
|
|
virtual void flatten(SkFlattenableWriteBuffer& );
|
|
protected:
|
|
enum MatrixClass {
|
|
kLinear_MatrixClass, // no perspective
|
|
kFixedStepInX_MatrixClass, // fast perspective, need to call fixedStepInX() each scanline
|
|
kPerspective_MatrixClass // slow perspective, need to mappoints each pixel
|
|
};
|
|
static MatrixClass ComputeMatrixClass(const SkMatrix&);
|
|
|
|
// These can be called by your subclass after setContext() has been called
|
|
uint8_t getPaintAlpha() const { return fPaintAlpha; }
|
|
SkBitmap::Config getDeviceConfig() const { return (SkBitmap::Config)fDeviceConfig; }
|
|
const SkMatrix& getTotalInverse() const { return fTotalInverse; }
|
|
MatrixClass getInverseClass() const { return (MatrixClass)fTotalInverseClass; }
|
|
|
|
SkShader(SkFlattenableReadBuffer& );
|
|
private:
|
|
SkMatrix* fLocalMatrix;
|
|
SkMatrix fTotalInverse;
|
|
uint8_t fPaintAlpha;
|
|
uint8_t fDeviceConfig;
|
|
uint8_t fTotalInverseClass;
|
|
SkDEBUGCODE(SkBool8 fInSession;)
|
|
|
|
static SkShader* CreateBitmapShader(const SkBitmap& src,
|
|
TileMode, TileMode,
|
|
void* storage, size_t storageSize);
|
|
friend class SkAutoBitmapShaderInstall;
|
|
typedef SkFlattenable INHERITED;
|
|
};
|
|
|
|
#endif
|
|
|