blob: fccc52b71d82f1ea68804ed685e487035b7d05f2 [file] [log] [blame]
Brian Osman45580d32016-11-23 09:37:01 -05001/*
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 GrSurfaceContext_DEFINED
9#define GrSurfaceContext_DEFINED
10
Brian Salomone9ad9982019-07-22 16:17:41 -040011#include "include/core/SkFilterQuality.h"
12#include "include/core/SkImageInfo.h"
13#include "include/core/SkRect.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "include/core/SkRefCnt.h"
Brian Salomone9ad9982019-07-22 16:17:41 -040015#include "include/core/SkSurface.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050016#include "src/gpu/GrColorSpaceInfo.h"
Brian Salomon1d435302019-07-01 13:05:28 -040017#include "src/gpu/GrDataUtils.h"
Greg Danielf91aeb22019-06-18 09:58:02 -040018#include "src/gpu/GrSurfaceProxy.h"
Brian Osman45580d32016-11-23 09:37:01 -050019
20class GrAuditTrail;
Robert Phillips72152832017-01-25 17:31:35 -050021class GrDrawingManager;
Robert Phillips69893702019-02-22 11:16:30 -050022class GrRecordingContext;
Robert Phillipsd46697a2017-01-25 12:10:37 -050023class GrRenderTargetContext;
Robert Phillips27341362016-12-14 08:46:47 -050024class GrRenderTargetProxy;
Brian Osman45580d32016-11-23 09:37:01 -050025class GrSingleOwner;
26class GrSurface;
Robert Phillipse305cc1f2016-12-14 12:19:05 -050027class GrSurfaceContextPriv;
Robert Phillips27341362016-12-14 08:46:47 -050028class GrSurfaceProxy;
29class GrTextureProxy;
Brian Osman45580d32016-11-23 09:37:01 -050030struct SkIPoint;
31struct SkIRect;
32
33/**
34 * A helper object to orchestrate commands for a particular surface
35 */
Brian Salomon57f211b2019-08-21 15:21:09 -040036class GrSurfaceContext {
Brian Osman45580d32016-11-23 09:37:01 -050037public:
Brian Salomonbf6b9792019-08-21 09:38:10 -040038 virtual ~GrSurfaceContext() = default;
Brian Osman45580d32016-11-23 09:37:01 -050039
Brian Salomonf3569f02017-10-24 12:52:33 -040040 const GrColorSpaceInfo& colorSpaceInfo() const { return fColorSpaceInfo; }
Robert Phillips2c862492017-01-18 10:08:39 -050041
Robert Phillipsd46697a2017-01-25 12:10:37 -050042 // TODO: these two calls would be way cooler if this object had a GrSurfaceProxy pointer
Robert Phillipsf200a902017-01-30 13:27:37 -050043 int width() const { return this->asSurfaceProxy()->width(); }
44 int height() const { return this->asSurfaceProxy()->height(); }
Robert Phillipsd46697a2017-01-25 12:10:37 -050045
Brian Salomon4d2d6f42019-07-26 14:15:11 -040046 const GrCaps* caps() const;
47
Robert Phillips2c862492017-01-18 10:08:39 -050048 /**
49 * Reads a rectangle of pixels from the render target context.
50 * @param dstInfo image info for the destination
Brian Salomon1d435302019-07-01 13:05:28 -040051 * @param dst destination pixels for the read
52 * @param rowBytes bytes in a row of 'dst'
53 * @param srcPt offset w/in the surface context from which to read
54 * @param direct The direct context to use. If null will use our GrRecordingContext if it
55 * is a GrDirectContext and fail otherwise.
Robert Phillips2c862492017-01-18 10:08:39 -050056 */
Brian Salomon1d435302019-07-01 13:05:28 -040057 bool readPixels(const GrPixelInfo& dstInfo, void* dst, size_t rowBytes, SkIPoint srcPt,
58 GrContext* direct = nullptr);
Robert Phillips2c862492017-01-18 10:08:39 -050059
60 /**
Robert Phillipsb726d582017-03-09 16:36:32 -050061 * Writes a rectangle of pixels [srcInfo, srcBuffer, srcRowbytes] into the
Robert Phillips2c862492017-01-18 10:08:39 -050062 * renderTargetContext at the specified position.
63 * @param srcInfo image info for the source pixels
Brian Salomon1d435302019-07-01 13:05:28 -040064 * @param src source for the write
65 * @param rowBytes bytes in a row of 'src'
66 * @param dstPt offset w/in the surface context at which to write
67 * @param direct The direct context to use. If null will use our GrRecordingContext if it
68 * is a GrDirectContext and fail otherwise.
Robert Phillips2c862492017-01-18 10:08:39 -050069 */
Brian Salomon1d435302019-07-01 13:05:28 -040070 bool writePixels(const GrPixelInfo& srcInfo, const void* src, size_t rowBytes, SkIPoint dstPt,
71 GrContext* direct = nullptr);
Greg Daniel6eb8c242019-06-05 10:22:24 -040072
Robert Phillips27341362016-12-14 08:46:47 -050073 // TODO: this is virtual b.c. this object doesn't have a pointer to the wrapped GrSurfaceProxy?
Robert Phillipsf200a902017-01-30 13:27:37 -050074 virtual GrSurfaceProxy* asSurfaceProxy() = 0;
75 virtual const GrSurfaceProxy* asSurfaceProxy() const = 0;
76 virtual sk_sp<GrSurfaceProxy> asSurfaceProxyRef() = 0;
77
78 virtual GrTextureProxy* asTextureProxy() = 0;
Greg Daniele252f082017-10-23 16:05:23 -040079 virtual const GrTextureProxy* asTextureProxy() const = 0;
Robert Phillipsf200a902017-01-30 13:27:37 -050080 virtual sk_sp<GrTextureProxy> asTextureProxyRef() = 0;
81
82 virtual GrRenderTargetProxy* asRenderTargetProxy() = 0;
83 virtual sk_sp<GrRenderTargetProxy> asRenderTargetProxyRef() = 0;
Robert Phillips27341362016-12-14 08:46:47 -050084
Robert Phillipsd46697a2017-01-25 12:10:37 -050085 virtual GrRenderTargetContext* asRenderTargetContext() { return nullptr; }
86
Robert Phillips0d075de2019-03-04 11:08:13 -050087 GrAuditTrail* auditTrail();
Brian Osman45580d32016-11-23 09:37:01 -050088
Robert Phillipse305cc1f2016-12-14 12:19:05 -050089 // Provides access to functions that aren't part of the public API.
90 GrSurfaceContextPriv surfPriv();
91 const GrSurfaceContextPriv surfPriv() const;
92
Greg Daniel46cfbc62019-06-07 11:43:30 -040093#if GR_TEST_UTILS
94 bool testCopy(GrSurfaceProxy* src, const SkIRect& srcRect, const SkIPoint& dstPoint) {
95 return this->copy(src, srcRect, dstPoint);
96 }
97
98 bool testCopy(GrSurfaceProxy* src) {
99 return this->copy(src);
100 }
101#endif
102
103
Brian Osman45580d32016-11-23 09:37:01 -0500104protected:
Robert Phillipse305cc1f2016-12-14 12:19:05 -0500105 friend class GrSurfaceContextPriv;
106
Brian Salomonbd3d8d32019-07-02 09:16:28 -0400107 GrSurfaceContext(GrRecordingContext*, GrColorType, SkAlphaType, sk_sp<SkColorSpace>);
Robert Phillips72152832017-01-25 17:31:35 -0500108
Robert Phillips0d075de2019-03-04 11:08:13 -0500109 GrDrawingManager* drawingManager();
110 const GrDrawingManager* drawingManager() const;
Brian Osman45580d32016-11-23 09:37:01 -0500111
Robert Phillips2de8cfa2017-06-28 10:33:41 -0400112 SkDEBUGCODE(virtual void validate() const = 0;)
113
Robert Phillips0d075de2019-03-04 11:08:13 -0500114 SkDEBUGCODE(GrSingleOwner* singleOwner();)
Brian Osman45580d32016-11-23 09:37:01 -0500115
Robert Phillips69893702019-02-22 11:16:30 -0500116 GrRecordingContext* fContext;
Brian Osman45580d32016-11-23 09:37:01 -0500117
Brian Salomone9ad9982019-07-22 16:17:41 -0400118 // The rescaling step of asyncRescaleAndReadPixels[YUV420]().
Brian Salomonbf6b9792019-08-21 09:38:10 -0400119 std::unique_ptr<GrRenderTargetContext> rescale(const SkImageInfo& info, const SkIRect& srcRect,
120 SkSurface::RescaleGamma rescaleGamma,
121 SkFilterQuality rescaleQuality);
Brian Salomone9ad9982019-07-22 16:17:41 -0400122
Brian Salomon4d2d6f42019-07-26 14:15:11 -0400123 // Inserts a transfer, part of the implementation of asyncReadPixels and
124 // asyncRescaleAndReadPixelsYUV420().
125 struct PixelTransferResult {
126 using ConversionFn = void(void* dst, const void* mappedBuffer);
127 // If null then the transfer could not be performed. Otherwise this buffer will contain
128 // the pixel data when the transfer is complete.
129 sk_sp<GrGpuBuffer> fTransferBuffer;
130 // If this is null then the transfer buffer will contain the data in the requested
131 // color type. Otherwise, when the transfer is done this must be called to convert
132 // from the transfer buffer's color type to the requested color type.
133 std::function<ConversionFn> fPixelConverter;
134 };
135 PixelTransferResult transferPixels(GrColorType colorType, const SkIRect& rect);
136
Robert Phillipse305cc1f2016-12-14 12:19:05 -0500137private:
Greg Daniel46cfbc62019-06-07 11:43:30 -0400138 friend class GrSurfaceProxy; // for copy
139
140 /**
141 * Copy 'src' into the proxy backing this context. This call will not do any draw fallback.
142 * Currently only writePixels and replaceRenderTarget call this directly. All other copies
143 * should go through GrSurfaceProxy::Copy.
144 * @param src src of pixels
145 * @param srcRect the subset of 'src' to copy
146 * @param dstPoint the origin of the 'srcRect' in the destination coordinate space
147 * @return true if the copy succeeded; false otherwise
148 *
149 * Note: Notionally, 'srcRect' is clipped to 'src's extent with 'dstPoint' being adjusted.
150 * Then the 'srcRect' offset by 'dstPoint' is clipped against the dst's extent.
151 * The end result is only valid src pixels and dst pixels will be touched but the copied
152 * regions will not be shifted. The 'src' must have the same origin as the backing proxy
153 * of fSurfaceContext.
154 */
155 bool copy(GrSurfaceProxy* src, const SkIRect& srcRect, const SkIPoint& dstPoint);
156
157 bool copy(GrSurfaceProxy* src) {
158 return this->copy(src, SkIRect::MakeWH(src->width(), src->height()), SkIPoint::Make(0, 0));
159 }
160
Robert Phillips69893702019-02-22 11:16:30 -0500161 GrColorSpaceInfo fColorSpaceInfo;
Brian Salomonf3569f02017-10-24 12:52:33 -0400162
Robert Phillipse305cc1f2016-12-14 12:19:05 -0500163 typedef SkRefCnt INHERITED;
Brian Osman45580d32016-11-23 09:37:01 -0500164};
165
166#endif