robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2012 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 | |
| 9 | #ifndef GrSurface_DEFINED |
| 10 | #define GrSurface_DEFINED |
| 11 | |
| 12 | #include "GrTypes.h" |
bsalomon | 6d3fe02 | 2014-07-25 08:35:45 -0700 | [diff] [blame] | 13 | #include "GrGpuResource.h" |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 14 | #include "SkImageInfo.h" |
commit-bot@chromium.org | 24ab3b0 | 2013-08-14 21:56:37 +0000 | [diff] [blame] | 15 | #include "SkRect.h" |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 16 | |
robertphillips | b06e5a2 | 2014-09-30 06:58:20 -0700 | [diff] [blame] | 17 | class GrRenderTarget; |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 18 | class GrSurfacePriv; |
| 19 | class GrTexture; |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 20 | |
bsalomon | cc97ece | 2015-07-08 07:53:10 -0700 | [diff] [blame] | 21 | class SK_API GrSurface : public GrGpuResource { |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 22 | public: |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 23 | /** |
| 24 | * Retrieves the width of the surface. |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 25 | */ |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 26 | int width() const { return fWidth; } |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * Retrieves the height of the surface. |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 30 | */ |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 31 | int height() const { return fHeight; } |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 32 | |
commit-bot@chromium.org | 24ab3b0 | 2013-08-14 21:56:37 +0000 | [diff] [blame] | 33 | /** |
| 34 | * Helper that gets the width and height of the surface as a bounding rectangle. |
| 35 | */ |
robertphillips | 13a7eee | 2016-08-31 15:06:24 -0700 | [diff] [blame] | 36 | SkRect getBoundsRect() const { return SkRect::MakeIWH(this->width(), this->height()); } |
commit-bot@chromium.org | 24ab3b0 | 2013-08-14 21:56:37 +0000 | [diff] [blame] | 37 | |
senorblanco@chromium.org | ef5dbe1 | 2013-01-28 16:42:38 +0000 | [diff] [blame] | 38 | GrSurfaceOrigin origin() const { |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 39 | SkASSERT(kTopLeft_GrSurfaceOrigin == fOrigin || kBottomLeft_GrSurfaceOrigin == fOrigin); |
| 40 | return fOrigin; |
bsalomon@google.com | 2d0bade | 2012-10-26 19:01:17 +0000 | [diff] [blame] | 41 | } |
| 42 | |
| 43 | /** |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 44 | * Retrieves the pixel config specified when the surface was created. |
| 45 | * For render targets this can be kUnknown_GrPixelConfig |
| 46 | * if client asked us to render to a target that has a pixel |
| 47 | * config that isn't equivalent with one of our configs. |
| 48 | */ |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 49 | GrPixelConfig config() const { return fConfig; } |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 50 | |
| 51 | /** |
Robert Phillips | c589b0b | 2017-04-17 07:53:07 -0400 | [diff] [blame] | 52 | * @return the texture associated with the surface, may be null. |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 53 | */ |
Robert Phillips | c589b0b | 2017-04-17 07:53:07 -0400 | [diff] [blame] | 54 | virtual GrTexture* asTexture() { return nullptr; } |
| 55 | virtual const GrTexture* asTexture() const { return nullptr; } |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 56 | |
| 57 | /** |
Robert Phillips | c589b0b | 2017-04-17 07:53:07 -0400 | [diff] [blame] | 58 | * @return the render target underlying this surface, may be null. |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 59 | */ |
Robert Phillips | c589b0b | 2017-04-17 07:53:07 -0400 | [diff] [blame] | 60 | virtual GrRenderTarget* asRenderTarget() { return nullptr; } |
| 61 | virtual const GrRenderTarget* asRenderTarget() const { return nullptr; } |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 62 | |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 63 | /** Access methods that are only to be used within Skia code. */ |
| 64 | inline GrSurfacePriv surfacePriv(); |
| 65 | inline const GrSurfacePriv surfacePriv() const; |
robertphillips | b06e5a2 | 2014-09-30 06:58:20 -0700 | [diff] [blame] | 66 | |
Robert Phillips | b446088 | 2016-11-17 14:43:51 -0500 | [diff] [blame] | 67 | static size_t WorstCaseSize(const GrSurfaceDesc& desc, bool useNextPow2 = false); |
Brian Salomon | bb5711a | 2017-05-17 13:49:59 -0400 | [diff] [blame] | 68 | static size_t ComputeSize(GrPixelConfig config, int width, int height, int colorSamplesPerPixel, |
Robert Phillips | b446088 | 2016-11-17 14:43:51 -0500 | [diff] [blame] | 69 | bool hasMIPMaps, bool useNextPow2 = false); |
Robert Phillips | d6214d4 | 2016-11-07 08:23:48 -0500 | [diff] [blame] | 70 | |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 71 | protected: |
| 72 | // Methods made available via GrSurfacePriv |
bsalomon | 8d034a1 | 2014-09-22 12:21:08 -0700 | [diff] [blame] | 73 | bool hasPendingRead() const; |
| 74 | bool hasPendingWrite() const; |
| 75 | bool hasPendingIO() const; |
| 76 | |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 77 | // Provides access to methods that should be public within Skia code. |
| 78 | friend class GrSurfacePriv; |
| 79 | |
kkinnunen | 2e6055b | 2016-04-22 01:48:29 -0700 | [diff] [blame] | 80 | GrSurface(GrGpu* gpu, const GrSurfaceDesc& desc) |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 81 | : INHERITED(gpu) |
| 82 | , fConfig(desc.fConfig) |
| 83 | , fWidth(desc.fWidth) |
| 84 | , fHeight(desc.fHeight) |
| 85 | , fOrigin(desc.fOrigin) {} |
Greg Daniel | cef213c | 2017-04-21 11:52:27 -0400 | [diff] [blame] | 86 | ~GrSurface() override {} |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 87 | |
bsalomon@google.com | 2d0bade | 2012-10-26 19:01:17 +0000 | [diff] [blame] | 88 | |
reed | 35a5261 | 2015-06-18 14:05:07 -0700 | [diff] [blame] | 89 | void onRelease() override; |
| 90 | void onAbandon() override; |
| 91 | |
| 92 | private: |
Brian Salomon | d34edf3 | 2017-05-19 15:45:48 -0400 | [diff] [blame^] | 93 | GrPixelConfig fConfig; |
| 94 | int fWidth; |
| 95 | int fHeight; |
| 96 | GrSurfaceOrigin fOrigin; |
| 97 | |
bsalomon | 6d3fe02 | 2014-07-25 08:35:45 -0700 | [diff] [blame] | 98 | typedef GrGpuResource INHERITED; |
robertphillips@google.com | 7d501ab | 2012-06-21 21:09:06 +0000 | [diff] [blame] | 99 | }; |
| 100 | |
bsalomon | afbf2d6 | 2014-09-30 12:18:44 -0700 | [diff] [blame] | 101 | #endif |