skgpu::graphite::CommandBuffer Class Reference

#include <CommandBuffer.h>

Inheritance diagram for skgpu::graphite::CommandBuffer:

Public Types
using	DrawPassList = skia_private::TArray< std::unique_ptr< DrawPass > >
using	DispatchGroupSpan = SkSpan< const std::unique_ptr< DispatchGroup > >

Public Member Functions
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 ()

Protected Member Functions
	CommandBuffer ()

Protected Attributes
SkISize	fRenderPassSize
SkIVector	fReplayTranslation

Private Member Functions
virtual void	onResetCommandBuffer ()=0
virtual bool	onAddRenderPass (const RenderPassDesc &, const Texture *colorTexture, const Texture *resolveTexture, const Texture *depthStencilTexture, SkRect viewport, const DrawPassList &drawPasses)=0
virtual bool	onAddComputePass (DispatchGroupSpan dispatchGroups)=0
virtual bool	onCopyBufferToBuffer (const Buffer *srcBuffer, size_t srcOffset, const Buffer *dstBuffer, size_t dstOffset, size_t size)=0
virtual bool	onCopyTextureToBuffer (const Texture *, SkIRect srcRect, const Buffer *, size_t bufferOffset, size_t bufferRowBytes)=0
virtual bool	onCopyBufferToTexture (const Buffer *, const Texture *, const BufferTextureCopyData *, int count)=0
virtual bool	onCopyTextureToTexture (const Texture *src, SkIRect srcRect, const Texture *dst, SkIPoint dstPoint, int mipLevel)=0
virtual bool	onSynchronizeBufferToCpu (const Buffer *, bool *outDidResultInWork)=0
virtual bool	onClearBuffer (const Buffer *, size_t offset, size_t size)=0

Detailed Description

Definition at line 38 of file CommandBuffer.h.

Member Typedef Documentation

DispatchGroupSpan

using skgpu::graphite::CommandBuffer::DispatchGroupSpan = SkSpan<const std::unique_ptr<DispatchGroup> >

Definition at line 41 of file CommandBuffer.h.

DrawPassList

using skgpu::graphite::CommandBuffer::DrawPassList = skia_private::TArray<std::unique_ptr<DrawPass> >

Definition at line 40 of file CommandBuffer.h.

Constructor & Destructor Documentation

~CommandBuffer()

skgpu::graphite::CommandBuffer::~CommandBuffer ( )

virtual

Definition at line 24 of file CommandBuffer.cpp.

                              {
    this->releaseResources();
}

CommandBuffer()

skgpu::graphite::CommandBuffer::CommandBuffer ( )

protected

Definition at line 22 of file CommandBuffer.cpp.

{}

Member Function Documentation

addBuffersToAsyncMapOnSubmit()

void skgpu::graphite::CommandBuffer::addBuffersToAsyncMapOnSubmit

(

SkSpan< const sk_sp< Buffer > >

buffers

)

Definition at line 64 of file CommandBuffer.cpp.

                                                                                    {
    for (size_t i = 0; i < buffers.size(); ++i) {
        SkASSERT(buffers[i]);
        fBuffersToAsyncMap.push_back(buffers[i]);
    }
}

addComputePass()

bool skgpu::graphite::CommandBuffer::addComputePass

(

DispatchGroupSpan

dispatchGroups

)

Definition at line 110 of file CommandBuffer.cpp.

                                                                   {
    TRACE_EVENT0("skia.gpu", TRACE_FUNC);
 
    if (!this->onAddComputePass(dispatchGroups)) {
        return false;
    }
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

addFinishedProc()

void skgpu::graphite::CommandBuffer::addFinishedProc

(

sk_sp< RefCntedCallback >

finishedProc

)

Definition at line 51 of file CommandBuffer.cpp.

                                                                        {
    fFinishedProcs.push_back(std::move(finishedProc));
}

addRenderPass()

bool skgpu::graphite::CommandBuffer::addRenderPass	(	const RenderPassDesc &	renderPassDesc,
		sk_sp< Texture >	colorTexture,
		sk_sp< Texture >	resolveTexture,
		sk_sp< Texture >	depthStencilTexture,
		SkRect	viewport,
		const DrawPassList &	drawPasses
	)

Definition at line 75 of file CommandBuffer.cpp.

                                                                  {
    TRACE_EVENT0("skia.gpu", TRACE_FUNC);
 
    fRenderPassSize = colorTexture->dimensions();
    if (!this->onAddRenderPass(renderPassDesc,
                               colorTexture.get(),
                               resolveTexture.get(),
                               depthStencilTexture.get(),
                               viewport,
                               drawPasses)) {
        return false;
    }
 
    if (colorTexture) {
        this->trackCommandBufferResource(std::move(colorTexture));
    }
    if (resolveTexture) {
        this->trackCommandBufferResource(std::move(resolveTexture));
    }
    if (depthStencilTexture) {
        this->trackCommandBufferResource(std::move(depthStencilTexture));
    }
    // We just assume if you are adding a render pass that the render pass will actually do work. In
    // theory we could have a discard load that doesn't submit any draws, clears, etc. But hopefully
    // something so trivial would be caught before getting here.
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

addSignalSemaphores()

virtual void skgpu::graphite::CommandBuffer::addSignalSemaphores ( size_t  numWaitSemaphores, const BackendSemaphore *  signalSemaphores  )

inlinevirtual

Reimplemented in skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

Definition at line 68 of file CommandBuffer.h.

                                                                               {}

addWaitSemaphores()

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

inlinevirtual

Reimplemented in skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

Definition at line 66 of file CommandBuffer.h.

                                                                           {}

buffersToAsyncMapOnSubmit()

SkSpan< const sk_sp< Buffer > > skgpu::graphite::CommandBuffer::buffersToAsyncMapOnSubmit

(

)

const

Definition at line 71 of file CommandBuffer.cpp.

                                                                           {
    return fBuffersToAsyncMap;
}

callFinishedProcs()

void skgpu::graphite::CommandBuffer::callFinishedProcs

(

bool

success

)

Definition at line 55 of file CommandBuffer.cpp.

                                                  {
    if (!success) {
        for (int i = 0; i < fFinishedProcs.size(); ++i) {
            fFinishedProcs[i]->setFailureResult();
        }
    }
    fFinishedProcs.clear();
}

clearBuffer()

bool skgpu::graphite::CommandBuffer::clearBuffer	(	const Buffer *	buffer,
		size_t	offset,
		size_t	size
	)

Definition at line 222 of file CommandBuffer.cpp.

                                                                                {
    SkASSERT(buffer);
 
    if (!this->onClearBuffer(buffer, offset, size)) {
        return false;
    }
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

clearReplayTranslation()

void skgpu::graphite::CommandBuffer::clearReplayTranslation ( )

inline

Definition at line 113 of file CommandBuffer.h.

{ fReplayTranslation = {0, 0}; }

copyBufferToBuffer()

bool skgpu::graphite::CommandBuffer::copyBufferToBuffer	(	const Buffer *	srcBuffer,
		size_t	srcOffset,
		sk_sp< Buffer >	dstBuffer,
		size_t	dstOffset,
		size_t	size
	)

Definition at line 122 of file CommandBuffer.cpp.

                                                    {
    SkASSERT(srcBuffer);
    SkASSERT(dstBuffer);
 
    if (!this->onCopyBufferToBuffer(srcBuffer, srcOffset, dstBuffer.get(), dstOffset, size)) {
        return false;
    }
 
    this->trackResource(std::move(dstBuffer));
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

copyBufferToTexture()

bool skgpu::graphite::CommandBuffer::copyBufferToTexture	(	const Buffer *	buffer,
		sk_sp< Texture >	texture,
		const BufferTextureCopyData *	copyData,
		int	count
	)

Definition at line 162 of file CommandBuffer.cpp.

                                                   {
    SkASSERT(buffer);
    SkASSERT(texture);
    SkASSERT(count > 0 && copyData);
 
    if (!this->onCopyBufferToTexture(buffer, texture.get(), copyData, count)) {
        return false;
    }
 
    this->trackCommandBufferResource(std::move(texture));
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

copyTextureToBuffer()

bool skgpu::graphite::CommandBuffer::copyTextureToBuffer	(	sk_sp< Texture >	texture,
		SkIRect	srcRect,
		sk_sp< Buffer >	buffer,
		size_t	bufferOffset,
		size_t	bufferRowBytes
	)

Definition at line 141 of file CommandBuffer.cpp.

                                                               {
    SkASSERT(texture);
    SkASSERT(buffer);
 
    if (!this->onCopyTextureToBuffer(texture.get(), srcRect, buffer.get(), bufferOffset,
                                     bufferRowBytes)) {
        return false;
    }
 
    this->trackCommandBufferResource(std::move(texture));
    this->trackResource(std::move(buffer));
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

copyTextureToTexture()

bool skgpu::graphite::CommandBuffer::copyTextureToTexture	(	sk_sp< Texture >	src,
		SkIRect	srcRect,
		sk_sp< Texture >	dst,
		SkIPoint	dstPoint,
		int	mipLevel
	)

Definition at line 181 of file CommandBuffer.cpp.

                                                       {
    SkASSERT(src);
    SkASSERT(dst);
    if (src->textureInfo().isProtected() == Protected::kYes &&
        dst->textureInfo().isProtected() != Protected::kYes) {
        SKGPU_LOG_E("Can't copy from protected memory to non-protected");
        return false;
    }
 
    if (!this->onCopyTextureToTexture(src.get(), srcRect, dst.get(), dstPoint, mipLevel)) {
        return false;
    }
 
    this->trackCommandBufferResource(std::move(src));
    this->trackCommandBufferResource(std::move(dst));
 
    SkDEBUGCODE(fHasWork = true;)
 
    return true;
}

onAddComputePass()

virtual bool skgpu::graphite::CommandBuffer::onAddComputePass ( DispatchGroupSpan  dispatchGroups )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onAddRenderPass()

virtual bool skgpu::graphite::CommandBuffer::onAddRenderPass ( const RenderPassDesc &  , const Texture *  colorTexture, const Texture *  resolveTexture, const Texture *  depthStencilTexture, SkRect  viewport, const DrawPassList &  drawPasses  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onClearBuffer()

virtual bool skgpu::graphite::CommandBuffer::onClearBuffer ( const Buffer *  , size_t  offset, size_t  size  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onCopyBufferToBuffer()

virtual bool skgpu::graphite::CommandBuffer::onCopyBufferToBuffer ( const Buffer *  srcBuffer, size_t  srcOffset, const Buffer *  dstBuffer, size_t  dstOffset, size_t  size  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onCopyBufferToTexture()

virtual bool skgpu::graphite::CommandBuffer::onCopyBufferToTexture ( const Buffer *  , const Texture *  , const BufferTextureCopyData *  , int  count  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onCopyTextureToBuffer()

virtual bool skgpu::graphite::CommandBuffer::onCopyTextureToBuffer ( const Texture *  , SkIRect  srcRect, const Buffer *  , size_t  bufferOffset, size_t  bufferRowBytes  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onCopyTextureToTexture()

virtual bool skgpu::graphite::CommandBuffer::onCopyTextureToTexture ( const Texture *  src, SkIRect  srcRect, const Texture *  dst, SkIPoint  dstPoint, int  mipLevel  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onResetCommandBuffer()

virtual void skgpu::graphite::CommandBuffer::onResetCommandBuffer ( )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

onSynchronizeBufferToCpu()

virtual bool skgpu::graphite::CommandBuffer::onSynchronizeBufferToCpu ( const Buffer *  , bool *  outDidResultInWork  )

privatepure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

prepareSurfaceForStateUpdate()

virtual void skgpu::graphite::CommandBuffer::prepareSurfaceForStateUpdate ( SkSurface *  targetSurface, const MutableTextureState *  newState  )

inlinevirtual

Reimplemented in skgpu::graphite::VulkanCommandBuffer.

Definition at line 70 of file CommandBuffer.h.

                                                                                   {}

resetCommandBuffer()

void skgpu::graphite::CommandBuffer::resetCommandBuffer

(

)

Definition at line 35 of file CommandBuffer.cpp.

                                       {
    TRACE_EVENT0("skia.gpu", TRACE_FUNC);
 
    this->releaseResources();
    this->onResetCommandBuffer();
    fBuffersToAsyncMap.clear();
}

setNewCommandBufferResources()

virtual bool skgpu::graphite::CommandBuffer::setNewCommandBufferResources ( )

pure virtual

Implemented in skgpu::graphite::DawnCommandBuffer, skgpu::graphite::MtlCommandBuffer, and skgpu::graphite::VulkanCommandBuffer.

setReplayTranslation()

void skgpu::graphite::CommandBuffer::setReplayTranslation ( SkIVector  translation )

inline

Definition at line 112 of file CommandBuffer.h.

{ fReplayTranslation = translation; }

synchronizeBufferToCpu()

bool skgpu::graphite::CommandBuffer::synchronizeBufferToCpu

(

sk_sp< Buffer >

buffer

)

Definition at line 206 of file CommandBuffer.cpp.

                                                               {
    SkASSERT(buffer);
 
    bool didResultInWork = false;
    if (!this->onSynchronizeBufferToCpu(buffer.get(), &didResultInWork)) {
        return false;
    }
 
    if (didResultInWork) {
        this->trackResource(std::move(buffer));
        SkDEBUGCODE(fHasWork = true;)
    }
 
    return true;
}

trackCommandBufferResource()

void skgpu::graphite::CommandBuffer::trackCommandBufferResource

(

sk_sp< Resource >

resource

)

Definition at line 47 of file CommandBuffer.cpp.

                                                                       {
    fCommandBufferResources.push_back(std::move(resource));
}

trackResource()

void skgpu::graphite::CommandBuffer::trackResource

(

sk_sp< Resource >

resource

)

Definition at line 43 of file CommandBuffer.cpp.

                                                          {
    fTrackedUsageResources.push_back(std::move(resource));
}

Member Data Documentation

fRenderPassSize

SkISize skgpu::graphite::CommandBuffer::fRenderPassSize

protected

Definition at line 118 of file CommandBuffer.h.

fReplayTranslation

SkIVector skgpu::graphite::CommandBuffer::fReplayTranslation

protected

Definition at line 119 of file CommandBuffer.h.

---

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

• third_party/skia/src/gpu/graphite/CommandBuffer.h
• third_party/skia/src/gpu/graphite/CommandBuffer.cpp