bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Google Inc. |
| 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 GrTextureMaker_DEFINED |
| 9 | #define GrTextureMaker_DEFINED |
| 10 | |
| 11 | #include "GrTextureParams.h" |
| 12 | #include "GrResourceKey.h" |
bsalomon | c55271f | 2015-11-09 11:55:57 -0800 | [diff] [blame] | 13 | #include "GrTexture.h" |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 14 | #include "SkTLazy.h" |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 15 | |
| 16 | class GrContext; |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 17 | class GrTextureParams; |
| 18 | class GrUniqueKey; |
| 19 | class SkBitmap; |
| 20 | |
| 21 | /** |
| 22 | * Different GPUs and API extensions have different requirements with respect to what texture |
| 23 | * sampling parameters may be used with textures of various types. This class facilitates making |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 24 | * texture compatible with a given GrTextureParams. There are two immediate subclasses defined |
| 25 | * below. One is a base class for sources that are inherently texture-backed (e.g. a texture-backed |
| 26 | * SkImage). It supports subsetting the original texture. The other is for use cases where the |
| 27 | * source can generate a texture that represents some content (e.g. cpu pixels, SkPicture, ...). |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 28 | */ |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 29 | class GrTextureProducer : public SkNoncopyable { |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 30 | public: |
| 31 | struct CopyParams { |
| 32 | GrTextureParams::FilterMode fFilter; |
| 33 | int fWidth; |
| 34 | int fHeight; |
| 35 | }; |
| 36 | |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 37 | enum FilterConstraint { |
| 38 | kYes_FilterConstraint, |
| 39 | kNo_FilterConstraint, |
| 40 | }; |
| 41 | |
| 42 | /** |
| 43 | * Helper for creating a fragment processor to sample the texture with a given filtering mode. |
| 44 | * It attempts to avoid making texture copies or using domains whenever possible. |
| 45 | * |
| 46 | * @param textureMatrix Matrix used to access the texture. It is applied to |
| 47 | * the local coords. The post-transformed coords should |
| 48 | * be in texel units (rather than normalized) with |
| 49 | * respect to this Producer's bounds (width()/height()). |
| 50 | * @param constraintRect A rect that represents the area of the texture to be |
| 51 | * sampled. It must be contained in the Producer's bounds |
| 52 | * as defined by width()/height(). |
| 53 | * @param filterConstriant Indicates whether filtering is limited to |
| 54 | * constraintRect. |
| 55 | * @param coordsLimitedToConstraintRect Is it known that textureMatrix*localCoords is bound |
| 56 | * by the portion of the texture indicated by |
| 57 | * constraintRect (without consideration of filter |
| 58 | * width, just the raw coords). |
| 59 | * @param filterOrNullForBicubic If non-null indicates the filter mode. If null means |
| 60 | * use bicubic filtering. |
| 61 | **/ |
| 62 | virtual const GrFragmentProcessor* createFragmentProcessor( |
| 63 | const SkMatrix& textureMatrix, |
| 64 | const SkRect& constraintRect, |
| 65 | FilterConstraint filterConstraint, |
| 66 | bool coordsLimitedToConstraintRect, |
| 67 | const GrTextureParams::FilterMode* filterOrNullForBicubic) = 0; |
| 68 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 69 | virtual ~GrTextureProducer() {} |
| 70 | |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 71 | int width() const { return fWidth; } |
| 72 | int height() const { return fHeight; } |
| 73 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 74 | protected: |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 75 | GrTextureProducer(int width, int height) : fWidth(width), fHeight(height) {} |
| 76 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 77 | /** Helper for creating a key for a copy from an original key. */ |
| 78 | static void MakeCopyKeyFromOrigKey(const GrUniqueKey& origKey, |
| 79 | const CopyParams& copyParams, |
| 80 | GrUniqueKey* copyKey) { |
| 81 | SkASSERT(!copyKey->isValid()); |
| 82 | if (origKey.isValid()) { |
| 83 | static const GrUniqueKey::Domain kDomain = GrUniqueKey::GenerateDomain(); |
| 84 | GrUniqueKey::Builder builder(copyKey, origKey, kDomain, 3); |
| 85 | builder[0] = copyParams.fFilter; |
| 86 | builder[1] = copyParams.fWidth; |
| 87 | builder[2] = copyParams.fHeight; |
| 88 | } |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * If we need to make a copy in order to be compatible with GrTextureParams producer is asked to |
| 93 | * return a key that identifies its original content + the CopyParms parameter. If the producer |
| 94 | * does not want to cache the stretched version (e.g. the producer is volatile), this should |
| 95 | * simply return without initializing the copyKey. |
| 96 | */ |
| 97 | virtual void makeCopyKey(const CopyParams&, GrUniqueKey* copyKey) = 0; |
| 98 | |
| 99 | /** |
| 100 | * If a stretched version of the texture is generated, it may be cached (assuming that |
| 101 | * makeCopyKey() returns true). In that case, the maker is notified in case it |
| 102 | * wants to note that for when the maker is destroyed. |
| 103 | */ |
| 104 | virtual void didCacheCopy(const GrUniqueKey& copyKey) = 0; |
| 105 | |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 106 | private: |
| 107 | const int fWidth; |
| 108 | const int fHeight; |
| 109 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 110 | typedef SkNoncopyable INHERITED; |
| 111 | }; |
| 112 | |
bsalomon | c75be34 | 2015-10-29 12:34:31 -0700 | [diff] [blame] | 113 | /** |
| 114 | * Base class for sources that start out as textures. Optionally allows for a content area subrect. |
| 115 | * The intent is not to use content area for subrect rendering. Rather, the pixels outside the |
| 116 | * content area have undefined values and shouldn't be read *regardless* of filtering mode or |
| 117 | * the SkCanvas::SrcRectConstraint used for subrect draws. |
| 118 | */ |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 119 | class GrTextureAdjuster : public GrTextureProducer { |
| 120 | public: |
| 121 | /** Makes the subset of the texture safe to use with the given texture parameters. |
| 122 | outOffset will be the top-left corner of the subset if a copy is not made. Otherwise, |
| 123 | the copy will be tight to the contents and outOffset will be (0, 0). If the copy's size |
| 124 | does not match subset's dimensions then the contents are scaled to fit the copy.*/ |
| 125 | GrTexture* refTextureSafeForParams(const GrTextureParams&, SkIPoint* outOffset); |
| 126 | |
bsalomon | c55271f | 2015-11-09 11:55:57 -0800 | [diff] [blame] | 127 | const GrFragmentProcessor* createFragmentProcessor( |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 128 | const SkMatrix& textureMatrix, |
| 129 | const SkRect& constraintRect, |
| 130 | FilterConstraint, |
| 131 | bool coordsLimitedToConstraintRect, |
| 132 | const GrTextureParams::FilterMode* filterOrNullForBicubic) override; |
bsalomon | c55271f | 2015-11-09 11:55:57 -0800 | [diff] [blame] | 133 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 134 | protected: |
bsalomon | c75be34 | 2015-10-29 12:34:31 -0700 | [diff] [blame] | 135 | /** The whole texture is content. */ |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 136 | explicit GrTextureAdjuster(GrTexture* original) |
| 137 | : INHERITED(original->width(), original->height()) |
| 138 | , fOriginal(original) {} |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 139 | |
bsalomon | c75be34 | 2015-10-29 12:34:31 -0700 | [diff] [blame] | 140 | GrTextureAdjuster(GrTexture* original, const SkIRect& contentArea); |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 141 | |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 142 | GrTexture* originalTexture() const { return fOriginal; } |
| 143 | |
bsalomon | c75be34 | 2015-10-29 12:34:31 -0700 | [diff] [blame] | 144 | /** Returns the content area or null for the whole original texture */ |
bsalomon | c55271f | 2015-11-09 11:55:57 -0800 | [diff] [blame] | 145 | const SkIRect* contentAreaOrNull() { return fContentArea.getMaybeNull(); } |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 146 | |
| 147 | private: |
bsalomon | c75be34 | 2015-10-29 12:34:31 -0700 | [diff] [blame] | 148 | SkTLazy<SkIRect> fContentArea; |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 149 | GrTexture* fOriginal; |
| 150 | |
| 151 | typedef GrTextureProducer INHERITED; |
| 152 | }; |
| 153 | |
mtklein | 6459352 | 2015-11-12 10:41:05 -0800 | [diff] [blame] | 154 | /** |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 155 | * Base class for sources that start out as something other than a texture (encoded image, |
| 156 | * picture, ...). |
| 157 | */ |
| 158 | class GrTextureMaker : public GrTextureProducer { |
| 159 | public: |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 160 | /** Returns a texture that is safe for use with the params. If the size of the returned texture |
| 161 | does not match width()/height() then the contents of the original must be scaled to fit |
| 162 | the texture. */ |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 163 | GrTexture* refTextureForParams(const GrTextureParams&); |
| 164 | |
| 165 | const GrFragmentProcessor* createFragmentProcessor( |
| 166 | const SkMatrix& textureMatrix, |
| 167 | const SkRect& constraintRect, |
| 168 | FilterConstraint filterConstraint, |
| 169 | bool coordsLimitedToConstraintRect, |
| 170 | const GrTextureParams::FilterMode* filterOrNullForBicubic) override; |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 171 | |
| 172 | protected: |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 173 | GrTextureMaker(GrContext* context, int width, int height) |
| 174 | : INHERITED(width, height) |
| 175 | , fContext(context) {} |
bsalomon | 3aa5fce | 2015-11-12 09:59:44 -0800 | [diff] [blame] | 176 | |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 177 | /** |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 178 | * Return the maker's "original" texture. It is the responsibility of the maker to handle any |
| 179 | * caching of the original if desired. |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 180 | */ |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 181 | virtual GrTexture* refOriginalTexture() = 0; |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 182 | |
| 183 | /** |
| 184 | * Return a new (uncached) texture that is the stretch of the maker's original. |
| 185 | * |
| 186 | * The base-class handles general logic for this, and only needs access to the following |
bsalomon | 100b8f8 | 2015-10-28 08:37:44 -0700 | [diff] [blame] | 187 | * method: |
| 188 | * - refOriginalTexture() |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 189 | * |
| 190 | * Subclass may override this if they can handle creating the texture more directly than |
| 191 | * by copying. |
| 192 | */ |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 193 | virtual GrTexture* generateTextureForParams(const CopyParams&); |
| 194 | |
| 195 | GrContext* context() const { return fContext; } |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 196 | |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 197 | private: |
bsalomon | b1b0199 | 2015-11-18 10:56:08 -0800 | [diff] [blame] | 198 | GrContext* fContext; |
| 199 | |
bsalomon | 89fe56b | 2015-10-29 10:49:28 -0700 | [diff] [blame] | 200 | typedef GrTextureProducer INHERITED; |
bsalomon | 045802d | 2015-10-20 07:58:01 -0700 | [diff] [blame] | 201 | }; |
| 202 | |
| 203 | #endif |