Home | History | Annotate | Download | only in effects
      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 
     15 class SK_API SkBlurMaskFilter {
     16 public:
     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         /** mask for all blur flags */
     33         kAll_BlurFlag = 0x03
     34     };
     35 
     36     /** Create a blur maskfilter.
     37         @param radius   The radius to extend the blur from the original mask. Must be > 0.
     38         @param style    The BlurStyle to use
     39         @param flags    Flags to use - defaults to none
     40         @return The new blur maskfilter
     41     */
     42     static SkMaskFilter* Create(SkScalar radius, BlurStyle style,
     43                                 uint32_t flags = kNone_BlurFlag);
     44 
     45     /** Create an emboss maskfilter
     46         @param direction    array of 3 scalars [x, y, z] specifying the direction of the light source
     47         @param ambient      0...1 amount of ambient light
     48         @param specular     coefficient for specular highlights (e.g. 8)
     49         @param blurRadius   amount to blur before applying lighting (e.g. 3)
     50         @return the emboss maskfilter
     51     */
     52     static SkMaskFilter* CreateEmboss(  const SkScalar direction[3],
     53                                         SkScalar ambient, SkScalar specular,
     54                                         SkScalar blurRadius);
     55 
     56     SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP()
     57 private:
     58     SkBlurMaskFilter(); // can't be instantiated
     59 };
     60 
     61 #endif
     62