robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [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 GrContextPriv_DEFINED |
| 9 | #define GrContextPriv_DEFINED |
| 10 | |
| 11 | #include "GrContext.h" |
Brian Osman | 45580d3 | 2016-11-23 09:37:01 -0500 | [diff] [blame] | 12 | #include "GrSurfaceContext.h" |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 13 | |
Greg Daniel | bcf612b | 2017-05-01 13:50:58 +0000 | [diff] [blame] | 14 | class GrBackendRenderTarget; |
Greg Daniel | d85f97d | 2017-03-07 13:37:21 -0500 | [diff] [blame] | 15 | class GrSemaphore; |
Robert Phillips | e2f7d18 | 2016-12-15 09:23:05 -0500 | [diff] [blame] | 16 | class GrSurfaceProxy; |
Chris Dalton | fe199b7 | 2017-05-05 11:26:15 -0400 | [diff] [blame] | 17 | class GrOnFlushCallbackObject; |
Robert Phillips | e2f7d18 | 2016-12-15 09:23:05 -0500 | [diff] [blame] | 18 | |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 19 | /** Class that adds methods to GrContext that are only intended for use internal to Skia. |
| 20 | This class is purely a privileged window into GrContext. It should never have additional |
| 21 | data members or virtual methods. */ |
| 22 | class GrContextPriv { |
| 23 | public: |
bungeman | 6bd5284 | 2016-10-27 09:30:08 -0700 | [diff] [blame] | 24 | GrDrawingManager* drawingManager() { return fContext->fDrawingManager.get(); } |
csmartdalton | bde96c6 | 2016-08-31 12:54:46 -0700 | [diff] [blame] | 25 | |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 26 | // Create a renderTargetContext that wraps an existing renderTarget |
Robert Phillips | bf25d43 | 2017-04-07 10:08:53 -0400 | [diff] [blame] | 27 | sk_sp<GrRenderTargetContext> makeWrappedRenderTargetContext(sk_sp<GrRenderTarget>, |
| 28 | sk_sp<SkColorSpace>, |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 29 | const SkSurfaceProps* = nullptr); |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 30 | |
Brian Osman | 45580d3 | 2016-11-23 09:37:01 -0500 | [diff] [blame] | 31 | // Create a surfaceContext that wraps an existing texture or renderTarget |
Robert Phillips | bf25d43 | 2017-04-07 10:08:53 -0400 | [diff] [blame] | 32 | sk_sp<GrSurfaceContext> makeWrappedSurfaceContext(sk_sp<GrSurface>); |
Brian Osman | 45580d3 | 2016-11-23 09:37:01 -0500 | [diff] [blame] | 33 | |
Robert Phillips | bf25d43 | 2017-04-07 10:08:53 -0400 | [diff] [blame] | 34 | sk_sp<GrSurfaceContext> makeWrappedSurfaceContext(sk_sp<GrSurfaceProxy>, sk_sp<SkColorSpace>); |
Robert Phillips | 31c2608 | 2016-12-14 15:12:15 -0500 | [diff] [blame] | 35 | |
Robert Phillips | bf25d43 | 2017-04-07 10:08:53 -0400 | [diff] [blame] | 36 | sk_sp<GrSurfaceContext> makeDeferredSurfaceContext(const GrSurfaceDesc&, |
| 37 | SkBackingFit, |
| 38 | SkBudgeted); |
Robert Phillips | e305cc1f | 2016-12-14 12:19:05 -0500 | [diff] [blame] | 39 | |
Robert Phillips | 26caf89 | 2017-01-27 10:58:31 -0500 | [diff] [blame] | 40 | // TODO: Maybe add a 'surfaceProps' param (that is ignored for non-RTs) and remove |
| 41 | // makeBackendTextureRenderTargetContext & makeBackendTextureAsRenderTargetRenderTargetContext |
Greg Daniel | 7ef28f3 | 2017-04-20 16:41:55 +0000 | [diff] [blame] | 42 | sk_sp<GrSurfaceContext> makeBackendSurfaceContext(const GrBackendTexture& tex, |
| 43 | GrSurfaceOrigin origin, |
| 44 | GrBackendTextureFlags flags, |
| 45 | int sampleCnt, |
Brian Osman | c1e3705 | 2017-03-09 14:19:20 -0500 | [diff] [blame] | 46 | sk_sp<SkColorSpace> colorSpace); |
Robert Phillips | d46697a | 2017-01-25 12:10:37 -0500 | [diff] [blame] | 47 | |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 48 | sk_sp<GrRenderTargetContext> makeBackendTextureRenderTargetContext( |
Greg Daniel | 7ef28f3 | 2017-04-20 16:41:55 +0000 | [diff] [blame] | 49 | const GrBackendTexture& tex, |
| 50 | GrSurfaceOrigin origin, |
| 51 | int sampleCnt, |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 52 | sk_sp<SkColorSpace> colorSpace, |
Brian Osman | c1e3705 | 2017-03-09 14:19:20 -0500 | [diff] [blame] | 53 | const SkSurfaceProps* = nullptr); |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 54 | |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 55 | sk_sp<GrRenderTargetContext> makeBackendRenderTargetRenderTargetContext( |
Greg Daniel | bcf612b | 2017-05-01 13:50:58 +0000 | [diff] [blame] | 56 | const GrBackendRenderTarget&, |
| 57 | GrSurfaceOrigin origin, |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 58 | sk_sp<SkColorSpace> colorSpace, |
| 59 | const SkSurfaceProps* = nullptr); |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 60 | |
Brian Osman | 1105224 | 2016-10-27 14:47:55 -0400 | [diff] [blame] | 61 | sk_sp<GrRenderTargetContext> makeBackendTextureAsRenderTargetRenderTargetContext( |
Greg Daniel | 7ef28f3 | 2017-04-20 16:41:55 +0000 | [diff] [blame] | 62 | const GrBackendTexture& tex, |
| 63 | GrSurfaceOrigin origin, |
| 64 | int sampleCnt, |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 65 | sk_sp<SkColorSpace> colorSpace, |
| 66 | const SkSurfaceProps* = nullptr); |
| 67 | |
Brian Osman | 46da1cc | 2017-02-14 14:15:48 -0500 | [diff] [blame] | 68 | bool disableGpuYUVConversion() const { return fContext->fDisableGpuYUVConversion; } |
| 69 | |
Robert Phillips | 7ee385e | 2017-03-30 08:02:11 -0400 | [diff] [blame] | 70 | /** |
| 71 | * Call to ensure all drawing to the context has been issued to the |
| 72 | * underlying 3D API. |
| 73 | * The 'proxy' parameter is a hint. If it is supplied the context will guarantee that |
| 74 | * the draws required for that proxy are flushed but it could do more. If no 'proxy' is |
| 75 | * provided then all current work will be flushed. |
| 76 | */ |
| 77 | void flush(GrSurfaceProxy*); |
| 78 | |
Chris Dalton | fe199b7 | 2017-05-05 11:26:15 -0400 | [diff] [blame] | 79 | /** |
| 80 | * Registers an object for flush-related callbacks. (See GrOnFlushCallbackObject.) |
| 81 | * |
| 82 | * NOTE: the drawing manager tracks this object as a raw pointer; it is up to the caller to |
| 83 | * ensure its lifetime is tied to that of the context. |
Robert Phillips | eb35f4d | 2017-03-21 07:56:47 -0400 | [diff] [blame] | 84 | */ |
Chris Dalton | fe199b7 | 2017-05-05 11:26:15 -0400 | [diff] [blame] | 85 | void addOnFlushCallbackObject(GrOnFlushCallbackObject*); |
| 86 | |
| 87 | void testingOnly_flushAndRemoveOnFlushCallbackObject(GrOnFlushCallbackObject*); |
Robert Phillips | eb35f4d | 2017-03-21 07:56:47 -0400 | [diff] [blame] | 88 | |
Robert Phillips | 7ee385e | 2017-03-30 08:02:11 -0400 | [diff] [blame] | 89 | /** |
| 90 | * After this returns any pending writes to the surface will have been issued to the |
| 91 | * backend 3D API. |
| 92 | */ |
| 93 | void flushSurfaceWrites(GrSurfaceProxy*); |
| 94 | |
| 95 | /** |
| 96 | * After this returns any pending reads or writes to the surface will have been issued to the |
| 97 | * backend 3D API. |
| 98 | */ |
| 99 | void flushSurfaceIO(GrSurfaceProxy*); |
| 100 | |
| 101 | /** |
| 102 | * Finalizes all pending reads and writes to the surface and also performs an MSAA resolve |
| 103 | * if necessary. |
| 104 | * |
| 105 | * It is not necessary to call this before reading the render target via Skia/GrContext. |
| 106 | * GrContext will detect when it must perform a resolve before reading pixels back from the |
| 107 | * surface or using it as a texture. |
| 108 | */ |
| 109 | void prepareSurfaceForExternalIO(GrSurfaceProxy*); |
| 110 | |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 111 | /** |
| 112 | * These flags can be used with the read/write pixels functions below. |
| 113 | */ |
| 114 | enum PixelOpsFlags { |
| 115 | /** The GrContext will not be flushed before the surface read or write. This means that |
| 116 | the read or write may occur before previous draws have executed. */ |
| 117 | kDontFlush_PixelOpsFlag = 0x1, |
| 118 | /** Any surface writes should be flushed to the backend 3D API after the surface operation |
| 119 | is complete */ |
| 120 | kFlushWrites_PixelOp = 0x2, |
| 121 | /** The src for write or dst read is unpremultiplied. This is only respected if both the |
| 122 | config src and dst configs are an RGBA/BGRA 8888 format. */ |
| 123 | kUnpremul_PixelOpsFlag = 0x4, |
| 124 | }; |
| 125 | |
| 126 | /** |
| 127 | * Reads a rectangle of pixels from a surface. |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 128 | * @param src the surface context to read from. |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 129 | * @param left left edge of the rectangle to read (inclusive) |
| 130 | * @param top top edge of the rectangle to read (inclusive) |
| 131 | * @param width width of rectangle to read in pixels. |
| 132 | * @param height height of rectangle to read in pixels. |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 133 | * @param dstConfig the pixel config of the destination buffer |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 134 | * @param dstColorSpace color space of the destination buffer |
| 135 | * @param buffer memory to read the rectangle into. |
| 136 | * @param rowBytes number of bytes bewtween consecutive rows. Zero means rows are tightly |
| 137 | * packed. |
| 138 | * @param pixelOpsFlags see PixelOpsFlags enum above. |
| 139 | * |
| 140 | * @return true if the read succeeded, false if not. The read can fail because of an unsupported |
| 141 | * pixel configs |
| 142 | */ |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 143 | bool readSurfacePixels(GrSurfaceContext* src, |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 144 | int left, int top, int width, int height, |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 145 | GrPixelConfig dstConfig, SkColorSpace* dstColorSpace, void* buffer, |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 146 | size_t rowBytes = 0, |
| 147 | uint32_t pixelOpsFlags = 0); |
| 148 | |
| 149 | /** |
| 150 | * Writes a rectangle of pixels to a surface. |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 151 | * @param dst the surface context to write to. |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 152 | * @param left left edge of the rectangle to write (inclusive) |
| 153 | * @param top top edge of the rectangle to write (inclusive) |
| 154 | * @param width width of rectangle to write in pixels. |
| 155 | * @param height height of rectangle to write in pixels. |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 156 | * @param srcConfig the pixel config of the source buffer |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 157 | * @param srcColorSpace color space of the source buffer |
| 158 | * @param buffer memory to read pixels from |
| 159 | * @param rowBytes number of bytes between consecutive rows. Zero |
| 160 | * means rows are tightly packed. |
| 161 | * @param pixelOpsFlags see PixelOpsFlags enum above. |
| 162 | * @return true if the write succeeded, false if not. The write can fail because of an |
| 163 | * unsupported combination of surface and src configs. |
| 164 | */ |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 165 | bool writeSurfacePixels(GrSurfaceContext* dst, |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 166 | int left, int top, int width, int height, |
Robert Phillips | f41c22f | 2017-04-18 07:48:58 -0400 | [diff] [blame] | 167 | GrPixelConfig srcConfig, SkColorSpace* srcColorSpace, const void* buffer, |
Robert Phillips | e78b725 | 2017-04-06 07:59:41 -0400 | [diff] [blame] | 168 | size_t rowBytes, |
| 169 | uint32_t pixelOpsFlags = 0); |
| 170 | |
Greg Daniel | fc978fd | 2017-04-13 09:54:12 -0400 | [diff] [blame] | 171 | GrBackend getBackend() const { return fContext->fBackend; } |
| 172 | |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 173 | private: |
| 174 | explicit GrContextPriv(GrContext* context) : fContext(context) {} |
Robert Phillips | eb35f4d | 2017-03-21 07:56:47 -0400 | [diff] [blame] | 175 | GrContextPriv(const GrContextPriv&); // unimpl |
robertphillips | 4fd74ae | 2016-08-03 14:26:53 -0700 | [diff] [blame] | 176 | GrContextPriv& operator=(const GrContextPriv&); // unimpl |
| 177 | |
| 178 | // No taking addresses of this type. |
| 179 | const GrContextPriv* operator&() const; |
| 180 | GrContextPriv* operator&(); |
| 181 | |
| 182 | GrContext* fContext; |
| 183 | |
| 184 | friend class GrContext; // to construct/copy this type. |
| 185 | }; |
| 186 | |
| 187 | inline GrContextPriv GrContext::contextPriv() { return GrContextPriv(this); } |
| 188 | |
| 189 | inline const GrContextPriv GrContext::contextPriv () const { |
| 190 | return GrContextPriv(const_cast<GrContext*>(this)); |
| 191 | } |
| 192 | |
| 193 | #endif |