robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 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 SkSpecialSurface_DEFINED |
| 9 | #define SkSpecialSurface_DEFINED |
| 10 | |
Hal Canary | 6b20a55 | 2017-02-07 14:09:38 -0500 | [diff] [blame] | 11 | #include "SkImageInfo.h" |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 12 | #include "SkRefCnt.h" |
| 13 | #include "SkSurfaceProps.h" |
| 14 | |
Hal Canary | 6b20a55 | 2017-02-07 14:09:38 -0500 | [diff] [blame] | 15 | #if SK_SUPPORT_GPU |
| 16 | #include "GrTypes.h" |
| 17 | #endif |
| 18 | |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 19 | class GrContext; |
Hal Canary | 6b20a55 | 2017-02-07 14:09:38 -0500 | [diff] [blame] | 20 | class SkBitmap; |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 21 | class SkCanvas; |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 22 | class SkSpecialImage; |
| 23 | |
| 24 | /** |
| 25 | * SkSpecialSurface is a restricted form of SkSurface solely for internal use. It differs |
| 26 | * from SkSurface in that: |
| 27 | * - it can be backed by GrTextures larger than [ fWidth, fHeight ] |
| 28 | * - it can't be used for tiling |
| 29 | * - it becomes inactive once a snapshot of it is taken (i.e., no copy-on-write) |
| 30 | * - it has no generation ID |
| 31 | */ |
| 32 | class SkSpecialSurface : public SkRefCnt { |
| 33 | public: |
| 34 | const SkSurfaceProps& props() const { return fProps; } |
| 35 | |
| 36 | int width() const { return fSubset.width(); } |
| 37 | int height() const { return fSubset.height(); } |
| 38 | |
| 39 | /** |
| 40 | * Return a canvas that will draw into this surface. This will always |
| 41 | * return the same canvas for a given surface, and is managed/owned by the |
halcanary | 9d524f2 | 2016-03-29 09:03:52 -0700 | [diff] [blame] | 42 | * surface. |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 43 | * |
| 44 | * The canvas will be invalid after 'newImageSnapshot' is called. |
| 45 | */ |
| 46 | SkCanvas* getCanvas(); |
| 47 | |
| 48 | /** |
| 49 | * Returns an image of the current state of the surface pixels up to this |
| 50 | * point. The canvas returned by 'getCanvas' becomes invalidated by this |
| 51 | * call and no more drawing to this surface is allowed. |
robertphillips | e8c3497 | 2016-02-16 12:09:36 -0800 | [diff] [blame] | 52 | * |
| 53 | * Note: the caller inherits a ref from this call that must be balanced |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 54 | */ |
robertphillips | 37bd7c3 | 2016-03-17 14:31:39 -0700 | [diff] [blame] | 55 | sk_sp<SkSpecialImage> makeImageSnapshot(); |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 56 | |
robertphillips | c91fd34 | 2016-04-25 12:32:54 -0700 | [diff] [blame] | 57 | #if SK_SUPPORT_GPU |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 58 | /** |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 59 | * Allocate a new GPU-backed SkSpecialSurface. If the requested surface cannot |
| 60 | * be created, nullptr will be returned. |
| 61 | */ |
robertphillips | 4df1656 | 2016-04-28 15:09:34 -0700 | [diff] [blame] | 62 | static sk_sp<SkSpecialSurface> MakeRenderTarget(GrContext*, |
| 63 | int width, int height, |
brianosman | dfe4f2e | 2016-07-21 13:28:36 -0700 | [diff] [blame] | 64 | GrPixelConfig config, |
| 65 | sk_sp<SkColorSpace> colorSpace); |
robertphillips | c91fd34 | 2016-04-25 12:32:54 -0700 | [diff] [blame] | 66 | #endif |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 67 | |
| 68 | /** |
| 69 | * Use and existing SkBitmap as the backing store. |
| 70 | */ |
robertphillips | 3e30227 | 2016-04-20 11:48:36 -0700 | [diff] [blame] | 71 | static sk_sp<SkSpecialSurface> MakeFromBitmap(const SkIRect& subset, SkBitmap& bm, |
robertphillips | 37bd7c3 | 2016-03-17 14:31:39 -0700 | [diff] [blame] | 72 | const SkSurfaceProps* = nullptr); |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 73 | |
| 74 | /** |
| 75 | * Return a new CPU-backed surface, with the memory for the pixels automatically |
| 76 | * allocated. |
| 77 | * |
| 78 | * If the requested surface cannot be created, or the request is not a |
| 79 | * supported configuration, nullptr will be returned. |
| 80 | */ |
robertphillips | 3e30227 | 2016-04-20 11:48:36 -0700 | [diff] [blame] | 81 | static sk_sp<SkSpecialSurface> MakeRaster(const SkImageInfo&, |
robertphillips | 37bd7c3 | 2016-03-17 14:31:39 -0700 | [diff] [blame] | 82 | const SkSurfaceProps* = nullptr); |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 83 | |
| 84 | protected: |
robertphillips | 3e30227 | 2016-04-20 11:48:36 -0700 | [diff] [blame] | 85 | SkSpecialSurface(const SkIRect& subset, const SkSurfaceProps*); |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 86 | |
| 87 | // For testing only |
| 88 | friend class TestingSpecialSurfaceAccess; |
| 89 | const SkIRect& subset() const { return fSubset; } |
| 90 | |
| 91 | private: |
| 92 | const SkSurfaceProps fProps; |
| 93 | const SkIRect fSubset; |
| 94 | |
robertphillips | b6c65e9 | 2016-02-04 10:52:42 -0800 | [diff] [blame] | 95 | typedef SkRefCnt INHERITED; |
| 96 | }; |
| 97 | |
| 98 | #endif |