123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468 |
- /*
- * Copyright 2010 Google Inc.
- *
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
- #ifndef GrContext_DEFINED
- #define GrContext_DEFINED
- #include "include/core/SkMatrix.h"
- #include "include/core/SkPathEffect.h"
- #include "include/core/SkTypes.h"
- #include "include/gpu/GrBackendSurface.h"
- #include "include/gpu/GrContextOptions.h"
- #include "include/private/GrRecordingContext.h"
- // We shouldn't need this but currently Android is relying on this being include transitively.
- #include "include/core/SkUnPreMultiply.h"
- class GrAtlasManager;
- class GrBackendSemaphore;
- class GrCaps;
- class GrContextPriv;
- class GrContextThreadSafeProxy;
- class GrFragmentProcessor;
- struct GrGLInterface;
- class GrGpu;
- struct GrMockOptions;
- class GrPath;
- class GrRenderTargetContext;
- class GrResourceCache;
- class GrResourceProvider;
- class GrSamplerState;
- class GrSkSLFPFactoryCache;
- class GrSurfaceProxy;
- class GrSwizzle;
- class GrTextContext;
- class GrTextureProxy;
- struct GrVkBackendContext;
- class SkImage;
- class SkSurfaceCharacterization;
- class SkSurfaceProps;
- class SkTaskGroup;
- class SkTraceMemoryDump;
- class SK_API GrContext : public GrRecordingContext {
- public:
- /**
- * Creates a GrContext for a backend context. If no GrGLInterface is provided then the result of
- * GrGLMakeNativeInterface() is used if it succeeds.
- */
- static sk_sp<GrContext> MakeGL(sk_sp<const GrGLInterface>, const GrContextOptions&);
- static sk_sp<GrContext> MakeGL(sk_sp<const GrGLInterface>);
- static sk_sp<GrContext> MakeGL(const GrContextOptions&);
- static sk_sp<GrContext> MakeGL();
- static sk_sp<GrContext> MakeVulkan(const GrVkBackendContext&, const GrContextOptions&);
- static sk_sp<GrContext> MakeVulkan(const GrVkBackendContext&);
- #ifdef SK_METAL
- /**
- * Makes a GrContext which uses Metal as the backend. The device parameter is an MTLDevice
- * and queue is an MTLCommandQueue which should be used by the backend. These objects must
- * have a ref on them which can be transferred to Ganesh which will release the ref when the
- * GrContext is destroyed.
- */
- static sk_sp<GrContext> MakeMetal(void* device, void* queue, const GrContextOptions& options);
- static sk_sp<GrContext> MakeMetal(void* device, void* queue);
- #endif
- #ifdef SK_DAWN
- static sk_sp<GrContext> MakeDawn(const dawn::Device& device, const GrContextOptions& options);
- static sk_sp<GrContext> MakeDawn(const dawn::Device& device);
- #endif
- static sk_sp<GrContext> MakeMock(const GrMockOptions*, const GrContextOptions&);
- static sk_sp<GrContext> MakeMock(const GrMockOptions*);
- ~GrContext() override;
- sk_sp<GrContextThreadSafeProxy> threadSafeProxy();
- /**
- * The GrContext normally assumes that no outsider is setting state
- * within the underlying 3D API's context/device/whatever. This call informs
- * the context that the state was modified and it should resend. Shouldn't
- * be called frequently for good performance.
- * The flag bits, state, is dpendent on which backend is used by the
- * context, either GL or D3D (possible in future).
- */
- void resetContext(uint32_t state = kAll_GrBackendState);
- /**
- * If the backend is GrBackendApi::kOpenGL, then all texture unit/target combinations for which
- * the GrContext has modified the bound texture will have texture id 0 bound. This does not
- * flush the GrContext. Calling resetContext() does not change the set that will be bound
- * to texture id 0 on the next call to resetGLTextureBindings(). After this is called
- * all unit/target combinations are considered to have unmodified bindings until the GrContext
- * subsequently modifies them (meaning if this is called twice in a row with no intervening
- * GrContext usage then the second call is a no-op.)
- */
- void resetGLTextureBindings();
- /**
- * Abandons all GPU resources and assumes the underlying backend 3D API context is no longer
- * usable. Call this if you have lost the associated GPU context, and thus internal texture,
- * buffer, etc. references/IDs are now invalid. Calling this ensures that the destructors of the
- * GrContext and any of its created resource objects will not make backend 3D API calls. Content
- * rendered but not previously flushed may be lost. After this function is called all subsequent
- * calls on the GrContext will fail or be no-ops.
- *
- * The typical use case for this function is that the underlying 3D context was lost and further
- * API calls may crash.
- */
- void abandonContext() override;
- /**
- * Returns true if the context was abandoned.
- */
- using GrImageContext::abandoned;
- /**
- * This is similar to abandonContext() however the underlying 3D context is not yet lost and
- * the GrContext will cleanup all allocated resources before returning. After returning it will
- * assume that the underlying context may no longer be valid.
- *
- * The typical use case for this function is that the client is going to destroy the 3D context
- * but can't guarantee that GrContext will be destroyed first (perhaps because it may be ref'ed
- * elsewhere by either the client or Skia objects).
- */
- virtual void releaseResourcesAndAbandonContext();
- ///////////////////////////////////////////////////////////////////////////
- // Resource Cache
- /**
- * Return the current GPU resource cache limits.
- *
- * @param maxResources If non-null, returns maximum number of resources that
- * can be held in the cache.
- * @param maxResourceBytes If non-null, returns maximum number of bytes of
- * video memory that can be held in the cache.
- */
- void getResourceCacheLimits(int* maxResources, size_t* maxResourceBytes) const;
- /**
- * Gets the current GPU resource cache usage.
- *
- * @param resourceCount If non-null, returns the number of resources that are held in the
- * cache.
- * @param maxResourceBytes If non-null, returns the total number of bytes of video memory held
- * in the cache.
- */
- void getResourceCacheUsage(int* resourceCount, size_t* resourceBytes) const;
- /**
- * Gets the number of bytes in the cache consumed by purgeable (e.g. unlocked) resources.
- */
- size_t getResourceCachePurgeableBytes() const;
- /**
- * Specify the GPU resource cache limits. If the current cache exceeds either
- * of these, it will be purged (LRU) to keep the cache within these limits.
- *
- * @param maxResources The maximum number of resources that can be held in
- * the cache.
- * @param maxResourceBytes The maximum number of bytes of video memory
- * that can be held in the cache.
- */
- void setResourceCacheLimits(int maxResources, size_t maxResourceBytes);
- /**
- * Frees GPU created by the context. Can be called to reduce GPU memory
- * pressure.
- */
- virtual void freeGpuResources();
- /**
- * Purge GPU resources that haven't been used in the past 'msNotUsed' milliseconds or are
- * otherwise marked for deletion, regardless of whether the context is under budget.
- */
- void performDeferredCleanup(std::chrono::milliseconds msNotUsed);
- // Temporary compatibility API for Android.
- void purgeResourcesNotUsedInMs(std::chrono::milliseconds msNotUsed) {
- this->performDeferredCleanup(msNotUsed);
- }
- /**
- * Purge unlocked resources from the cache until the the provided byte count has been reached
- * or we have purged all unlocked resources. The default policy is to purge in LRU order, but
- * can be overridden to prefer purging scratch resources (in LRU order) prior to purging other
- * resource types.
- *
- * @param maxBytesToPurge the desired number of bytes to be purged.
- * @param preferScratchResources If true scratch resources will be purged prior to other
- * resource types.
- */
- void purgeUnlockedResources(size_t bytesToPurge, bool preferScratchResources);
- /**
- * This entry point is intended for instances where an app has been backgrounded or
- * suspended.
- * If 'scratchResourcesOnly' is true all unlocked scratch resources will be purged but the
- * unlocked resources with persistent data will remain. If 'scratchResourcesOnly' is false
- * then all unlocked resources will be purged.
- * In either case, after the unlocked resources are purged a separate pass will be made to
- * ensure that resource usage is under budget (i.e., even if 'scratchResourcesOnly' is true
- * some resources with persistent data may be purged to be under budget).
- *
- * @param scratchResourcesOnly If true only unlocked scratch resources will be purged prior
- * enforcing the budget requirements.
- */
- void purgeUnlockedResources(bool scratchResourcesOnly);
- /**
- * Gets the maximum supported texture size.
- */
- int maxTextureSize() const;
- /**
- * Gets the maximum supported render target size.
- */
- int maxRenderTargetSize() const;
- /**
- * Can a SkImage be created with the given color type.
- */
- bool colorTypeSupportedAsImage(SkColorType) const;
- /**
- * Can a SkSurface be created with the given color type. To check whether MSAA is supported
- * use maxSurfaceSampleCountForColorType().
- */
- bool colorTypeSupportedAsSurface(SkColorType colorType) const {
- return this->maxSurfaceSampleCountForColorType(colorType) > 0;
- }
- /**
- * Gets the maximum supported sample count for a color type. 1 is returned if only non-MSAA
- * rendering is supported for the color type. 0 is returned if rendering to this color type
- * is not supported at all.
- */
- int maxSurfaceSampleCountForColorType(SkColorType) const;
- ///////////////////////////////////////////////////////////////////////////
- // Misc.
- /**
- * Inserts a list of GPU semaphores that the current GPU-backed API must wait on before
- * executing any more commands on the GPU. Skia will take ownership of the underlying semaphores
- * and delete them once they have been signaled and waited on. If this call returns false, then
- * the GPU back-end will not wait on any passed in semaphores, and the client will still own the
- * semaphores.
- */
- bool wait(int numSemaphores, const GrBackendSemaphore* waitSemaphores);
- /**
- * Call to ensure all drawing to the context has been issued to the underlying 3D API.
- */
- void flush() {
- this->flush(GrFlushInfo(), GrPrepareForExternalIORequests());
- }
- /**
- * Call to ensure all drawing to the context has been issued to the underlying 3D API.
- *
- * If this call returns GrSemaphoresSubmitted::kNo, the GPU backend will not have created or
- * added any semaphores to signal on the GPU. Thus the client should not have the GPU wait on
- * any of the semaphores passed in with the GrFlushInfo. However, any pending commands to the
- * context will still be flushed. It should be emphasized that a return value of
- * GrSemaphoresSubmitted::kNo does not mean the flush did not happen. It simply means there were
- * no semaphores submitted to the GPU. A caller should only take this as a failure if they
- * passed in semaphores to be submitted.
- */
- GrSemaphoresSubmitted flush(const GrFlushInfo& info) {
- return this->flush(info, GrPrepareForExternalIORequests());
- }
- /**
- * Call to ensure all drawing to the context has been issued to the underlying 3D API.
- *
- * If this call returns GrSemaphoresSubmitted::kNo, the GPU backend will not have created or
- * added any semaphores to signal on the GPU. Thus the client should not have the GPU wait on
- * any of the semaphores passed in with the GrFlushInfo. However, any pending commands to the
- * context will still be flushed. It should be emphasized that a return value of
- * GrSemaphoresSubmitted::kNo does not mean the flush did not happen. It simply means there were
- * no semaphores submitted to the GPU. A caller should only take this as a failure if they
- * passed in semaphores to be submitted.
- *
- * If the GrPrepareForExternalIORequests contains valid gpu backed SkSurfaces or SkImages, Skia
- * will put the underlying backend objects into a state that is ready for external uses. See
- * declaration of GrPreopareForExternalIORequests for more details.
- */
- GrSemaphoresSubmitted flush(const GrFlushInfo&, const GrPrepareForExternalIORequests&);
- /**
- * Deprecated.
- */
- GrSemaphoresSubmitted flush(GrFlushFlags flags, int numSemaphores,
- GrBackendSemaphore signalSemaphores[],
- GrGpuFinishedProc finishedProc = nullptr,
- GrGpuFinishedContext finishedContext = nullptr) {
- GrFlushInfo info;
- info.fFlags = flags;
- info.fNumSemaphores = numSemaphores;
- info.fSignalSemaphores = signalSemaphores;
- info.fFinishedProc = finishedProc;
- info.fFinishedContext = finishedContext;
- return this->flush(info);
- }
- /**
- * Deprecated.
- */
- GrSemaphoresSubmitted flushAndSignalSemaphores(int numSemaphores,
- GrBackendSemaphore signalSemaphores[]) {
- GrFlushInfo info;
- info.fNumSemaphores = numSemaphores;
- info.fSignalSemaphores = signalSemaphores;
- return this->flush(info);
- }
- /**
- * Checks whether any asynchronous work is complete and if so calls related callbacks.
- */
- void checkAsyncWorkCompletion();
- // Provides access to functions that aren't part of the public API.
- GrContextPriv priv();
- const GrContextPriv priv() const;
- /** Enumerates all cached GPU resources and dumps their memory to traceMemoryDump. */
- // Chrome is using this!
- void dumpMemoryStatistics(SkTraceMemoryDump* traceMemoryDump) const;
- bool supportsDistanceFieldText() const;
- void storeVkPipelineCacheData();
- static size_t ComputeTextureSize(SkColorType type, int width, int height, GrMipMapped,
- bool useNextPow2 = false);
- /*
- * The explicitly allocated backend texture API allows clients to use Skia to create backend
- * objects outside of Skia proper (i.e., Skia's caching system will not know about them.)
- *
- * It is the client's responsibility to delete all these objects (using deleteBackendTexture)
- * before deleting the GrContext used to create them. Additionally, clients should only
- * delete these objects on the thread for which that GrContext is active.
- *
- * The client is responsible for ensuring synchronization between different uses
- * of the backend object (i.e., wrapping it in a surface, rendering to it, deleting the
- * surface, rewrapping it in a image and drawing the image will require explicit
- * sychronization on the client's part).
- */
- // If possible, create an uninitialized backend texture. The client should ensure that the
- // returned backend texture is valid.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_UNDEFINED.
- GrBackendTexture createBackendTexture(int width, int height,
- const GrBackendFormat&,
- GrMipMapped,
- GrRenderable,
- GrProtected = GrProtected::kNo);
- // If possible, create an uninitialized backend texture. The client should ensure that the
- // returned backend texture is valid.
- // If successful, the created backend texture will be compatible with the provided
- // SkColorType.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_UNDEFINED.
- GrBackendTexture createBackendTexture(int width, int height,
- SkColorType,
- GrMipMapped,
- GrRenderable,
- GrProtected = GrProtected::kNo);
- // If possible, create an uninitialized backend texture that is compatible with the
- // provided characterization. The client should ensure that the returned backend texture
- // is valid.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_UNDEFINED.
- GrBackendTexture createBackendTexture(const SkSurfaceCharacterization& characterization);
- // If possible, create a backend texture initialized to a particular color. The client should
- // ensure that the returned backend texture is valid.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL if renderable is kNo
- // and VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL if renderable is kYes
- GrBackendTexture createBackendTexture(int width, int height,
- const GrBackendFormat&,
- const SkColor4f& color,
- GrMipMapped,
- GrRenderable,
- GrProtected = GrProtected::kNo);
- // If possible, create a backend texture initialized to a particular color. The client should
- // ensure that the returned backend texture is valid.
- // If successful, the created backend texture will be compatible with the provided
- // SkColorType.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL if renderable is kNo
- // and VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL if renderable is kYes
- GrBackendTexture createBackendTexture(int width, int height,
- SkColorType,
- const SkColor4f& color,
- GrMipMapped,
- GrRenderable,
- GrProtected = GrProtected::kNo);
- // If possible, create a backend texture initialized to a particular color that is
- // compatible with the provided characterization. The client should ensure that the
- // returned backend texture is valid.
- // For the Vulkan backend the layout of the created VkImage will be:
- // VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
- GrBackendTexture createBackendTexture(const SkSurfaceCharacterization& characterization,
- const SkColor4f& color);
- void deleteBackendTexture(GrBackendTexture);
- protected:
- GrContext(GrBackendApi, const GrContextOptions&, int32_t contextID = SK_InvalidGenID);
- bool init(sk_sp<const GrCaps>, sk_sp<GrSkSLFPFactoryCache>) override;
- GrContext* asDirectContext() override { return this; }
- virtual GrAtlasManager* onGetAtlasManager() = 0;
- sk_sp<GrContextThreadSafeProxy> fThreadSafeProxy;
- private:
- // fTaskGroup must appear before anything that uses it (e.g. fGpu), so that it is destroyed
- // after all of its users. Clients of fTaskGroup will generally want to ensure that they call
- // wait() on it as they are being destroyed, to avoid the possibility of pending tasks being
- // invoked after objects they depend upon have already been destroyed.
- std::unique_ptr<SkTaskGroup> fTaskGroup;
- sk_sp<GrGpu> fGpu;
- GrResourceCache* fResourceCache;
- GrResourceProvider* fResourceProvider;
- bool fDidTestPMConversions;
- // true if the PM/UPM conversion succeeded; false otherwise
- bool fPMUPMConversionsRoundTrip;
- GrContextOptions::PersistentCache* fPersistentCache;
- GrContextOptions::ShaderErrorHandler* fShaderErrorHandler;
- // TODO: have the GrClipStackClip use renderTargetContexts and rm this friending
- friend class GrContextPriv;
- /**
- * These functions create premul <-> unpremul effects, using the specialized round-trip effects
- * from GrConfigConversionEffect.
- */
- std::unique_ptr<GrFragmentProcessor> createPMToUPMEffect(std::unique_ptr<GrFragmentProcessor>);
- std::unique_ptr<GrFragmentProcessor> createUPMToPMEffect(std::unique_ptr<GrFragmentProcessor>);
- typedef GrRecordingContext INHERITED;
- };
- #endif
|