GrMtlCommandBuffer Class Reference

#include <GrMtlCommandBuffer.h>

Inheritance diagram for GrMtlCommandBuffer:

Public Member Functions
	~GrMtlCommandBuffer () override
void	releaseResources ()
bool	commit (bool waitUntilCompleted)
bool	hasWork ()
void	addFinishedCallback (sk_sp< skgpu::RefCntedCallback > callback)
id< MTLBlitCommandEncoder >	getBlitCommandEncoder ()
GrMtlRenderCommandEncoder *	getRenderCommandEncoder (MTLRenderPassDescriptor *, const GrMtlPipelineState *, GrMtlOpsRenderPass *opsRenderPass)
GrMtlRenderCommandEncoder *	getRenderCommandEncoder (MTLRenderPassDescriptor *, GrMtlOpsRenderPass *)
void	addCompletedHandler (MTLCommandBufferHandler block)
void	addResource (const sk_sp< const GrManagedResource > &resource)
void	addGrBuffer (sk_sp< const GrBuffer > buffer)
void	addGrSurface (sk_sp< const GrSurface > surface)
void	encodeSignalEvent (sk_sp< GrMtlEvent >, uint64_t value)
void	encodeWaitForEvent (sk_sp< GrMtlEvent >, uint64_t value)
void	waitUntilCompleted ()
bool	isCompleted ()
void	callFinishedCallbacks ()
void	pushDebugGroup (NSString *string)
void	popDebugGroup ()
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Static Public Member Functions
static sk_sp< GrMtlCommandBuffer >	Make (id< MTLCommandQueue > queue)

Detailed Description

Definition at line 30 of file GrMtlCommandBuffer.h.

Constructor & Destructor Documentation

~GrMtlCommandBuffer()

GrMtlCommandBuffer::~GrMtlCommandBuffer ( )

override

Definition at line 48 of file GrMtlCommandBuffer.mm.

                                        {
    this->endAllEncoding();
    this->releaseResources();
    this->callFinishedCallbacks();
 
    fCmdBuffer = nil;
}

Member Function Documentation

addCompletedHandler()

void GrMtlCommandBuffer::addCompletedHandler ( MTLCommandBufferHandler  block )

inline

Definition at line 53 of file GrMtlCommandBuffer.h.

                                                            {
        [fCmdBuffer addCompletedHandler:block];
    }

addFinishedCallback()

void GrMtlCommandBuffer::addFinishedCallback ( sk_sp< skgpu::RefCntedCallback >  callback )

inline

Definition at line 40 of file GrMtlCommandBuffer.h.

                                                                    {
        fFinishedCallbacks.push_back(std::move(callback));
    }

addGrBuffer()

void GrMtlCommandBuffer::addGrBuffer ( sk_sp< const GrBuffer >  buffer )

inline

Definition at line 63 of file GrMtlCommandBuffer.h.

                                                   {
        fTrackedGrBuffers.push_back(std::move(buffer));
    }

addGrSurface()

void GrMtlCommandBuffer::addGrSurface ( sk_sp< const GrSurface >  surface )

inline

Definition at line 67 of file GrMtlCommandBuffer.h.

                                                      {
        fTrackedGrSurfaces.push_back(std::move(surface));
    }

addResource()

void GrMtlCommandBuffer::addResource ( const sk_sp< const GrManagedResource > &  resource )

inline

Definition at line 57 of file GrMtlCommandBuffer.h.

                                                                     {
// Disable generic resource tracking for now
//        SkASSERT(resource);
//        fTrackedResources.push_back(std::move(resource));
    }

callFinishedCallbacks()

void GrMtlCommandBuffer::callFinishedCallbacks ( )

inline

Definition at line 81 of file GrMtlCommandBuffer.h.

{ fFinishedCallbacks.clear(); }

commit()

bool GrMtlCommandBuffer::commit

(

bool

waitUntilCompleted

)

Definition at line 181 of file GrMtlCommandBuffer.mm.

                                                       {
    this->endAllEncoding();
    if ([fCmdBuffer status] != MTLCommandBufferStatusNotEnqueued) {
        NSLog(@"GrMtlCommandBuffer: Tried to commit command buffer while in invalid state.\n");
        return false;
    }
    [fCmdBuffer commit];
    if (waitUntilCompleted) {
        this->waitUntilCompleted();
#if defined(SK_BUILD_FOR_IOS) && defined(SK_METAL_WAIT_UNTIL_SCHEDULED)
    // If iOS goes into the background we need to make sure all command buffers are scheduled first.
    // We don't have a way of detecting background transition so this guarantees it.
    } else {
        [fCmdBuffer waitUntilScheduled];
#endif
    }
 
    if ([fCmdBuffer status] == MTLCommandBufferStatusError) {
        SkDebugf("Error submitting command buffer.\n");
        if (NSError* error = [fCmdBuffer error]) {
            NSLog(@"%@", error);
        }
    }
 
    return ([fCmdBuffer status] != MTLCommandBufferStatusError);
}

encodeSignalEvent()

void GrMtlCommandBuffer::encodeSignalEvent	(	sk_sp< GrMtlEvent >	event,
		uint64_t	value
	)

Definition at line 220 of file GrMtlCommandBuffer.mm.

                                                                                       {
    SkASSERT(fCmdBuffer);
    this->endAllEncoding(); // ensure we don't have any active command encoders
    if (@available(macOS 10.14, iOS 12.0, tvOS 12.0, *)) {
        [fCmdBuffer encodeSignalEvent:event->mtlEvent() value:eventValue];
        this->addResource(std::move(event));
    }
    fHasWork = true;
}

encodeWaitForEvent()

void GrMtlCommandBuffer::encodeWaitForEvent	(	sk_sp< GrMtlEvent >	event,
		uint64_t	value
	)

Definition at line 230 of file GrMtlCommandBuffer.mm.

                                                                                        {
    SkASSERT(fCmdBuffer);
    this->endAllEncoding(); // ensure we don't have any active command encoders
                            // TODO: not sure if needed but probably
    if (@available(macOS 10.14, iOS 12.0, tvOS 12.0, *)) {
        [fCmdBuffer encodeWaitForEvent:event->mtlEvent() value:eventValue];
        this->addResource(std::move(event));
    }
    fHasWork = true;
}

getBlitCommandEncoder()

id< MTLBlitCommandEncoder > GrMtlCommandBuffer::getBlitCommandEncoder

(

)

Definition at line 64 of file GrMtlCommandBuffer.mm.

                                                                    {
    if (fActiveBlitCommandEncoder) {
        return fActiveBlitCommandEncoder;
    }
 
    this->endAllEncoding();
    if (fCmdBuffer.status != MTLCommandBufferStatusNotEnqueued) {
        NSLog(@"GrMtlCommandBuffer: tried to create MTLBlitCommandEncoder while in invalid state.");
        return nullptr;
    }
    fActiveBlitCommandEncoder = [fCmdBuffer blitCommandEncoder];
    fHasWork = true;
 
    return fActiveBlitCommandEncoder;
}

getRenderCommandEncoder() [1/2]

GrMtlRenderCommandEncoder * GrMtlCommandBuffer::getRenderCommandEncoder	(	MTLRenderPassDescriptor *	descriptor,
		const GrMtlPipelineState *	pipelineState,
		GrMtlOpsRenderPass *	opsRenderPass
	)

Definition at line 147 of file GrMtlCommandBuffer.mm.

                                           {
    if (nil != fPreviousRenderPassDescriptor) {
        if (compatible(fPreviousRenderPassDescriptor.colorAttachments[0],
                       descriptor.colorAttachments[0], pipelineState) &&
            compatible(fPreviousRenderPassDescriptor.stencilAttachment,
                       descriptor.stencilAttachment, pipelineState)) {
            return fActiveRenderCommandEncoder.get();
        }
    }
 
    return this->getRenderCommandEncoder(descriptor, opsRenderPass);
}

getRenderCommandEncoder() [2/2]

GrMtlRenderCommandEncoder * GrMtlCommandBuffer::getRenderCommandEncoder	(	MTLRenderPassDescriptor *	descriptor,
		GrMtlOpsRenderPass *	opsRenderPass
	)

Definition at line 162 of file GrMtlCommandBuffer.mm.

                                           {
    this->endAllEncoding();
    if (fCmdBuffer.status != MTLCommandBufferStatusNotEnqueued) {
        NSLog(@"GrMtlCommandBuffer: tried to create MTLRenderCommandEncoder while in bad state.");
        return nullptr;
    }
    fActiveRenderCommandEncoder = GrMtlRenderCommandEncoder::Make(
            [fCmdBuffer renderCommandEncoderWithDescriptor:descriptor]);
    if (opsRenderPass) {
        opsRenderPass->initRenderState(fActiveRenderCommandEncoder.get());
    }
    fPreviousRenderPassDescriptor = descriptor;
    fHasWork = true;
 
    return fActiveRenderCommandEncoder.get();
}

hasWork()

bool GrMtlCommandBuffer::hasWork ( )

inline

Definition at line 38 of file GrMtlCommandBuffer.h.

{ return fHasWork; }

isCompleted()

bool GrMtlCommandBuffer::isCompleted ( )

inline

Definition at line 77 of file GrMtlCommandBuffer.h.

                       {
        return fCmdBuffer.status == MTLCommandBufferStatusCompleted ||
               fCmdBuffer.status == MTLCommandBufferStatusError;
    }

Make()

GR_NORETAIN_BEGIN sk_sp< GrMtlCommandBuffer > GrMtlCommandBuffer::Make ( id< MTLCommandQueue >  queue )

static

Definition at line 24 of file GrMtlCommandBuffer.mm.

                                                                            {
    id<MTLCommandBuffer> mtlCommandBuffer;
#if GR_METAL_SDK_VERSION >= 230
    if (@available(macOS 11.0, iOS 14.0, tvOS 14.0, *)) {
        MTLCommandBufferDescriptor* desc = [[MTLCommandBufferDescriptor alloc] init];
        desc.errorOptions = MTLCommandBufferErrorOptionEncoderExecutionStatus;
        mtlCommandBuffer = [queue commandBufferWithDescriptor:desc];
    } else {
        mtlCommandBuffer = [queue commandBuffer];
    }
#else
    mtlCommandBuffer = [queue commandBuffer];
#endif
    if (nil == mtlCommandBuffer) {
        return nullptr;
    }
 
#ifdef SK_ENABLE_MTL_DEBUG_INFO
    mtlCommandBuffer.label = @"GrMtlCommandBuffer::Make";
#endif
 
    return sk_sp<GrMtlCommandBuffer>(new GrMtlCommandBuffer(mtlCommandBuffer));
}

popDebugGroup()

void GrMtlCommandBuffer::popDebugGroup ( )

inline

Definition at line 89 of file GrMtlCommandBuffer.h.

                         {
        if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
            [fCmdBuffer popDebugGroup];
        }
    }

pushDebugGroup()

void GrMtlCommandBuffer::pushDebugGroup ( NSString *  string )

inline

Definition at line 83 of file GrMtlCommandBuffer.h.

                                          {
        if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
            [fCmdBuffer pushDebugGroup:string];
        }
    }

releaseResources()

void GrMtlCommandBuffer::releaseResources

(

)

Definition at line 56 of file GrMtlCommandBuffer.mm.

                                          {
    TRACE_EVENT0("skia.gpu", TRACE_FUNC);
 
    fTrackedResources.clear();
    fTrackedGrBuffers.clear();
    fTrackedGrSurfaces.clear();
}

waitUntilCompleted()

void GrMtlCommandBuffer::waitUntilCompleted ( )

inline

Definition at line 74 of file GrMtlCommandBuffer.h.

                              {
        [fCmdBuffer waitUntilCompleted];
    }

---

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

• third_party/skia/src/gpu/ganesh/mtl/GrMtlCommandBuffer.h
• third_party/skia/src/gpu/ganesh/mtl/GrMtlCommandBuffer.mm