blob: d01f1342ea3090acc728bdf56f124a08280d88a7 [file] [log] [blame]
* Copyright 2017 Google Inc.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
#ifndef GrOnFlushResourceProvider_DEFINED
#define GrOnFlushResourceProvider_DEFINED
#include "GrTypes.h"
#include "GrDeferredUpload.h"
#include "GrOpFlushState.h"
#include "GrResourceProvider.h"
#include "SkRefCnt.h"
#include "SkTArray.h"
class GrDrawingManager;
class GrOpList;
class GrOnFlushResourceProvider;
class GrRenderTargetOpList;
class GrRenderTargetContext;
class GrSurfaceProxy;
class SkColorSpace;
class SkSurfaceProps;
* This is the base class from which all pre-flush callback objects must be derived. It
* provides the "preFlush" / "postFlush" interface.
class GrOnFlushCallbackObject {
virtual ~GrOnFlushCallbackObject() { }
* The onFlush callback allows subsystems (e.g., text, path renderers) to create atlases
* for a specific flush. All the GrOpList IDs required for the flush are passed into the
* callback. The callback should return the render target contexts used to render the atlases
* in 'results'.
virtual void preFlush(GrOnFlushResourceProvider*,
const uint32_t* opListIDs, int numOpListIDs,
SkTArray<sk_sp<GrRenderTargetContext>>* results) = 0;
* Called once flushing is complete and all ops indicated by preFlush have been executed and
* released. startTokenForNextFlush can be used to track resources used in the current flush.
virtual void postFlush(GrDeferredUploadToken startTokenForNextFlush,
const uint32_t* opListIDs, int numOpListIDs) {}
* Tells the callback owner to hold onto this object when freeing GPU resources
* In particular, GrDrawingManager::freeGPUResources() deletes all the path renderers.
* Any OnFlushCallbackObject associated with a path renderer will need to be deleted.
virtual bool retainOnFreeGpuResources() { return false; }
* This class is a shallow wrapper around the drawing manager. It is passed into the
* onFlush callbacks and is intended to limit the functionality available to them.
* It should never have additional data members or virtual methods.
class GrOnFlushResourceProvider {
explicit GrOnFlushResourceProvider(GrDrawingManager* drawingMgr) : fDrawingMgr(drawingMgr) {}
sk_sp<GrRenderTargetContext> makeRenderTargetContext(const GrSurfaceDesc&,
const SkSurfaceProps*);
sk_sp<GrRenderTargetContext> makeRenderTargetContext(sk_sp<GrSurfaceProxy>,
const SkSurfaceProps*);
// Proxy unique key management. See GrProxyProvider.
bool assignUniqueKeyToProxy(const GrUniqueKey&, GrTextureProxy*);
void removeUniqueKeyFromProxy(const GrUniqueKey&, GrTextureProxy*);
sk_sp<GrTextureProxy> findOrCreateProxyByUniqueKey(const GrUniqueKey&, GrSurfaceOrigin);
bool instatiateProxy(GrSurfaceProxy*);
// Creates a GPU buffer with a "dynamic" access pattern.
sk_sp<GrBuffer> makeBuffer(GrBufferType, size_t, const void* data = nullptr);
// Either finds and refs, or creates a static GPU buffer with the given data.
sk_sp<const GrBuffer> findOrMakeStaticBuffer(GrBufferType, size_t, const void* data,
const GrUniqueKey&);
const GrCaps* caps() const;
GrOnFlushResourceProvider(const GrOnFlushResourceProvider&) = delete;
GrOnFlushResourceProvider& operator=(const GrOnFlushResourceProvider&) = delete;
GrDrawingManager* fDrawingMgr;