blob: f81bd1f49a967eb1e7a4f288bcf8d7d7d1310160 [file] [log] [blame]
bsalomon6bc1b5f2015-02-23 09:06:38 -08001/*
2 * Copyright 2015 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 GrRenderTargetPriv_DEFINED
9#define GrRenderTargetPriv_DEFINED
10
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "src/gpu/GrGpu.h"
Brian Salomon201cdbb2019-08-14 17:00:30 -040012#include "src/gpu/GrRenderTarget.h"
cdalton28f45b92016-03-07 13:58:26 -080013
14class GrStencilSettings;
bsalomon6bc1b5f2015-02-23 09:06:38 -080015
16/** Class that adds methods to GrRenderTarget that are only intended for use internal to Skia.
17 This class is purely a privileged window into GrRenderTarget. It should never have additional
18 data members or virtual methods. */
19class GrRenderTargetPriv {
20public:
21 /**
egdaniel8dc7c3a2015-04-16 11:22:42 -070022 * GrStencilAttachment is not part of the public API.
bsalomon6bc1b5f2015-02-23 09:06:38 -080023 */
Ben Wagner9ec70c62018-07-12 13:30:47 -040024 GrStencilAttachment* getStencilAttachment() const {
25 return fRenderTarget->fStencilAttachment.get();
26 }
bsalomon6bc1b5f2015-02-23 09:06:38 -080027
28 /**
egdanielec00d942015-09-14 12:56:10 -070029 * Attaches the GrStencilAttachment onto the render target. If stencil is a nullptr then the
30 * currently attached GrStencilAttachment will be removed if one was previously attached. This
31 * function returns false if there were any failure in attaching the GrStencilAttachment.
bsalomon6bc1b5f2015-02-23 09:06:38 -080032 */
Greg Danielcfa39352018-10-05 12:01:59 -040033 void attachStencilAttachment(sk_sp<GrStencilAttachment> stencil);
bsalomon6bc1b5f2015-02-23 09:06:38 -080034
cdalton193d9cf2016-05-12 11:52:02 -070035 int numStencilBits() const;
36
Chris Daltond7291ba2019-03-07 14:17:03 -070037 /**
38 * Returns a unique key that identifies this render target's sample pattern. (Must be
39 * multisampled.)
Chris Daltond7291ba2019-03-07 14:17:03 -070040 */
Chris Dalton8c4cafd2019-04-15 19:14:36 -060041 int getSamplePatternKey() const;
Chris Daltond7291ba2019-03-07 14:17:03 -070042
43 /**
Chris Dalton8c4cafd2019-04-15 19:14:36 -060044 * Retrieves the per-pixel HW sample locations for this render target, and, as a by-product, the
45 * actual number of samples in use. (This may differ from fSampleCnt.) Sample locations are
46 * returned as 0..1 offsets relative to the top-left corner of the pixel.
Chris Daltond7291ba2019-03-07 14:17:03 -070047 */
Chris Dalton8c4cafd2019-04-15 19:14:36 -060048 const SkTArray<SkPoint>& getSampleLocations() const {
49 int samplePatternKey = this->getSamplePatternKey();
Chris Daltond7291ba2019-03-07 14:17:03 -070050 return fRenderTarget->getGpu()->retrieveSampleLocations(samplePatternKey);
51 }
52
bsalomon6bc1b5f2015-02-23 09:06:38 -080053private:
54 explicit GrRenderTargetPriv(GrRenderTarget* renderTarget) : fRenderTarget(renderTarget) {}
55 GrRenderTargetPriv(const GrRenderTargetPriv&) {} // unimpl
56 GrRenderTargetPriv& operator=(const GrRenderTargetPriv&); // unimpl
57
58 // No taking addresses of this type.
59 const GrRenderTargetPriv* operator&() const;
60 GrRenderTargetPriv* operator&();
61
62 GrRenderTarget* fRenderTarget;
halcanary9d524f22016-03-29 09:03:52 -070063
bsalomon6bc1b5f2015-02-23 09:06:38 -080064 friend class GrRenderTarget; // to construct/copy this type.
65};
66
67inline GrRenderTargetPriv GrRenderTarget::renderTargetPriv() { return GrRenderTargetPriv(this); }
68
69inline const GrRenderTargetPriv GrRenderTarget::renderTargetPriv () const {
70 return GrRenderTargetPriv(const_cast<GrRenderTarget*>(this));
71}
72
73#endif