1/*
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
11#include "GrRenderTarget.h"
12#include "GrGpu.h"
13
14class GrStencilSettings;
15
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    /**
22     * GrStencilAttachment is not part of the public API.
23     */
24    GrStencilAttachment* getStencilAttachment() const { return fRenderTarget->fStencilAttachment; }
25
26    /**
27     * Attaches the GrStencilAttachment onto the render target. If stencil is a nullptr then the
28     * currently attached GrStencilAttachment will be removed if one was previously attached. This
29     * function returns false if there were any failure in attaching the GrStencilAttachment.
30     */
31    bool attachStencilAttachment(sk_sp<GrStencilAttachment> stencil);
32
33    int numStencilBits() const;
34
35    // Finds a render target's multisample specs. The pipeline is only needed in case the info isn't
36    // cached and we need to flush the draw state in order to query it. The pipeline is not expected
37    // to affect the multisample information itself.
38    const GrGpu::MultisampleSpecs& getMultisampleSpecs(const GrPipeline&) const;
39
40    GrRenderTargetFlags flags() const { return fRenderTarget->fFlags; }
41
42private:
43    explicit GrRenderTargetPriv(GrRenderTarget* renderTarget) : fRenderTarget(renderTarget) {}
44    GrRenderTargetPriv(const GrRenderTargetPriv&) {} // unimpl
45    GrRenderTargetPriv& operator=(const GrRenderTargetPriv&); // unimpl
46
47    // No taking addresses of this type.
48    const GrRenderTargetPriv* operator&() const;
49    GrRenderTargetPriv* operator&();
50
51    GrRenderTarget* fRenderTarget;
52
53    friend class GrRenderTarget; // to construct/copy this type.
54};
55
56inline GrRenderTargetPriv GrRenderTarget::renderTargetPriv() { return GrRenderTargetPriv(this); }
57
58inline const GrRenderTargetPriv GrRenderTarget::renderTargetPriv () const {
59    return GrRenderTargetPriv(const_cast<GrRenderTarget*>(this));
60}
61
62#endif
63