skgpu::graphite::MtlComputeCommandEncoder Class Reference

#include <MtlComputeCommandEncoder.h>

Inheritance diagram for skgpu::graphite::MtlComputeCommandEncoder:

Public Member Functions
const char *	getResourceType () const override
void	setLabel (NSString *label)
void	pushDebugGroup (NSString *string)
void	popDebugGroup ()
void	insertDebugSignpost (NSString *string)
void	setComputePipelineState (id< MTLComputePipelineState > pso)
void	setBuffer (id< MTLBuffer > buffer, NSUInteger offset, NSUInteger index)
void	setBufferOffset (NSUInteger offset, NSUInteger index) SK_API_AVAILABLE(macos(10.11)
void	ios (8.3)
void	tvos (9.0))
void	setTexture (id< MTLTexture > texture, NSUInteger index)
void	setSamplerState (id< MTLSamplerState > sampler, NSUInteger index)
void	setThreadgroupMemoryLength (NSUInteger length, NSUInteger index)
void	dispatchThreadgroups (const WorkgroupSize &globalSize, const WorkgroupSize &localSize)
void	dispatchThreadgroupsWithIndirectBuffer (id< MTLBuffer > indirectBuffer, NSUInteger offset, const WorkgroupSize &localSize)
void	endEncoding ()
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< MtlComputeCommandEncoder >	Make (const SharedContext *sharedContext, id< MTLCommandBuffer > commandBuffer)

Private Member Functions
void	freeGpuData () override

Additional Inherited Members
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

Wraps a MTLComputeCommandEncoder object and associated tracked state

Definition at line 23 of file MtlComputeCommandEncoder.h.

Member Function Documentation

dispatchThreadgroups()

void skgpu::graphite::MtlComputeCommandEncoder::dispatchThreadgroups ( const WorkgroupSize &  globalSize, const WorkgroupSize &  localSize  )

inline

Definition at line 103 of file MtlComputeCommandEncoder.h.

                                                                                               {
        MTLSize threadgroupCount =
                MTLSizeMake(globalSize.fWidth, globalSize.fHeight, globalSize.fDepth);
        MTLSize threadsPerThreadgroup =
                MTLSizeMake(localSize.fWidth, localSize.fHeight, localSize.fDepth);
        [(*fCommandEncoder) dispatchThreadgroups:threadgroupCount
                           threadsPerThreadgroup:threadsPerThreadgroup];
    }

dispatchThreadgroupsWithIndirectBuffer()

void skgpu::graphite::MtlComputeCommandEncoder::dispatchThreadgroupsWithIndirectBuffer ( id< MTLBuffer >  indirectBuffer, NSUInteger  offset, const WorkgroupSize &  localSize  )

inline

Definition at line 112 of file MtlComputeCommandEncoder.h.

                                                                                {
        MTLSize threadsPerThreadgroup =
                MTLSizeMake(localSize.fWidth, localSize.fHeight, localSize.fDepth);
        [(*fCommandEncoder) dispatchThreadgroupsWithIndirectBuffer:indirectBuffer
                                              indirectBufferOffset:offset
                                             threadsPerThreadgroup:threadsPerThreadgroup];
    }

endEncoding()

void skgpu::graphite::MtlComputeCommandEncoder::endEncoding ( )

inline

Definition at line 122 of file MtlComputeCommandEncoder.h.

{ [(*fCommandEncoder) endEncoding]; }

freeGpuData()

void skgpu::graphite::MtlComputeCommandEncoder::freeGpuData ( )

inlineoverrideprivatevirtual

Implements skgpu::graphite::Resource.

Definition at line 145 of file MtlComputeCommandEncoder.h.

{ fCommandEncoder.reset(); }

getResourceType()

const char * skgpu::graphite::MtlComputeCommandEncoder::getResourceType ( ) const

inlineoverridevirtual

Implements skgpu::graphite::Resource.

Definition at line 41 of file MtlComputeCommandEncoder.h.

{ return "Metal Compute Command Encoder"; }

insertDebugSignpost()

void skgpu::graphite::MtlComputeCommandEncoder::insertDebugSignpost ( NSString *  string )

inline

Definition at line 47 of file MtlComputeCommandEncoder.h.

{ [(*fCommandEncoder) insertDebugSignpost:string]; }

ios()

void skgpu::graphite::MtlComputeCommandEncoder::ios

(

8.

3

)

Make()

static sk_sp< MtlComputeCommandEncoder > skgpu::graphite::MtlComputeCommandEncoder::Make ( const SharedContext *  sharedContext, id< MTLCommandBuffer >  commandBuffer  )

inlinestatic

Definition at line 25 of file MtlComputeCommandEncoder.h.

                                                                                    {
        // Inserting a pool here so the autorelease occurs when we return and the
        // only remaining ref is the retain below.
        @autoreleasepool {
            // Adding a retain here to keep our own ref separate from the autorelease pool
            sk_cfp<id<MTLComputeCommandEncoder>> encoder =
                    sk_ret_cfp([commandBuffer computeCommandEncoder]);
 
            // TODO(armansito): Support concurrent dispatch of compute passes using
            // MTLDispatchTypeConcurrent on macOS 10.14+ and iOS 12.0+.
            return sk_sp<MtlComputeCommandEncoder>(
                    new MtlComputeCommandEncoder(sharedContext, std::move(encoder)));
        }
    }

popDebugGroup()

void skgpu::graphite::MtlComputeCommandEncoder::popDebugGroup ( )

inline

Definition at line 46 of file MtlComputeCommandEncoder.h.

{ [(*fCommandEncoder) popDebugGroup]; }

pushDebugGroup()

void skgpu::graphite::MtlComputeCommandEncoder::pushDebugGroup ( NSString *  string )

inline

Definition at line 45 of file MtlComputeCommandEncoder.h.

{ [(*fCommandEncoder) pushDebugGroup:string]; }

setBuffer()

void skgpu::graphite::MtlComputeCommandEncoder::setBuffer ( id< MTLBuffer >  buffer, NSUInteger  offset, NSUInteger  index  )

inline

Definition at line 56 of file MtlComputeCommandEncoder.h.

                                                                              {
        SkASSERT(buffer != nil);
        SkASSERT(index < kMaxExpectedBuffers);
        if (@available(macOS 10.11, iOS 8.3, tvOS 9.0, *)) {
            if (fBuffers[index] == buffer) {
                this->setBufferOffset(offset, index);
                return;
            }
        }
        if (fBuffers[index] != buffer || fBufferOffsets[index] != offset) {
            [(*fCommandEncoder) setBuffer:buffer offset:offset atIndex:index];
            fBuffers[index] = buffer;
            fBufferOffsets[index] = offset;
        }
    }

setBufferOffset()

void skgpu::graphite::MtlComputeCommandEncoder::setBufferOffset	(	NSUInteger	offset,
		NSUInteger	index
	)

setComputePipelineState()

void skgpu::graphite::MtlComputeCommandEncoder::setComputePipelineState ( id< MTLComputePipelineState >  pso )

inline

Definition at line 49 of file MtlComputeCommandEncoder.h.

                                                                  {
        if (fCurrentComputePipelineState != pso) {
            [(*fCommandEncoder) setComputePipelineState:pso];
            fCurrentComputePipelineState = pso;
        }
    }

setLabel()

void skgpu::graphite::MtlComputeCommandEncoder::setLabel ( NSString *  label )

inline

Definition at line 43 of file MtlComputeCommandEncoder.h.

{ [(*fCommandEncoder) setLabel:label]; }

setSamplerState()

void skgpu::graphite::MtlComputeCommandEncoder::setSamplerState ( id< MTLSamplerState >  sampler, NSUInteger  index  )

inline

Definition at line 89 of file MtlComputeCommandEncoder.h.

                                                                        {
        SkASSERT(index < kMaxExpectedTextures);
        if (fSamplers[index] != sampler) {
            [(*fCommandEncoder) setSamplerState:sampler atIndex:index];
            fSamplers[index] = sampler;
        }
    }

setTexture()

void skgpu::graphite::MtlComputeCommandEncoder::setTexture ( id< MTLTexture >  texture, NSUInteger  index  )

inline

Definition at line 81 of file MtlComputeCommandEncoder.h.

                                                              {
        SkASSERT(index < kMaxExpectedTextures);
        if (fTextures[index] != texture) {
            [(*fCommandEncoder) setTexture:texture atIndex:index];
            fTextures[index] = texture;
        }
    }

setThreadgroupMemoryLength()

void skgpu::graphite::MtlComputeCommandEncoder::setThreadgroupMemoryLength ( NSUInteger  length, NSUInteger  index  )

inline

Definition at line 98 of file MtlComputeCommandEncoder.h.

                                                                         {
        SkASSERT(length % 16 == 0);
        [(*fCommandEncoder) setThreadgroupMemoryLength:length atIndex:index];
    }

tvos()

void skgpu::graphite::MtlComputeCommandEncoder::tvos ( 9.  0 )

inline

Definition at line 73 of file MtlComputeCommandEncoder.h.

                                                                {
        SkASSERT(index < kMaxExpectedBuffers);
        if (fBufferOffsets[index] != offset) {
            [(*fCommandEncoder) setBufferOffset:offset atIndex:index];
            fBufferOffsets[index] = offset;
        }
    }

---

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

• third_party/skia/src/gpu/graphite/mtl/MtlComputeCommandEncoder.h