#include <GrMtlBuffer.h>

Inheritance diagram for GrMtlBuffer:

Public Member Functions
	~GrMtlBuffer () override

id< MTLBuffer >	mtlBuffer () const

Public Member Functions inherited from GrGpuBuffer
GrAccessPattern	accessPattern () const

size_t	size () const final

void	ref () const final

void	unref () const final

void *	map ()

void	unmap ()

bool	isMapped () const

bool	isCpuBuffer () const final

bool	clearToZero ()

bool	updateData (const void *src, size_t offset, size_t size, bool preserve)

GrGpuBufferType	intendedType () const

Public Member Functions inherited from GrGpuResource
bool	wasDestroyed () const

const GrDirectContext *	getContext () const

GrDirectContext *	getContext ()

size_t	gpuMemorySize () const

UniqueID	uniqueID () const

const skgpu::UniqueKey &	getUniqueKey () 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

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

SkNoncopyable &	operator= (SkNoncopyable &&)=default

Public Member Functions inherited from GrBuffer
	GrBuffer (const GrBuffer &)=delete

GrBuffer &	operator= (const GrBuffer &)=delete

virtual	~GrBuffer ()=default

Static Public Member Functions
static sk_sp< GrMtlBuffer >	Make (GrMtlGpu *, size_t size, GrGpuBufferType intendedType, GrAccessPattern)

Static Public Member Functions inherited from GrGpuBuffer
static void	ComputeScratchKeyForDynamicBuffer (size_t size, GrGpuBufferType, skgpu::ScratchKey *)

Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Protected Member Functions
	GrMtlBuffer (GrMtlGpu *, size_t size, GrGpuBufferType intendedType, GrAccessPattern, std::string_view label)

void	onAbandon () override

void	onRelease () override

Protected Member Functions inherited from GrGpuBuffer
	GrGpuBuffer (GrGpu *, size_t sizeInBytes, GrGpuBufferType, GrAccessPattern, std::string_view label)

Protected Member Functions inherited from GrGpuResource
void	registerWithCache (skgpu::Budgeted)

void	registerWithCacheWrapped (GrWrapCacheable)

	GrGpuResource (GrGpu *, std::string_view label)

virtual	~GrGpuResource ()

GrGpu *	getGpu () const

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

Protected Member Functions inherited from GrBuffer
	GrBuffer ()=default

Private Member Functions
void	onMap (MapType) override

bool	onClearToZero () override

void	onUnmap (MapType) override

bool	onUpdateData (const void *src, size_t offset, size_t size, bool preserve) override

void	onSetLabel () override

Additional Inherited Members
Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef

Protected Types inherited from GrGpuBuffer
enum class	MapType { kRead , kWriteDiscard }

Protected Attributes inherited from GrGpuBuffer
void *	fMapPtr

Detailed Description

Definition at line 19 of file GrMtlBuffer.h.

Constructor & Destructor Documentation

◆ ~GrMtlBuffer()

GrMtlBuffer::~GrMtlBuffer ( )

override

Definition at line 81 of file GrMtlBuffer.mm.

                          {
    SkASSERT(!fMtlBuffer);
    SkASSERT(!fMapPtr);
}

◆ GrMtlBuffer()

GrMtlBuffer::GrMtlBuffer	(	GrMtlGpu *	gpu,
		size_t	size,
		GrGpuBufferType	intendedType,
		GrAccessPattern	accessPattern,
		std::string_view	label
	)

protected

Definition at line 49 of file GrMtlBuffer.mm.

        : INHERITED(gpu, size, intendedType, accessPattern, label)
        , fIsDynamic(accessPattern != kStatic_GrAccessPattern) {
    NSUInteger options = 0;
    if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
        if (fIsDynamic) {
#ifdef SK_BUILD_FOR_MAC
            if (gpu->mtlCaps().isMac()) {
                options |= MTLResourceStorageModeManaged;
            } else {
                options |= MTLResourceStorageModeShared;
            }
#else
            options |= MTLResourceStorageModeShared;
#endif
        } else {
            options |= MTLResourceStorageModePrivate;
        }
    }
 
    size = SkAlignTo(size, gpu->mtlCaps().getMinBufferAlignment());
    fMtlBuffer = size == 0 ? nil :
            [gpu->device() newBufferWithLength: size
                                       options: options];
#ifdef SK_ENABLE_MTL_DEBUG_INFO
    fMtlBuffer.label = kBufferTypeNames[(int)intendedType];
#endif
    this->registerWithCache(skgpu::Budgeted::kYes);
    VALIDATE();
}

Member Function Documentation

◆ Make()

GR_NORETAIN_BEGIN sk_sp< GrMtlBuffer > GrMtlBuffer::Make	(	GrMtlGpu *	gpu,
		size_t	size,
		GrGpuBufferType	intendedType,
		GrAccessPattern	accessPattern
	)

static

Definition at line 38 of file GrMtlBuffer.mm.

                                                                    {
    return sk_sp<GrMtlBuffer>(new GrMtlBuffer(gpu,
                                              size,
                                              intendedType,
                                              accessPattern,
                                              /*label=*/"MakeMtlBuffer"));
}

◆ mtlBuffer()

id< MTLBuffer > GrMtlBuffer::mtlBuffer ( ) const

inline

Definition at line 28 of file GrMtlBuffer.h.

28{ return fMtlBuffer; }

◆ onAbandon()

void GrMtlBuffer::onAbandon ( )

overrideprotectedvirtual

Overridden to abandon any internal handles, ptrs, etc to backend API resources. This may be called when the underlying 3D context is no longer valid and so no backend API calls should be made.

Reimplemented from GrGpuResource.

Definition at line 135 of file GrMtlBuffer.mm.

                            {
    fMtlBuffer = nil;
    fMapPtr = nullptr;
    VALIDATE();
    INHERITED::onAbandon();
}

◆ onClearToZero()

bool GrMtlBuffer::onClearToZero ( )

overrideprivatevirtual

Implements GrGpuBuffer.

Definition at line 186 of file GrMtlBuffer.mm.

                                {
    SkASSERT(fMtlBuffer);
    GrMtlCommandBuffer* cmdBuffer = this->mtlGpu()->commandBuffer();
    id<MTLBlitCommandEncoder> GR_NORETAIN blitCmdEncoder = cmdBuffer->getBlitCommandEncoder();
    if (!blitCmdEncoder) {
        return false;
    }
 
    NSRange range{0, this->size()};
    [blitCmdEncoder fillBuffer: fMtlBuffer range: range value: 0];
 
    cmdBuffer->addGrBuffer(sk_ref_sp(this));
 
    return true;
}

◆ onMap()

void GrMtlBuffer::onMap ( MapType )

overrideprivatevirtual

Implements GrGpuBuffer.

Definition at line 178 of file GrMtlBuffer.mm.

                               {
    this->internalMap();
}

◆ onRelease()

void GrMtlBuffer::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Definition at line 142 of file GrMtlBuffer.mm.

                            {
    if (!this->wasDestroyed()) {
        VALIDATE();
        fMtlBuffer = nil;
        fMapPtr = nullptr;
        VALIDATE();
    }
    INHERITED::onRelease();
}

◆ onSetLabel()

void GrMtlBuffer::onSetLabel ( )

overrideprivatevirtual

Reimplemented from GrGpuBuffer.

Definition at line 215 of file GrMtlBuffer.mm.

                             {
    SkASSERT(fMtlBuffer);
    if (!this->getLabel().empty()) {
        NSString* labelStr = @(this->getLabel().c_str());
        fMtlBuffer.label = [@"_Skia_" stringByAppendingString:labelStr];
    }
}

◆ onUnmap()

void GrMtlBuffer::onUnmap ( MapType type )

overrideprivatevirtual

Implements GrGpuBuffer.

Definition at line 182 of file GrMtlBuffer.mm.

                                      {
    this->internalUnmap(0, type == MapType::kWriteDiscard ? this-> size() : 0);
}

◆ onUpdateData()

bool GrMtlBuffer::onUpdateData	(	const void *	src,
		size_t	offset,
		size_t	size,
		bool	preserve
	)

overrideprivatevirtual

Implements GrGpuBuffer.

Definition at line 86 of file GrMtlBuffer.mm.

                                                                                         {
    if (fIsDynamic) {
        this->internalMap();
        if (!fMapPtr) {
            return false;
        }
        memcpy(SkTAddOffset<void>(fMapPtr, offset), src, size);
        this->internalUnmap(offset, size);
        return true;
    }
    // Update via transfer buffer.
 
    // We have to respect the transfer alignment. So we may transfer some extra bytes before and
    // after the region to be updated.
    size_t transferAlignment = this->getGpu()->caps()->transferFromBufferToBufferAlignment();
    size_t r = offset%transferAlignment;
    SkASSERT(!preserve || r == 0);  // We can't push extra bytes when preserving.
 
    offset -= r;
    size_t transferSize = SkAlignTo(size + r, transferAlignment);
 
    GrStagingBufferManager::Slice slice;
    slice = this->mtlGpu()->stagingBufferManager()->allocateStagingBufferSlice(
            transferSize, this->mtlGpu()->mtlCaps().getMinBufferAlignment());
    if (!slice.fBuffer) {
        return false;
    }
    memcpy(SkTAddOffset<void>(slice.fOffsetMapPtr, r), src, size);
 
    GrMtlCommandBuffer* cmdBuffer = this->mtlGpu()->commandBuffer();
    id<MTLBlitCommandEncoder> GR_NORETAIN blitCmdEncoder = cmdBuffer->getBlitCommandEncoder();
    if (!blitCmdEncoder) {
        return false;
    }
    GrMtlBuffer* mtlBuffer = static_cast<GrMtlBuffer*>(slice.fBuffer);
    id<MTLBuffer> transferBuffer = mtlBuffer->mtlBuffer();
    [blitCmdEncoder copyFromBuffer: transferBuffer
                      sourceOffset: slice.fOffset
                          toBuffer: fMtlBuffer
                 destinationOffset: offset
                              size: transferSize];
    return true;
}

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

third_party/skia/src/gpu/ganesh/mtl/GrMtlBuffer.h
third_party/skia/src/gpu/ganesh/mtl/GrMtlBuffer.mm

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GrMtlBuffer()

◆ GrMtlBuffer()

Member Function Documentation

◆ Make()

◆ mtlBuffer()

◆ onAbandon()

◆ onClearToZero()

◆ onMap()

◆ onRelease()

◆ onSetLabel()

◆ onUnmap()

◆ onUpdateData()