epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 2 | /* |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 3 | * Copyright 2011 Google Inc. |
| 4 | * |
| 5 | * Use of this source code is governed by a BSD-style license that can be |
| 6 | * found in the LICENSE file. |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 9 | #ifndef GrTexture_DEFINED |
| 10 | #define GrTexture_DEFINED |
| 11 | |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 12 | #include "GrSurface.h" |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 13 | |
bsalomon@google.com | aa5b673 | 2011-07-29 15:13:20 +0000 | [diff] [blame] | 14 | class GrRenderTarget; |
robertphillips@google.com | a1e5795 | 2012-06-04 20:05:28 +0000 | [diff] [blame] | 15 | class GrResourceKey; |
bsalomon@google.com | b867099 | 2012-07-25 21:27:09 +0000 | [diff] [blame^] | 16 | class GrTextureParams; |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 17 | |
robertphillips@google.com | 75b3c96 | 2012-06-07 12:08:45 +0000 | [diff] [blame] | 18 | /* |
| 19 | * All uncached textures should have this value as their fClientCacheID |
| 20 | */ |
| 21 | static const uint64_t kUncached_CacheID = 0xAAAAAAAA; |
| 22 | |
| 23 | /* |
| 24 | * Scratch textures should all have this value as their fClientCacheID |
| 25 | */ |
| 26 | static const uint64_t kScratch_CacheID = 0xBBBBBBBB; |
| 27 | |
| 28 | |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 29 | class GrTexture : public GrSurface { |
bsalomon@google.com | 8fe7247 | 2011-03-30 21:26:44 +0000 | [diff] [blame] | 30 | |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 31 | public: |
robertphillips@google.com | 4d73ac2 | 2012-06-13 18:54:08 +0000 | [diff] [blame] | 32 | SK_DECLARE_INST_COUNT(GrTexture) |
| 33 | |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 34 | // from GrResource |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 35 | /** |
robertphillips@google.com | 15c0fea | 2012-06-22 12:41:43 +0000 | [diff] [blame] | 36 | * Informational texture flags |
| 37 | */ |
| 38 | enum FlagBits { |
| 39 | kFirstBit = (kLastPublic_GrTextureFlagBit << 1), |
| 40 | |
| 41 | /** |
| 42 | * This texture should be returned to the texture cache when |
| 43 | * it is no longer reffed |
| 44 | */ |
| 45 | kReturnToCache_FlagBit = kFirstBit, |
| 46 | }; |
| 47 | |
| 48 | void setFlag(GrTextureFlags flags) { |
| 49 | fDesc.fFlags = fDesc.fFlags | flags; |
| 50 | } |
| 51 | void resetFlag(GrTextureFlags flags) { |
| 52 | fDesc.fFlags = fDesc.fFlags & ~flags; |
| 53 | } |
| 54 | bool isSetFlag(GrTextureFlags flags) const { |
| 55 | return 0 != (fDesc.fFlags & flags); |
| 56 | } |
| 57 | |
| 58 | /** |
bsalomon@google.com | c6cf723 | 2011-02-17 16:43:10 +0000 | [diff] [blame] | 59 | * Approximate number of bytes used by the texture |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 60 | */ |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 61 | virtual size_t sizeInBytes() const SK_OVERRIDE { |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 62 | return (size_t) fDesc.fWidth * |
| 63 | fDesc.fHeight * |
| 64 | GrBytesPerPixel(fDesc.fConfig); |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 65 | } |
| 66 | |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 67 | // from GrSurface |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 68 | /** |
bsalomon@google.com | 6f37951 | 2011-11-16 20:36:03 +0000 | [diff] [blame] | 69 | * Read a rectangle of pixels from the texture. |
bsalomon@google.com | 669fdc4 | 2011-04-05 17:08:27 +0000 | [diff] [blame] | 70 | * @param left left edge of the rectangle to read (inclusive) |
| 71 | * @param top top edge of the rectangle to read (inclusive) |
| 72 | * @param width width of rectangle to read in pixels. |
| 73 | * @param height height of rectangle to read in pixels. |
| 74 | * @param config the pixel config of the destination buffer |
| 75 | * @param buffer memory to read the rectangle into. |
bsalomon@google.com | 6f37951 | 2011-11-16 20:36:03 +0000 | [diff] [blame] | 76 | * @param rowBytes number of bytes bewtween consecutive rows. Zero |
| 77 | * means rows are tightly packed. |
bsalomon@google.com | 669fdc4 | 2011-04-05 17:08:27 +0000 | [diff] [blame] | 78 | * |
| 79 | * @return true if the read succeeded, false if not. The read can fail |
| 80 | * because of a unsupported pixel config. |
| 81 | */ |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 82 | virtual bool readPixels(int left, int top, int width, int height, |
| 83 | GrPixelConfig config, void* buffer, |
| 84 | size_t rowBytes) SK_OVERRIDE; |
bsalomon@google.com | 6f37951 | 2011-11-16 20:36:03 +0000 | [diff] [blame] | 85 | |
| 86 | /** |
| 87 | * Writes a rectangle of pixels to the texture. |
| 88 | * @param left left edge of the rectangle to write (inclusive) |
| 89 | * @param top top edge of the rectangle to write (inclusive) |
| 90 | * @param width width of rectangle to write in pixels. |
| 91 | * @param height height of rectangle to write in pixels. |
| 92 | * @param config the pixel config of the source buffer |
| 93 | * @param buffer memory to read pixels from |
robertphillips@google.com | 09042b8 | 2012-04-06 20:01:46 +0000 | [diff] [blame] | 94 | * @param rowBytes number of bytes between consecutive rows. Zero |
bsalomon@google.com | 6f37951 | 2011-11-16 20:36:03 +0000 | [diff] [blame] | 95 | * means rows are tightly packed. |
| 96 | */ |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 97 | virtual void writePixels(int left, int top, int width, int height, |
| 98 | GrPixelConfig config, const void* buffer, |
| 99 | size_t rowBytes) SK_OVERRIDE; |
| 100 | |
| 101 | /** |
| 102 | * @return this texture |
| 103 | */ |
| 104 | virtual GrTexture* asTexture() SK_OVERRIDE { return this; } |
| 105 | virtual const GrTexture* asTexture() const SK_OVERRIDE { return this; } |
bsalomon@google.com | 669fdc4 | 2011-04-05 17:08:27 +0000 | [diff] [blame] | 106 | |
| 107 | /** |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 108 | * Retrieves the render target underlying this texture that can be passed to |
| 109 | * GrGpu::setRenderTarget(). |
| 110 | * |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 111 | * @return handle to render target or NULL if the texture is not a |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 112 | * render target |
| 113 | */ |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 114 | virtual GrRenderTarget* asRenderTarget() SK_OVERRIDE { |
| 115 | return fRenderTarget; |
| 116 | } |
| 117 | virtual const GrRenderTarget* asRenderTarget() const SK_OVERRIDE { |
| 118 | return fRenderTarget; |
| 119 | } |
| 120 | |
| 121 | // GrTexture |
| 122 | /** |
| 123 | * Convert from texels to normalized texture coords for POT textures |
| 124 | * only. |
| 125 | */ |
| 126 | GrFixed normalizeFixedX(GrFixed x) const { |
| 127 | GrAssert(GrIsPow2(fDesc.fWidth)); |
| 128 | return x >> fShiftFixedX; |
| 129 | } |
| 130 | GrFixed normalizeFixedY(GrFixed y) const { |
| 131 | GrAssert(GrIsPow2(fDesc.fHeight)); |
| 132 | return y >> fShiftFixedY; |
| 133 | } |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 134 | |
| 135 | /** |
bsalomon@google.com | 1da0746 | 2011-03-10 14:51:57 +0000 | [diff] [blame] | 136 | * Removes the reference on the associated GrRenderTarget held by this |
bsalomon@google.com | 8fe7247 | 2011-03-30 21:26:44 +0000 | [diff] [blame] | 137 | * texture. Afterwards asRenderTarget() will return NULL. The |
bsalomon@google.com | 1da0746 | 2011-03-10 14:51:57 +0000 | [diff] [blame] | 138 | * GrRenderTarget survives the release if another ref is held on it. |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 139 | */ |
bsalomon@google.com | aa5b673 | 2011-07-29 15:13:20 +0000 | [diff] [blame] | 140 | void releaseRenderTarget(); |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 141 | |
| 142 | /** |
| 143 | * Return the native ID or handle to the texture, depending on the |
| 144 | * platform. e.g. on opengl, return the texture ID. |
| 145 | */ |
bsalomon@google.com | cee661a | 2011-07-26 12:32:36 +0000 | [diff] [blame] | 146 | virtual intptr_t getTextureHandle() const = 0; |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 147 | |
junov@chromium.org | 957ebdd | 2012-06-12 13:58:36 +0000 | [diff] [blame] | 148 | /** |
| 149 | * Call this when the state of the native API texture object is |
| 150 | * altered directly, without being tracked by skia. |
| 151 | */ |
| 152 | virtual void invalidateCachedState() = 0; |
| 153 | |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 154 | #if GR_DEBUG |
| 155 | void validate() const { |
| 156 | this->INHERITED::validate(); |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 157 | |
| 158 | this->validateDesc(); |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 159 | } |
| 160 | #else |
| 161 | void validate() const {} |
| 162 | #endif |
bsalomon@google.com | 1c13c96 | 2011-02-14 16:51:21 +0000 | [diff] [blame] | 163 | |
robertphillips@google.com | a1e5795 | 2012-06-04 20:05:28 +0000 | [diff] [blame] | 164 | static GrResourceKey ComputeKey(const GrGpu* gpu, |
bsalomon@google.com | b867099 | 2012-07-25 21:27:09 +0000 | [diff] [blame^] | 165 | const GrTextureParams* sampler, |
robertphillips@google.com | a1e5795 | 2012-06-04 20:05:28 +0000 | [diff] [blame] | 166 | const GrTextureDesc& desc, |
| 167 | bool scratch); |
| 168 | |
| 169 | static bool NeedsResizing(const GrResourceKey& key); |
| 170 | static bool IsScratchTexture(const GrResourceKey& key); |
| 171 | static bool NeedsFiltering(const GrResourceKey& key); |
| 172 | |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 173 | protected: |
| 174 | GrRenderTarget* fRenderTarget; // texture refs its rt representation |
| 175 | // base class cons sets to NULL |
| 176 | // subclass cons can create and set |
| 177 | |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 178 | GrTexture(GrGpu* gpu, const GrTextureDesc& desc) |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 179 | : INHERITED(gpu, desc) |
| 180 | , fRenderTarget(NULL) { |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 181 | |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 182 | // only make sense if alloc size is pow2 |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 183 | fShiftFixedX = 31 - Gr_clz(fDesc.fWidth); |
| 184 | fShiftFixedY = 31 - Gr_clz(fDesc.fHeight); |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 185 | } |
bsalomon@google.com | cee661a | 2011-07-26 12:32:36 +0000 | [diff] [blame] | 186 | |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 187 | // GrResource overrides |
robertphillips@google.com | 15c0fea | 2012-06-22 12:41:43 +0000 | [diff] [blame] | 188 | virtual void onRelease() SK_OVERRIDE; |
| 189 | virtual void onAbandon() SK_OVERRIDE; |
bsalomon@google.com | 6dcf499 | 2011-04-05 21:16:14 +0000 | [diff] [blame] | 190 | |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 191 | void validateDesc() const; |
| 192 | |
bsalomon@google.com | 1c13c96 | 2011-02-14 16:51:21 +0000 | [diff] [blame] | 193 | private: |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 194 | // these two shift a fixed-point value into normalized coordinates |
| 195 | // for this texture if the texture is power of two sized. |
robertphillips@google.com | 3271628 | 2012-06-04 12:48:45 +0000 | [diff] [blame] | 196 | int fShiftFixedX; |
| 197 | int fShiftFixedY; |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 198 | |
robertphillips@google.com | 15c0fea | 2012-06-22 12:41:43 +0000 | [diff] [blame] | 199 | virtual void internal_dispose() const SK_OVERRIDE; |
| 200 | |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 201 | typedef GrSurface INHERITED; |
reed@google.com | ac10a2d | 2010-12-22 21:39:39 +0000 | [diff] [blame] | 202 | }; |
| 203 | |
| 204 | #endif |
| 205 | |