#include <MtlComputePipeline.h>

Inheritance diagram for skgpu::graphite::MtlComputePipeline:

Public Types
using	MSLFunction = std::pair< id< MTLLibrary >, std::string >

Public Member Functions
	~MtlComputePipeline () override=default

id< MTLComputePipelineState >	mtlPipelineState () const

Public Member Functions inherited from skgpu::graphite::ComputePipeline
	~ComputePipeline () override=default

const char *	getResourceType () const override

Public Member Functions inherited from skgpu::graphite::Resource
	Resource (const Resource &)=delete

	Resource (Resource &&)=delete

Resource &	operator= (const Resource &)=delete

Resource &	operator= (Resource &&)=delete

void	ref () const

void	unref () const

void	refCommandBuffer () const

void	unrefCommandBuffer () const

Ownership	ownership () const

skgpu::Budgeted	budgeted () const

size_t	gpuMemorySize () const

UniqueID	uniqueID () const

std::string	getLabel () const

void	setLabel (std::string_view label)

bool	wasDestroyed () const

const GraphiteResourceKey &	key () const

void	setKey (const GraphiteResourceKey &key)

void	dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const

virtual void	prepareForReturnToCache (const std::function< void()> &takeRef)

Static Public Member Functions
static sk_sp< MtlComputePipeline >	Make (const MtlSharedContext *, const std::string &label, MSLFunction computeMain)

Private Member Functions
void	freeGpuData () override

Additional Inherited Members
Protected Member Functions inherited from skgpu::graphite::ComputePipeline
	ComputePipeline (const SharedContext *)

Protected Member Functions inherited from skgpu::graphite::Resource
	Resource (const SharedContext *, Ownership, skgpu::Budgeted, size_t gpuMemorySize, std::string_view label, bool commandBufferRefsAsUsageRefs=false)

virtual	~Resource ()

const SharedContext *	sharedContext () const

virtual void	invokeReleaseProc ()

virtual void	onDumpMemoryStatistics (SkTraceMemoryDump traceMemoryDump, const char dumpName) const

void	setDeleteASAP ()

Detailed Description

Definition at line 23 of file MtlComputePipeline.h.

Member Typedef Documentation

◆ MSLFunction

using skgpu::graphite::MtlComputePipeline::MSLFunction = std::pair<id<MTLLibrary>, std::string>

Definition at line 25 of file MtlComputePipeline.h.

Constructor & Destructor Documentation

◆ ~MtlComputePipeline()

skgpu::graphite::MtlComputePipeline::~MtlComputePipeline ( )

overridedefault

Member Function Documentation

◆ freeGpuData()

void skgpu::graphite::MtlComputePipeline::freeGpuData ( )

overrideprivatevirtual

Implements skgpu::graphite::Resource.

Definition at line 63 of file MtlComputePipeline.mm.

63{ fPipelineState.reset(); }

◆ Make()

sk_sp< MtlComputePipeline > skgpu::graphite::MtlComputePipeline::Make	(	const MtlSharedContext *	sharedContext,
		const std::string &	label,
		MSLFunction	computeMain
	)

static

Definition at line 22 of file MtlComputePipeline.mm.

                                                                            {
    id<MTLLibrary> library = std::get<0>(computeMain);
    if (!library) {
        return nullptr;
    }
 
    sk_cfp<MTLComputePipelineDescriptor*> psoDescriptor([MTLComputePipelineDescriptor new]);
 
    (*psoDescriptor).label = @(label.c_str());
 
    NSString* entryPointName = [NSString stringWithUTF8String:std::get<1>(computeMain).c_str()];
    (*psoDescriptor).computeFunction = [library newFunctionWithName:entryPointName];
 
    // TODO(b/240604614): Populate input data attribute and buffer layout descriptors using the
    // `stageInputDescriptor` property based on the contents of `pipelineDesc` (on iOS 10+ or
    // macOS 10.12+).
 
    // TODO(b/240604614): Define input buffer mutability using the `buffers` property based on
    // the contents of `pipelineDesc` (on iOS 11+ or macOS 10.13+).
 
    // TODO(b/240615224): Metal docs claim that setting the
    // `threadGroupSizeIsMultipleOfThreadExecutionWidth` to YES may improve performance, IF we can
    // guarantee that the thread group size used in a dispatch command is a multiple of
    // `threadExecutionWidth` property of the pipeline state object (otherwise this will cause UB).
 
    NSError* error;
    sk_cfp<id<MTLComputePipelineState>> pso([sharedContext->device()
            newComputePipelineStateWithDescriptor:psoDescriptor.get()
                                          options:MTLPipelineOptionNone
                                       reflection:nil
                                            error:&error]);
    if (!pso) {
        SKGPU_LOG_E("Compute pipeline creation failure:\n%s", error.debugDescription.UTF8String);
        return nullptr;
    }
 
    return sk_sp<MtlComputePipeline>(new MtlComputePipeline(sharedContext, std::move(pso)));
}

◆ mtlPipelineState()

id< MTLComputePipelineState > skgpu::graphite::MtlComputePipeline::mtlPipelineState ( ) const

inline

Definition at line 32 of file MtlComputePipeline.h.

32{ return fPipelineState.get(); }

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

third_party/skia/src/gpu/graphite/mtl/MtlComputePipeline.h
third_party/skia/src/gpu/graphite/mtl/MtlComputePipeline.mm

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members