SkBlurMaskFilter.h revision 336b4da6b0d20f27f9980b03415354a2f0698e18 
1/*
2 * Copyright 2006 The Android Open Source Project
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8#ifndef SkBlurMaskFilter_DEFINED
9#define SkBlurMaskFilter_DEFINED
10
11// we include this since our callers will need to at least be able to ref/unref
12#include "SkMaskFilter.h"
13#include "SkScalar.h"
14
15class SK_API SkBlurMaskFilter {
16public:
17    enum BlurStyle {
18        kNormal_BlurStyle,  //!< fuzzy inside and outside
19        kSolid_BlurStyle,   //!< solid inside, fuzzy outside
20        kOuter_BlurStyle,   //!< nothing inside, fuzzy outside
21        kInner_BlurStyle,   //!< fuzzy inside, nothing outside
22
23        kBlurStyleCount
24    };
25
26    enum BlurFlags {
27        kNone_BlurFlag = 0x00,
28        /** The blur layer's radius is not affected by transforms */
29        kIgnoreTransform_BlurFlag   = 0x01,
30        /** Use a smother, higher qulity blur algorithm */
31        kHighQuality_BlurFlag       = 0x02,
32        /** Do faster blurs by rounding the radius to a set of sub-integer values */
33        kCoarseRadius_BlurFlag      = 0x04,
34        /** mask for all blur flags */
35        kAll_BlurFlag = 0x07
36    };
37
38    /** Create a blur maskfilter.
39        @param radius   The radius to extend the blur from the original mask. Must be > 0.
40        @param style    The BlurStyle to use
41        @param flags    Flags to use - defaults to none
42        @return The new blur maskfilter
43    */
44    static SkMaskFilter* Create(SkScalar radius, BlurStyle style,
45                                uint32_t flags = kNone_BlurFlag);
46
47    /** Create an emboss maskfilter
48        @param direction    array of 3 scalars [x, y, z] specifying the direction of the light source
49        @param ambient      0...1 amount of ambient light
50        @param specular     coefficient for specular highlights (e.g. 8)
51        @param blurRadius   amount to blur before applying lighting (e.g. 3)
52        @return the emboss maskfilter
53    */
54    static SkMaskFilter* CreateEmboss(  const SkScalar direction[3],
55                                        SkScalar ambient, SkScalar specular,
56                                        SkScalar blurRadius);
57
58    SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP()
59private:
60    SkBlurMaskFilter(); // can't be instantiated
61};
62
63#endif
64