skgpu::graphite::MtlCommandBuffer Class Reference

#include <MtlCommandBuffer.h>

Inheritance diagram for skgpu::graphite::MtlCommandBuffer:

Public Member Functions
	~MtlCommandBuffer () override
bool	setNewCommandBufferResources () override
void	addWaitSemaphores (size_t numWaitSemaphores, const BackendSemaphore *waitSemaphores) override
void	addSignalSemaphores (size_t numSignalSemaphores, const BackendSemaphore *signalSemaphores) override
bool	isFinished ()
void	waitUntilFinished ()
bool	commit ()
Public Member Functions inherited from skgpu::graphite::CommandBuffer
virtual	~CommandBuffer ()
void	trackResource (sk_sp< Resource > resource)
void	trackCommandBufferResource (sk_sp< Resource > resource)
void	resetCommandBuffer ()
virtual bool	setNewCommandBufferResources ()=0
void	addFinishedProc (sk_sp< RefCntedCallback > finishedProc)
void	callFinishedProcs (bool success)
virtual void	addWaitSemaphores (size_t numWaitSemaphores, const BackendSemaphore *waitSemaphores)
virtual void	addSignalSemaphores (size_t numWaitSemaphores, const BackendSemaphore *signalSemaphores)
virtual void	prepareSurfaceForStateUpdate (SkSurface *targetSurface, const MutableTextureState *newState)
void	addBuffersToAsyncMapOnSubmit (SkSpan< const sk_sp< Buffer > >)
SkSpan< const sk_sp< Buffer > >	buffersToAsyncMapOnSubmit () const
bool	addRenderPass (const RenderPassDesc &, sk_sp< Texture > colorTexture, sk_sp< Texture > resolveTexture, sk_sp< Texture > depthStencilTexture, SkRect viewport, const DrawPassList &drawPasses)
bool	addComputePass (DispatchGroupSpan dispatchGroups)
bool	copyBufferToBuffer (const Buffer *srcBuffer, size_t srcOffset, sk_sp< Buffer > dstBuffer, size_t dstOffset, size_t size)
bool	copyTextureToBuffer (sk_sp< Texture >, SkIRect srcRect, sk_sp< Buffer >, size_t bufferOffset, size_t bufferRowBytes)
bool	copyBufferToTexture (const Buffer *, sk_sp< Texture >, const BufferTextureCopyData *, int count)
bool	copyTextureToTexture (sk_sp< Texture > src, SkIRect srcRect, sk_sp< Texture > dst, SkIPoint dstPoint, int mipLevel)
bool	synchronizeBufferToCpu (sk_sp< Buffer >)
bool	clearBuffer (const Buffer *buffer, size_t offset, size_t size)
void	setReplayTranslation (SkIVector translation)
void	clearReplayTranslation ()

Static Public Member Functions
static std::unique_ptr< MtlCommandBuffer >	Make (id< MTLCommandQueue >, const MtlSharedContext *, MtlResourceProvider *)

Additional Inherited Members
Public Types inherited from skgpu::graphite::CommandBuffer
using	DrawPassList = skia_private::TArray< std::unique_ptr< DrawPass > >
using	DispatchGroupSpan = SkSpan< const std::unique_ptr< DispatchGroup > >
Protected Member Functions inherited from skgpu::graphite::CommandBuffer
	CommandBuffer ()
Protected Attributes inherited from skgpu::graphite::CommandBuffer
SkISize	fRenderPassSize
SkIVector	fReplayTranslation

Detailed Description

Definition at line 31 of file MtlCommandBuffer.h.

Constructor & Destructor Documentation

~MtlCommandBuffer()

skgpu::graphite::MtlCommandBuffer::~MtlCommandBuffer ( )

override

Definition at line 51 of file MtlCommandBuffer.mm.

                                    {
    SkASSERT(!fActiveRenderCommandEncoder);
    SkASSERT(!fActiveComputeCommandEncoder);
    SkASSERT(!fActiveBlitCommandEncoder);
}

Member Function Documentation

addSignalSemaphores()

void skgpu::graphite::MtlCommandBuffer::addSignalSemaphores ( size_t  numSignalSemaphores, const BackendSemaphore *  signalSemaphores  )

overridevirtual

Reimplemented from skgpu::graphite::CommandBuffer.

Definition at line 130 of file MtlCommandBuffer.mm.

                                                                                     {
    if (!signalSemaphores) {
        SkASSERT(numSignalSemaphores == 0);
        return;
    }
 
    // Can only insert events with no active encoder
    SkASSERT(!fActiveRenderCommandEncoder);
    SkASSERT(!fActiveComputeCommandEncoder);
    this->endBlitCommandEncoder();
 
    if (@available(macOS 10.14, iOS 12.0, tvOS 12.0, *)) {
        for (size_t i = 0; i < numSignalSemaphores; ++i) {
            auto semaphore = signalSemaphores[i];
            if (semaphore.isValid() && semaphore.backend() == BackendApi::kMetal) {
                id<MTLEvent> mtlEvent = (__bridge id<MTLEvent>)semaphore.getMtlEvent();
                [(*fCommandBuffer) encodeSignalEvent: mtlEvent
                                               value: semaphore.getMtlValue()];
            }
        }
    }
}

addWaitSemaphores()

void skgpu::graphite::MtlCommandBuffer::addWaitSemaphores ( size_t  numWaitSemaphores, const BackendSemaphore *  waitSemaphores  )

overridevirtual

Reimplemented from skgpu::graphite::CommandBuffer.

Definition at line 107 of file MtlCommandBuffer.mm.

                                                                                 {
    if (!waitSemaphores) {
        SkASSERT(numWaitSemaphores == 0);
        return;
    }
 
    // Can only insert events with no active encoder
    SkASSERT(!fActiveRenderCommandEncoder);
    SkASSERT(!fActiveComputeCommandEncoder);
    this->endBlitCommandEncoder();
    if (@available(macOS 10.14, iOS 12.0, tvOS 12.0, *)) {
        for (size_t i = 0; i < numWaitSemaphores; ++i) {
            auto semaphore = waitSemaphores[i];
            if (semaphore.isValid() && semaphore.backend() == BackendApi::kMetal) {
                id<MTLEvent> mtlEvent = (__bridge id<MTLEvent>)semaphore.getMtlEvent();
                [(*fCommandBuffer) encodeWaitForEvent: mtlEvent
                                                value: semaphore.getMtlValue()];
            }
        }
    }
}

commit()

bool skgpu::graphite::MtlCommandBuffer::commit

(

)

Definition at line 83 of file MtlCommandBuffer.mm.

                              {
    SkASSERT(!fActiveRenderCommandEncoder);
    SkASSERT(!fActiveComputeCommandEncoder);
    this->endBlitCommandEncoder();
    [(*fCommandBuffer) commit];
 
    if ((*fCommandBuffer).status == MTLCommandBufferStatusError) {
        NSString* description = (*fCommandBuffer).error.localizedDescription;
        const char* errorString = [description UTF8String];
        SKGPU_LOG_E("Failure submitting command buffer: %s", errorString);
    }
 
    return ((*fCommandBuffer).status != MTLCommandBufferStatusError);
}

isFinished()

bool skgpu::graphite::MtlCommandBuffer::isFinished ( )

inline

Definition at line 45 of file MtlCommandBuffer.h.

                      {
        return (*fCommandBuffer).status == MTLCommandBufferStatusCompleted ||
               (*fCommandBuffer).status == MTLCommandBufferStatusError;
 
    }

Make()

std::unique_ptr< MtlCommandBuffer > skgpu::graphite::MtlCommandBuffer::Make ( id< MTLCommandQueue >  queue, const MtlSharedContext *  sharedContext, MtlResourceProvider *  resourceProvider  )

static

Definition at line 30 of file MtlCommandBuffer.mm.

                                                                                                {
    auto commandBuffer = std::unique_ptr<MtlCommandBuffer>(
            new MtlCommandBuffer(queue, sharedContext, resourceProvider));
    if (!commandBuffer) {
        return nullptr;
    }
    if (!commandBuffer->createNewMTLCommandBuffer()) {
        return nullptr;
    }
    return commandBuffer;
}

setNewCommandBufferResources()

bool skgpu::graphite::MtlCommandBuffer::setNewCommandBufferResources ( )

overridevirtual

Implements skgpu::graphite::CommandBuffer.

Definition at line 57 of file MtlCommandBuffer.mm.

                                                    {
    return this->createNewMTLCommandBuffer();
}

waitUntilFinished()

void skgpu::graphite::MtlCommandBuffer::waitUntilFinished ( )

inline

Definition at line 50 of file MtlCommandBuffer.h.

                             {
        // TODO: it's not clear what do to if status is Enqueued. Commit and then wait?
        if ((*fCommandBuffer).status == MTLCommandBufferStatusScheduled ||
            (*fCommandBuffer).status == MTLCommandBufferStatusCommitted) {
            [(*fCommandBuffer) waitUntilCompleted];
        }
        if (!this->isFinished()) {
            SKGPU_LOG_E("Unfinished command buffer status: %d",
                        (int)(*fCommandBuffer).status);
            SkASSERT(false);
        }
    }

---

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

• third_party/skia/src/gpu/graphite/mtl/MtlCommandBuffer.h
• third_party/skia/src/gpu/graphite/mtl/MtlCommandBuffer.mm