133 lines
4.1 KiB
C++
133 lines
4.1 KiB
C++
/*
|
|
* Copyright 2011 Google Inc.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef GrRenderTarget_DEFINED
|
|
#define GrRenderTarget_DEFINED
|
|
|
|
#include "GrSurface.h"
|
|
#include "SkRect.h"
|
|
|
|
class GrStencilBuffer;
|
|
|
|
/**
|
|
* GrRenderTarget represents a 2D buffer of pixels that can be rendered to.
|
|
* A context's render target is set by setRenderTarget(). Render targets are
|
|
* created by a createTexture with the kRenderTarget_SurfaceFlag flag.
|
|
* Additionally, GrContext provides methods for creating GrRenderTargets
|
|
* that wrap externally created render targets.
|
|
*/
|
|
class GrRenderTarget : virtual public GrSurface {
|
|
public:
|
|
SK_DECLARE_INST_COUNT(GrRenderTarget)
|
|
|
|
// GrSurface overrides
|
|
virtual GrRenderTarget* asRenderTarget() SK_OVERRIDE { return this; }
|
|
virtual const GrRenderTarget* asRenderTarget() const SK_OVERRIDE { return this; }
|
|
|
|
// GrRenderTarget
|
|
/**
|
|
* If this RT is multisampled, this is the multisample buffer
|
|
* @return the 3D API's handle to this object (e.g. FBO ID in OpenGL)
|
|
*/
|
|
virtual GrBackendObject getRenderTargetHandle() const = 0;
|
|
|
|
/**
|
|
* If this RT is multisampled, this is the buffer it is resolved to.
|
|
* Otherwise, same as getRenderTargetHandle().
|
|
* (In GL a separate FBO ID is used for the MSAA and resolved buffers)
|
|
* @return the 3D API's handle to this object (e.g. FBO ID in OpenGL)
|
|
*/
|
|
virtual GrBackendObject getRenderTargetResolvedHandle() const = 0;
|
|
|
|
/**
|
|
* @return true if the surface is multisampled, false otherwise
|
|
*/
|
|
bool isMultisampled() const { return 0 != fDesc.fSampleCnt; }
|
|
|
|
/**
|
|
* @return the number of samples-per-pixel or zero if non-MSAA.
|
|
*/
|
|
int numSamples() const { return fDesc.fSampleCnt; }
|
|
|
|
/**
|
|
* Call to indicate the multisample contents were modified such that the
|
|
* render target needs to be resolved before it can be used as texture. Gr
|
|
* tracks this for its own drawing and thus this only needs to be called
|
|
* when the render target has been modified outside of Gr. This has no
|
|
* effect on wrapped backend render targets.
|
|
*
|
|
* @param rect a rect bounding the area needing resolve. NULL indicates
|
|
* the whole RT needs resolving.
|
|
*/
|
|
void flagAsNeedingResolve(const SkIRect* rect = NULL);
|
|
|
|
/**
|
|
* Call to override the region that needs to be resolved.
|
|
*/
|
|
void overrideResolveRect(const SkIRect rect);
|
|
|
|
/**
|
|
* Call to indicate that GrRenderTarget was externally resolved. This may
|
|
* allow Gr to skip a redundant resolve step.
|
|
*/
|
|
void flagAsResolved() { fResolveRect.setLargestInverted(); }
|
|
|
|
/**
|
|
* @return true if the GrRenderTarget requires MSAA resolving
|
|
*/
|
|
bool needsResolve() const { return !fResolveRect.isEmpty(); }
|
|
|
|
/**
|
|
* Returns a rect bounding the region needing resolving.
|
|
*/
|
|
const SkIRect& getResolveRect() const { return fResolveRect; }
|
|
|
|
/**
|
|
* Provide a performance hint that the render target's contents are allowed
|
|
* to become undefined.
|
|
*/
|
|
void discard();
|
|
|
|
// a MSAA RT may require explicit resolving , it may auto-resolve (e.g. FBO
|
|
// 0 in GL), or be unresolvable because the client didn't give us the
|
|
// resolve destination.
|
|
enum ResolveType {
|
|
kCanResolve_ResolveType,
|
|
kAutoResolves_ResolveType,
|
|
kCantResolve_ResolveType,
|
|
};
|
|
virtual ResolveType getResolveType() const = 0;
|
|
|
|
/**
|
|
* GrStencilBuffer is not part of the public API.
|
|
*/
|
|
GrStencilBuffer* getStencilBuffer() const { return fStencilBuffer; }
|
|
void setStencilBuffer(GrStencilBuffer* stencilBuffer);
|
|
|
|
protected:
|
|
GrRenderTarget(GrGpu* gpu,
|
|
bool isWrapped,
|
|
const GrSurfaceDesc& desc)
|
|
: INHERITED(gpu, isWrapped, desc)
|
|
, fStencilBuffer(NULL) {
|
|
fResolveRect.setLargestInverted();
|
|
}
|
|
|
|
// override of GrResource
|
|
virtual void onAbandon() SK_OVERRIDE;
|
|
virtual void onRelease() SK_OVERRIDE;
|
|
|
|
private:
|
|
GrStencilBuffer* fStencilBuffer;
|
|
|
|
SkIRect fResolveRect;
|
|
|
|
typedef GrSurface INHERITED;
|
|
};
|
|
|
|
#endif
|