blob: e75589ec97ab030c69d6795c6b0e3a334f280e9a [file] [log] [blame]
* Copyright 2015 Google Inc.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
#ifndef GrTextureProvider_DEFINED
#define GrTextureProvider_DEFINED
#include "GrTexture.h"
#include "SkImageFilter.h"
class GrSingleOwner;
class SK_API GrTextureProvider {
// Textures
* Creates a new texture in the resource cache and returns it. The caller owns a
* ref on the returned texture which must be balanced by a call to unref.
* @param desc Description of the texture properties.
* @param budgeted Does the texture count against the resource cache budget?
* @param srcData Pointer to the pixel values (optional).
* @param rowBytes The number of bytes between rows of the texture. Zero
* implies tightly packed rows. For compressed pixel configs, this
* field is ignored.
GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted, const void* srcData,
size_t rowBytes);
/** Shortcut for creating a texture with no initial data to upload. */
GrTexture* createTexture(const GrSurfaceDesc& desc, SkBudgeted budgeted) {
return this->createTexture(desc, budgeted, NULL, 0);
/** Assigns a unique key to the texture. The texture will be findable via this key using
findTextureByUniqueKey(). If an existing texture has this key, it's key will be removed. */
void assignUniqueKeyToTexture(const GrUniqueKey& key, GrTexture* texture) {
this->assignUniqueKeyToResource(key, texture);
/** Finds a texture by unique key. If the texture is found it is ref'ed and returned. */
GrTexture* findAndRefTextureByUniqueKey(const GrUniqueKey& key);
* Determines whether a texture is associated with the unique key. If the texture is found it
* will not be locked or returned. This call does not affect the priority of the resource for
* deletion.
bool existsTextureWithUniqueKey(const GrUniqueKey& key) const {
return this->existsResourceWithUniqueKey(key);
* Finds a texture that approximately matches the descriptor. Will be at least as large in width
* and height as desc specifies. If desc specifies that the texture should be a render target
* then result will be a render target. Format and sample count will always match the request.
* The contents of the texture are undefined. The caller owns a ref on the returned texture and
* must balance with a call to unref.
GrTexture* createApproxTexture(const GrSurfaceDesc&);
/** Legacy function that no longer should be used. */
enum ScratchTexMatch {
GrTexture* refScratchTexture(const GrSurfaceDesc& desc, ScratchTexMatch match) {
if (kApprox_ScratchTexMatch == match) {
return this->createApproxTexture(desc);
} else {
return this->createTexture(desc, SkBudgeted::kYes);
// Wrapped Backend Surfaces
* Wraps an existing texture with a GrTexture object.
* OpenGL: if the object is a texture Gr may change its GL texture params
* when it is drawn.
* @return GrTexture object or NULL on failure.
GrTexture* wrapBackendTexture(const GrBackendTextureDesc& desc,
GrWrapOwnership = kBorrow_GrWrapOwnership);
* Wraps an existing render target with a GrRenderTarget object. It is
* similar to wrapBackendTexture but can be used to draw into surfaces
* that are not also textures (e.g. FBO 0 in OpenGL, or an MSAA buffer that
* the client will resolve to a texture). Currently wrapped render targets
* always use the kBorrow_GrWrapOwnership semantics.
* @return GrRenderTarget object or NULL on failure.
GrRenderTarget* wrapBackendRenderTarget(const GrBackendRenderTargetDesc& desc);
GrTextureProvider(GrGpu* gpu, GrResourceCache* cache, GrSingleOwner* singleOwner);
* Assigns a unique key to a resource. If the key is associated with another resource that
* association is removed and replaced by this resource.
void assignUniqueKeyToResource(const GrUniqueKey&, GrGpuResource*);
* Finds a resource in the cache, based on the specified key. This is intended for use in
* conjunction with addResourceToCache(). The return value will be NULL if not found. The
* caller must balance with a call to unref().
GrGpuResource* findAndRefResourceByUniqueKey(const GrUniqueKey&);
* Determines whether a resource is in the cache. If the resource is found it
* will not be locked or returned. This call does not affect the priority of
* the resource for deletion.
bool existsResourceWithUniqueKey(const GrUniqueKey& key) const;
enum ScratchTextureFlags {
kExact_ScratchTextureFlag = 0x1,
kNoPendingIO_ScratchTextureFlag = 0x2, // (
kNoCreate_ScratchTextureFlag = 0x4,
/** A common impl for GrTextureProvider and GrResourceProvider variants. */
GrTexture* internalCreateApproxTexture(const GrSurfaceDesc& desc, uint32_t scratchTextureFlags);
GrTexture* refScratchTexture(const GrSurfaceDesc&, uint32_t scratchTextureFlags);
void abandon() {
fCache = NULL;
fGpu = NULL;
GrResourceCache* cache() { return fCache; }
const GrResourceCache* cache() const { return fCache; }
GrGpu* gpu() { return fGpu; }
const GrGpu* gpu() const { return fGpu; }
bool isAbandoned() const {
SkASSERT(SkToBool(fGpu) == SkToBool(fCache));
return !SkToBool(fCache);
GrResourceCache* fCache;
GrGpu* fGpu;
// In debug builds we guard against improper thread handling
SkDEBUGCODE(mutable GrSingleOwner* fSingleOwner;)