Flutter Engine
The Flutter Engine
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
GrAttachment Class Reference

#include <GrAttachment.h>

Inheritance diagram for GrAttachment:
GrSurface GrGpuResource GrIORef< GrGpuResource > SkNoncopyable GrD3DAttachment GrGLAttachment GrMockAttachment GrMtlAttachment GrVkImage

Public Types

enum class  UsageFlags : uint8_t { kStencilAttachment = 0x1 , kColorAttachment = 0x2 , kTexture = 0x4 }
 
- Public Types inherited from GrSurface
typedef void * ReleaseCtx
 
typedef void(* ReleaseProc) (ReleaseCtx)
 
- Public Types inherited from GrIORef< GrGpuResource >
enum  LastRemovedRef
 

Public Member Functions

 GR_DECL_BITFIELD_CLASS_OPS_FRIENDS (UsageFlags)
 
 ~GrAttachment () override
 
UsageFlags supportedUsages () const
 
int numSamples () const
 
skgpu::Mipmapped mipmapped () const
 
bool hasPerformedInitialClear () const
 
void markHasPerformedInitialClear ()
 
- Public Member Functions inherited from GrSurface
SkISize dimensions () const
 
int width () const
 
int height () const
 
SkRect getBoundsRect () const
 
virtual GrBackendFormat backendFormat () const =0
 
void setRelease (sk_sp< skgpu::RefCntedCallback > releaseHelper)
 
void setRelease (ReleaseProc proc, ReleaseCtx ctx)
 
virtual GrTextureasTexture ()
 
virtual const GrTextureasTexture () const
 
virtual GrRenderTargetasRenderTarget ()
 
virtual const GrRenderTargetasRenderTarget () const
 
GrInternalSurfaceFlags flags () const
 
bool readOnly () const
 
bool framebufferOnly () const
 
bool isProtected () const
 
void setFramebufferOnly ()
 
- Public Member Functions inherited from GrGpuResource
bool wasDestroyed () const
 
const GrDirectContextgetContext () const
 
GrDirectContextgetContext ()
 
size_t gpuMemorySize () const
 
UniqueID uniqueID () const
 
const skgpu::UniqueKeygetUniqueKey () const
 
std::string getLabel () const
 
void setLabel (std::string_view label)
 
CacheAccess cacheAccess ()
 
const CacheAccess cacheAccess () const
 
ProxyAccess proxyAccess ()
 
ResourcePriv resourcePriv ()
 
const ResourcePriv resourcePriv () const
 
virtual void dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const
 
virtual const char * getResourceType () const =0
 
- Public Member Functions inherited from GrIORef< GrGpuResource >
bool unique () const
 
void ref () const
 
void unref () const
 
void refCommandBuffer () const
 
void unrefCommandBuffer () const
 
- Public Member Functions inherited from SkNoncopyable
 SkNoncopyable ()=default
 
 SkNoncopyable (SkNoncopyable &&)=default
 
SkNoncopyableoperator= (SkNoncopyable &&)=default
 

Static Public Member Functions

static void ComputeSharedAttachmentUniqueKey (const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, UsageFlags requiredUsage, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected isProtected, GrMemoryless memoryless, skgpu::UniqueKey *key)
 
static void ComputeScratchKey (const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, UsageFlags requiredUsage, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected, GrMemoryless, skgpu::ScratchKey *key)
 
- Static Public Member Functions inherited from GrSurface
static size_t ComputeSize (const GrBackendFormat &, SkISize dimensions, int colorSamplesPerPixel, skgpu::Mipmapped, bool binSize=false)
 
- Static Public Member Functions inherited from GrGpuResource
static uint32_t CreateUniqueID ()
 

Protected Member Functions

 GrAttachment (GrGpu *gpu, SkISize dimensions, UsageFlags supportedUsages, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected isProtected, std::string_view label, GrMemoryless memoryless=GrMemoryless::kNo)
 
- Protected Member Functions inherited from GrSurface
void setGLRTFBOIDIs0 ()
 
bool glRTFBOIDis0 () const
 
void setRequiresManualMSAAResolve ()
 
bool requiresManualMSAAResolve () const
 
void setReadOnly ()
 
void setVkRTSupportsInputAttachment ()
 
 GrSurface (GrGpu *gpu, const SkISize &dimensions, skgpu::Protected isProtected, std::string_view label)
 
 ~GrSurface () override
 
void onRelease () override
 
void onAbandon () override
 
- Protected Member Functions inherited from GrGpuResource
void registerWithCache (skgpu::Budgeted)
 
void registerWithCacheWrapped (GrWrapCacheable)
 
 GrGpuResource (GrGpu *, std::string_view label)
 
virtual ~GrGpuResource ()
 
GrGpugetGpu () const
 
virtual void onRelease ()
 
virtual void onAbandon ()
 
virtual void setMemoryBacking (SkTraceMemoryDump *, const SkString &) const
 
SkString getResourceName () const
 
void dumpMemoryStatisticsPriv (SkTraceMemoryDump *traceMemoryDump, const SkString &resourceName, const char *type, size_t size) const
 
- Protected Member Functions inherited from GrIORef< GrGpuResource >
 GrIORef ()
 
bool internalHasRef () const
 
bool internalHasNoCommandBufferUsages () const
 
void addInitialRef () const
 

Detailed Description

This is a generic attachment class for out GrSurfaces. It always represents a single gpu allocation. It contains usage flags so that we know what the attachment can be used for.

TODO: Once we can pull out GrRenderTarget to be more of a framebuffer and break apart our texture render target diamond, we will merge this class with GrSurface. Until then this will act as the staging class for the new surface and framebuffer world.

Definition at line 25 of file GrAttachment.h.

Member Enumeration Documentation

◆ UsageFlags

enum class GrAttachment::UsageFlags : uint8_t
strong
Enumerator
kStencilAttachment 
kColorAttachment 
kTexture 

Definition at line 27 of file GrAttachment.h.

27 : uint8_t {
28 kStencilAttachment = 0x1,
29 kColorAttachment = 0x2,
30 kTexture = 0x4,
31 };

Constructor & Destructor Documentation

◆ ~GrAttachment()

GrAttachment::~GrAttachment ( )
inlineoverride

Definition at line 34 of file GrAttachment.h.

34{}

◆ GrAttachment()

GrAttachment::GrAttachment ( GrGpu gpu,
SkISize  dimensions,
UsageFlags  supportedUsages,
int  sampleCnt,
skgpu::Mipmapped  mipmapped,
GrProtected  isProtected,
std::string_view  label,
GrMemoryless  memoryless = GrMemoryless::kNo 
)
inlineprotected

Definition at line 73 of file GrAttachment.h.

81 : INHERITED(gpu, dimensions, isProtected, label)
82 , fSupportedUsages(supportedUsages)
83 , fSampleCnt(sampleCnt)
84 , fMipmapped(mipmapped)
85 , fMemoryless(memoryless) {}
skgpu::Mipmapped mipmapped() const
Definition: GrAttachment.h:40
UsageFlags supportedUsages() const
Definition: GrAttachment.h:36
SkISize dimensions() const
Definition: GrSurface.h:27
bool isProtected() const
Definition: GrSurface.h:87

Member Function Documentation

◆ ComputeScratchKey()

void GrAttachment::ComputeScratchKey ( const GrCaps caps,
const GrBackendFormat format,
SkISize  dimensions,
UsageFlags  requiredUsage,
int  sampleCnt,
skgpu::Mipmapped  mipmapped,
GrProtected  isProtected,
GrMemoryless  memoryless,
skgpu::ScratchKey key 
)
static

Definition at line 81 of file GrAttachment.cpp.

89 {
91
93 build_key(&builder, caps, format, dimensions, requiredUsage, sampleCnt, mipmapped, isProtected,
94 memoryless);
95}
static void build_key(skgpu::ResourceKey::Builder *builder, const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, GrAttachment::UsageFlags requiredUsage, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected isProtected, GrMemoryless memoryless)
static ResourceType GenerateResourceType()
Definition: ResourceKey.cpp:16
uint32_t ResourceType
Definition: ResourceKey.h:200
uint32_t uint32_t * format

◆ ComputeSharedAttachmentUniqueKey()

void GrAttachment::ComputeSharedAttachmentUniqueKey ( const GrCaps caps,
const GrBackendFormat format,
SkISize  dimensions,
UsageFlags  requiredUsage,
int  sampleCnt,
skgpu::Mipmapped  mipmapped,
GrProtected  isProtected,
GrMemoryless  memoryless,
skgpu::UniqueKey key 
)
static

Definition at line 65 of file GrAttachment.cpp.

73 {
75
77 build_key(&builder, caps, format, dimensions, requiredUsage, sampleCnt, mipmapped, isProtected,
78 memoryless);
79}
static Domain GenerateDomain()
Definition: ResourceKey.cpp:27

◆ GR_DECL_BITFIELD_CLASS_OPS_FRIENDS()

GrAttachment::GR_DECL_BITFIELD_CLASS_OPS_FRIENDS ( UsageFlags  )

◆ hasPerformedInitialClear()

bool GrAttachment::hasPerformedInitialClear ( ) const
inline

Definition at line 42 of file GrAttachment.h.

42{ return fHasPerformedInitialClear; }

◆ markHasPerformedInitialClear()

void GrAttachment::markHasPerformedInitialClear ( )
inline

Definition at line 43 of file GrAttachment.h.

43{ fHasPerformedInitialClear = true; }

◆ mipmapped()

skgpu::Mipmapped GrAttachment::mipmapped ( ) const
inline

Definition at line 40 of file GrAttachment.h.

40{ return fMipmapped; }

◆ numSamples()

int GrAttachment::numSamples ( ) const
inline

Definition at line 38 of file GrAttachment.h.

38{ return fSampleCnt; }

◆ supportedUsages()

UsageFlags GrAttachment::supportedUsages ( ) const
inline

Definition at line 36 of file GrAttachment.h.

36{ return fSupportedUsages; }

The documentation for this class was generated from the following files: