blob: 2a2deb269923e15a11f6265dda893554e9b994bd [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 "include/core/SkSpan.h"
#include "src/gpu/ganesh/GrDeferredUpload.h"
class GrCaps;
class GrDrawingManager;
class GrOnFlushResourceProvider;
class GrSurfaceProxy;
/*
* This is the base class from which all pre-flush callback objects must be derived. It
* provides the "preFlush" / "postFlush" interface.
*/
class GrOnFlushCallbackObject {
public:
virtual ~GrOnFlushCallbackObject() {}
/*
* The preFlush callback allows subsystems (e.g., text, path renderers) to create atlases
* for a specific flush.
*
* Returns true on success; false on memory allocation failure
*/
virtual bool preFlush(GrOnFlushResourceProvider*) = 0;
/**
* Called once flushing is complete. startTokenForNextFlush can be used to track resources
* used in the current flush.
*/
virtual void postFlush(skgpu::AtlasToken startTokenForNextFlush) {}
/**
* Tells the callback owner to hold onto this object when freeing GPU resources.
*/
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 {
public:
explicit GrOnFlushResourceProvider(GrDrawingManager* drawingMgr) : fDrawingMgr(drawingMgr) {}
[[nodiscard]] bool instantiateProxy(GrSurfaceProxy*);
const GrCaps* caps() const;
#if defined(GR_TEST_UTILS)
bool failFlushTimeCallbacks() const;
#endif
private:
GrOnFlushResourceProvider(const GrOnFlushResourceProvider&) = delete;
GrOnFlushResourceProvider& operator=(const GrOnFlushResourceProvider&) = delete;
GrDrawingManager* fDrawingMgr;
};
#endif