Vulkan: Use angle::Result error handling.
Introduces a vk::Context class to contain an error handler and Renderer
pointer. This abtracts the common code path for ContextVk + DisplayVk.
Removes vk::Error in favor of the POD angle::Result class. There are a
few remaining usages of gl::Error that will have to be cleaned up when
we can change the front-end APIs.
Bug: angleproject:2713
Change-Id: I5e68f223d595c6c561b59d6a85759e5738ed43c6
Reviewed-on: https://chromium-review.googlesource.com/1128924
Commit-Queue: Jamie Madill <jmadill@chromium.org>
Reviewed-by: Frank Henigman <fjhenigman@chromium.org>
diff --git a/src/libANGLE/renderer/vulkan/FramebufferVk.cpp b/src/libANGLE/renderer/vulkan/FramebufferVk.cpp
index 1e2401d..e2d8a29 100644
--- a/src/libANGLE/renderer/vulkan/FramebufferVk.cpp
+++ b/src/libANGLE/renderer/vulkan/FramebufferVk.cpp
@@ -131,7 +131,6 @@
gl::Error FramebufferVk::clear(const gl::Context *context, GLbitfield mask)
{
ContextVk *contextVk = vk::GetImpl(context);
- RendererVk *renderer = contextVk->getRenderer();
// This command buffer is only started once.
vk::CommandBuffer *commandBuffer = nullptr;
@@ -155,7 +154,7 @@
VkColorComponentFlags colorMaskFlags = contextVk->getClearColorMask();
if (clearColor && (mActiveColorComponents & colorMaskFlags) != mActiveColorComponents)
{
- ANGLE_TRY(clearWithDraw(context, colorMaskFlags));
+ ANGLE_TRY(clearWithDraw(contextVk, colorMaskFlags));
// Stencil clears must be handled separately. The only way to write out a stencil value from
// a fragment shader in Vulkan is with VK_EXT_shader_stencil_export. Support for this
@@ -192,7 +191,7 @@
// Standard Depth/stencil clear without scissor.
if (clearDepth || clearStencil)
{
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
const VkClearDepthStencilValue &clearDepthStencilValue =
contextVk->getClearDepthStencilValue().depthStencil;
@@ -215,7 +214,7 @@
if (!commandBuffer)
{
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
}
// TODO(jmadill): Support gaps in RenderTargets. http://anglebug.com/2394
@@ -317,7 +316,7 @@
const gl::State &glState = context->getGLState();
vk::CommandBuffer *commandBuffer = nullptr;
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
gl::PixelPackState packState(glState.getPackState());
if (contextVk->isViewportFlipEnabledForDrawFBO())
@@ -345,7 +344,7 @@
params.packBuffer = glState.getTargetBuffer(gl::BufferBinding::PixelPack);
params.pack = packState;
- ANGLE_TRY(readPixelsImpl(context, flippedArea, params, VK_IMAGE_ASPECT_COLOR_BIT,
+ ANGLE_TRY(readPixelsImpl(contextVk, flippedArea, params, VK_IMAGE_ASPECT_COLOR_BIT,
getColorReadRenderTarget(),
static_cast<uint8_t *>(pixels) + outputSkipBytes));
mReadPixelsBuffer.releaseRetainedBuffers(renderer);
@@ -357,14 +356,14 @@
return mRenderTargetCache.getDepthStencil();
}
-gl::Error FramebufferVk::blitUsingCopy(vk::CommandBuffer *commandBuffer,
- const gl::Rectangle &readArea,
- const gl::Rectangle &destArea,
- RenderTargetVk *readRenderTarget,
- RenderTargetVk *drawRenderTarget,
- const gl::Rectangle *scissor,
- bool blitDepthBuffer,
- bool blitStencilBuffer)
+void FramebufferVk::blitUsingCopy(vk::CommandBuffer *commandBuffer,
+ const gl::Rectangle &readArea,
+ const gl::Rectangle &destArea,
+ RenderTargetVk *readRenderTarget,
+ RenderTargetVk *drawRenderTarget,
+ const gl::Rectangle *scissor,
+ bool blitDepthBuffer,
+ bool blitStencilBuffer)
{
gl::Rectangle scissoredDrawRect = destArea;
gl::Rectangle scissoredReadRect = readArea;
@@ -373,12 +372,12 @@
{
if (!ClipRectangle(destArea, *scissor, &scissoredDrawRect))
{
- return gl::NoError();
+ return;
}
if (!ClipRectangle(readArea, *scissor, &scissoredReadRect))
{
- return gl::NoError();
+ return;
}
}
@@ -392,12 +391,12 @@
drawFrameBufferExtents.height);
if (!ClipRectangle(scissoredReadRect, readFrameBufferBounds, &scissoredReadRect))
{
- return gl::NoError();
+ return;
}
if (!ClipRectangle(scissoredDrawRect, drawFrameBufferBounds, &scissoredDrawRect))
{
- return gl::NoError();
+ return;
}
ASSERT(readFrameBufferBounds == drawFrameBufferBounds);
@@ -420,8 +419,6 @@
vk::ImageHelper::Copy(readImage, writeImage, gl::Offset(), gl::Offset(),
gl::Extents(scissoredDrawRect.width, scissoredDrawRect.height, 1),
aspectMask, commandBuffer);
-
- return gl::NoError();
}
RenderTargetVk *FramebufferVk::getColorReadRenderTarget() const
@@ -431,16 +428,15 @@
return renderTarget;
}
-gl::Error FramebufferVk::blitWithReadback(const gl::Context *context,
- const gl::Rectangle &sourceArea,
- const gl::Rectangle &destArea,
- bool blitDepthBuffer,
- bool blitStencilBuffer,
- vk::CommandBuffer *commandBuffer,
- RenderTargetVk *readRenderTarget,
- RenderTargetVk *drawRenderTarget)
+angle::Result FramebufferVk::blitWithReadback(ContextVk *contextVk,
+ const gl::Rectangle &sourceArea,
+ const gl::Rectangle &destArea,
+ bool blitDepthBuffer,
+ bool blitStencilBuffer,
+ vk::CommandBuffer *commandBuffer,
+ RenderTargetVk *readRenderTarget,
+ RenderTargetVk *drawRenderTarget)
{
- ContextVk *contextVk = vk::GetImpl(context);
RendererVk *renderer = contextVk->getRenderer();
vk::ImageHelper *imageForRead = readRenderTarget->getImageForRead(
this, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, commandBuffer);
@@ -490,15 +486,15 @@
VkImageAspectFlags copyFlags =
vk::GetDepthStencilAspectFlagsForCopy(blitDepthBuffer, blitStencilBuffer);
- ANGLE_TRY(mBlitPixelBuffer.allocate(renderer, sizeToRequest, ©Ptr, &handleOut, &offsetOut,
+ ANGLE_TRY(mBlitPixelBuffer.allocate(contextVk, sizeToRequest, ©Ptr, &handleOut, &offsetOut,
nullptr));
- ANGLE_TRY(readPixelsImpl(context, sourceArea, packPixelsParams, copyFlags, readRenderTarget,
+ ANGLE_TRY(readPixelsImpl(contextVk, sourceArea, packPixelsParams, copyFlags, readRenderTarget,
copyPtr));
- ANGLE_TRY(mBlitPixelBuffer.flush(contextVk->getDevice()));
+ ANGLE_TRY(mBlitPixelBuffer.flush(contextVk));
// Reinitialize the commandBuffer after a read pixels because it calls
// renderer->finish which makes command buffers obsolete.
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
// We read the bytes of the image in a buffer, now we have to copy them into the
// destination target.
@@ -527,7 +523,7 @@
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, ®ion);
mBlitPixelBuffer.releaseRetainedBuffers(renderer);
- return gl::NoError();
+ return angle::Result::Continue();
}
gl::Error FramebufferVk::blit(const gl::Context *context,
@@ -547,7 +543,7 @@
bool blitStencilBuffer = (mask & GL_STENCIL_BUFFER_BIT) != 0;
vk::CommandBuffer *commandBuffer = nullptr;
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
FramebufferVk *sourceFramebufferVk = vk::GetImpl(sourceFramebuffer);
bool flipSource = contextVk->isViewportFlipEnabledForReadFBO();
bool flipDest = contextVk->isViewportFlipEnabledForDrawFBO();
@@ -562,9 +558,8 @@
ASSERT(drawRenderTarget);
ASSERT(HasSrcAndDstBlitProperties(renderer->getPhysicalDevice(), readRenderTarget,
drawRenderTarget));
- ANGLE_TRY(blitImpl(contextVk, commandBuffer, sourceArea, destArea, readRenderTarget,
- drawRenderTarget, filter, scissor, true, false, false, flipSource,
- flipDest));
+ blitImpl(commandBuffer, sourceArea, destArea, readRenderTarget, drawRenderTarget,
+ filter, scissor, true, false, false, flipSource, flipDest);
}
}
@@ -578,24 +573,23 @@
if (HasSrcAndDstBlitProperties(renderer->getPhysicalDevice(), readRenderTarget,
drawRenderTarget))
{
- ANGLE_TRY(blitImpl(contextVk, commandBuffer, sourceArea, destArea, readRenderTarget,
- drawRenderTarget, filter, scissor, false, blitDepthBuffer,
- blitStencilBuffer, flipSource, flipDest));
+ blitImpl(commandBuffer, sourceArea, destArea, readRenderTarget, drawRenderTarget,
+ filter, scissor, false, blitDepthBuffer, blitStencilBuffer, flipSource,
+ flipDest);
}
else
{
ASSERT(filter == GL_NEAREST);
if (flipSource || flipDest)
{
- ANGLE_TRY(blitWithReadback(context, sourceArea, destArea, blitDepthBuffer,
+ ANGLE_TRY(blitWithReadback(contextVk, sourceArea, destArea, blitDepthBuffer,
blitStencilBuffer, commandBuffer, readRenderTarget,
drawRenderTarget));
}
else
{
- ANGLE_TRY(blitUsingCopy(commandBuffer, sourceArea, destArea, readRenderTarget,
- drawRenderTarget, scissor, blitDepthBuffer,
- blitStencilBuffer));
+ blitUsingCopy(commandBuffer, sourceArea, destArea, readRenderTarget,
+ drawRenderTarget, scissor, blitDepthBuffer, blitStencilBuffer);
}
}
}
@@ -603,19 +597,18 @@
return gl::NoError();
}
-gl::Error FramebufferVk::blitImpl(ContextVk *contextVk,
- vk::CommandBuffer *commandBuffer,
- const gl::Rectangle &readRectIn,
- const gl::Rectangle &drawRectIn,
- RenderTargetVk *readRenderTarget,
- RenderTargetVk *drawRenderTarget,
- GLenum filter,
- const gl::Rectangle *scissor,
- bool colorBlit,
- bool depthBlit,
- bool stencilBlit,
- bool flipSource,
- bool flipDest)
+void FramebufferVk::blitImpl(vk::CommandBuffer *commandBuffer,
+ const gl::Rectangle &readRectIn,
+ const gl::Rectangle &drawRectIn,
+ RenderTargetVk *readRenderTarget,
+ RenderTargetVk *drawRenderTarget,
+ GLenum filter,
+ const gl::Rectangle *scissor,
+ bool colorBlit,
+ bool depthBlit,
+ bool stencilBlit,
+ bool flipSource,
+ bool flipDest)
{
// Since blitRenderbufferRect is called for each render buffer that needs to be blitted,
// it should never be the case that both color and depth/stencil need to be blitted at
@@ -629,12 +622,12 @@
{
if (!ClipRectangle(drawRectIn, *scissor, &scissoredDrawRect))
{
- return gl::NoError();
+ return;
}
if (!ClipRectangle(readRectIn, *scissor, &scissoredReadRect))
{
- return gl::NoError();
+ return;
}
}
@@ -645,7 +638,7 @@
sourceFrameBufferExtents.height);
if (!ClipRectangle(scissoredReadRect, readFrameBufferBounds, &scissoredReadRect))
{
- return gl::NoError();
+ return;
}
const vk::Format &readImageFormat = readRenderTarget->getImageFormat();
@@ -680,7 +673,7 @@
drawFrameBufferExtents.height);
if (!ClipRectangle(scissoredDrawRect, drawFrameBufferBounds, &scissoredDrawRect))
{
- return gl::NoError();
+ return;
}
if (flipDest)
@@ -705,7 +698,6 @@
commandBuffer->blitImage(srcImage->getImage(), VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
dstImage->getImage(), VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &blit,
gl_vk::GetFilter(filter));
- return gl::NoError();
}
bool FramebufferVk::checkStatus(const gl::Context *context) const
@@ -820,25 +812,24 @@
return mRenderPassDesc.value();
}
-vk::Error FramebufferVk::getFramebuffer(RendererVk *rendererVk, vk::Framebuffer **framebufferOut)
+angle::Result FramebufferVk::getFramebuffer(ContextVk *contextVk, vk::Framebuffer **framebufferOut)
{
// If we've already created our cached Framebuffer, return it.
if (mFramebuffer.valid())
{
*framebufferOut = &mFramebuffer;
- return vk::NoError();
+ return angle::Result::Continue();
}
const vk::RenderPassDesc &desc = getRenderPassDesc();
vk::RenderPass *renderPass = nullptr;
- ANGLE_TRY(rendererVk->getCompatibleRenderPass(desc, &renderPass));
+ ANGLE_TRY(contextVk->getRenderer()->getCompatibleRenderPass(contextVk, desc, &renderPass));
// If we've a Framebuffer provided by a Surface (default FBO/backbuffer), query it.
- VkDevice device = rendererVk->getDevice();
if (mBackbuffer)
{
- return mBackbuffer->getCurrentFramebuffer(device, *renderPass, framebufferOut);
+ return mBackbuffer->getCurrentFramebuffer(contextVk, *renderPass, framebufferOut);
}
// Gather VkImageViews over all FBO attachments, also size of attached region.
@@ -881,16 +872,16 @@
framebufferInfo.height = static_cast<uint32_t>(attachmentsSize.height);
framebufferInfo.layers = 1;
- ANGLE_TRY(mFramebuffer.init(device, framebufferInfo));
+ ANGLE_TRY(mFramebuffer.init(contextVk, framebufferInfo));
*framebufferOut = &mFramebuffer;
- return vk::NoError();
+ return angle::Result::Continue();
}
-gl::Error FramebufferVk::clearWithClearAttachments(ContextVk *contextVk,
- bool clearColor,
- bool clearDepth,
- bool clearStencil)
+angle::Result FramebufferVk::clearWithClearAttachments(ContextVk *contextVk,
+ bool clearColor,
+ bool clearDepth,
+ bool clearStencil)
{
// Trigger a new command node to ensure overlapping writes happen sequentially.
onResourceChanged(contextVk->getRenderer());
@@ -916,7 +907,7 @@
&intersection))
{
// There is nothing to clear since the scissor is outside of the render area.
- return gl::NoError();
+ return angle::Result::Continue();
}
clearRect.rect = gl_vk::GetRect(intersection);
@@ -987,13 +978,12 @@
commandBuffer->clearAttachments(static_cast<uint32_t>(clearAttachmentIndex),
clearAttachments.data(), 1, &clearRect);
- return gl::NoError();
+ return angle::Result::Continue();
}
-gl::Error FramebufferVk::clearWithDraw(const gl::Context *context,
- VkColorComponentFlags colorMaskFlags)
+angle::Result FramebufferVk::clearWithDraw(ContextVk *contextVk,
+ VkColorComponentFlags colorMaskFlags)
{
- ContextVk *contextVk = vk::GetImpl(context);
RendererVk *renderer = contextVk->getRenderer();
vk::ShaderLibrary *shaderLibrary = renderer->getShaderLibrary();
@@ -1001,11 +991,11 @@
onResourceChanged(renderer);
const vk::ShaderAndSerial *fullScreenQuad = nullptr;
- ANGLE_TRY(shaderLibrary->getShader(renderer, vk::InternalShaderID::FullScreenQuad_vert,
+ ANGLE_TRY(shaderLibrary->getShader(contextVk, vk::InternalShaderID::FullScreenQuad_vert,
&fullScreenQuad));
const vk::ShaderAndSerial *pushConstantColor = nullptr;
- ANGLE_TRY(shaderLibrary->getShader(renderer, vk::InternalShaderID::PushConstantColor_frag,
+ ANGLE_TRY(shaderLibrary->getShader(contextVk, vk::InternalShaderID::PushConstantColor_frag,
&pushConstantColor));
// The shader uses a simple pipeline layout with a push constant range.
@@ -1017,8 +1007,8 @@
vk::DescriptorSetLayoutPointerArray descriptorSetLayouts;
vk::BindingPointer<vk::PipelineLayout> pipelineLayout;
- ANGLE_TRY(
- renderer->getPipelineLayout(pipelineLayoutDesc, descriptorSetLayouts, &pipelineLayout));
+ ANGLE_TRY(renderer->getPipelineLayout(contextVk, pipelineLayoutDesc, descriptorSetLayouts,
+ &pipelineLayout));
vk::RecordingMode recordingMode = vk::RecordingMode::Start;
vk::CommandBuffer *drawCommands = nullptr;
@@ -1041,7 +1031,7 @@
gl::Rectangle intersection;
if (!gl::ClipRectangle(glState.getScissor(), renderArea, &intersection))
{
- return gl::NoError();
+ return angle::Result::Continue();
}
pipelineDesc.updateScissor(intersection, invertViewport, renderArea);
@@ -1052,13 +1042,13 @@
}
vk::PipelineAndSerial *pipeline = nullptr;
- ANGLE_TRY(renderer->getInternalPipeline(*fullScreenQuad, *pushConstantColor,
+ ANGLE_TRY(renderer->getInternalPipeline(contextVk, *fullScreenQuad, *pushConstantColor,
pipelineLayout.get(), pipelineDesc,
gl::AttributesMask(), &pipeline));
pipeline->updateSerial(renderer->getCurrentQueueSerial());
vk::CommandBuffer *writeCommands = nullptr;
- ANGLE_TRY(appendWriteResource(renderer, &writeCommands));
+ ANGLE_TRY(appendWriteResource(contextVk, &writeCommands));
// If the format of the framebuffer does not have an alpha channel, we need to make sure we does
// not affect the alpha channel of the type we're using to emulate the format.
@@ -1080,7 +1070,7 @@
drawCommands->bindPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS, pipeline->get());
drawCommands->draw(6, 1, 0, 0);
- return gl::NoError();
+ return angle::Result::Continue();
}
gl::Error FramebufferVk::getSamplePosition(const gl::Context *context,
@@ -1091,9 +1081,9 @@
return gl::InternalError() << "getSamplePosition is unimplemented.";
}
-vk::Error FramebufferVk::getCommandBufferForDraw(ContextVk *contextVk,
- vk::CommandBuffer **commandBufferOut,
- vk::RecordingMode *modeOut)
+angle::Result FramebufferVk::getCommandBufferForDraw(ContextVk *contextVk,
+ vk::CommandBuffer **commandBufferOut,
+ vk::RecordingMode *modeOut)
{
RendererVk *renderer = contextVk->getRenderer();
@@ -1101,17 +1091,17 @@
if (appendToStartedRenderPass(renderer, commandBufferOut))
{
*modeOut = vk::RecordingMode::Append;
- return vk::NoError();
+ return angle::Result::Continue();
}
vk::Framebuffer *framebuffer = nullptr;
- ANGLE_TRY(getFramebuffer(renderer, &framebuffer));
+ ANGLE_TRY(getFramebuffer(contextVk, &framebuffer));
// TODO(jmadill): Proper clear value implementation. http://anglebug.com/2361
std::vector<VkClearValue> attachmentClearValues;
vk::CommandBuffer *writeCommands = nullptr;
- ANGLE_TRY(appendWriteResource(renderer, &writeCommands));
+ ANGLE_TRY(appendWriteResource(contextVk, &writeCommands));
vk::RenderPassDesc renderPassDesc;
@@ -1138,7 +1128,7 @@
gl::Rectangle(0, 0, mState.getDimensions().width, mState.getDimensions().height);
*modeOut = vk::RecordingMode::Start;
- return beginRenderPass(renderer, *framebuffer, renderArea, mRenderPassDesc.value(),
+ return beginRenderPass(contextVk, *framebuffer, renderArea, mRenderPassDesc.value(),
attachmentClearValues, commandBufferOut);
}
@@ -1155,14 +1145,13 @@
return mEmulatedAlphaAttachmentMask;
}
-vk::Error FramebufferVk::readPixelsImpl(const gl::Context *context,
- const gl::Rectangle &area,
- const PackPixelsParams &packPixelsParams,
- const VkImageAspectFlags ©AspectFlags,
- RenderTargetVk *renderTarget,
- void *pixels)
+angle::Result FramebufferVk::readPixelsImpl(ContextVk *contextVk,
+ const gl::Rectangle &area,
+ const PackPixelsParams &packPixelsParams,
+ const VkImageAspectFlags ©AspectFlags,
+ RenderTargetVk *renderTarget,
+ void *pixels)
{
- ContextVk *contextVk = vk::GetImpl(context);
RendererVk *renderer = contextVk->getRenderer();
if (!mReadPixelsBuffer.valid())
@@ -1172,7 +1161,7 @@
}
vk::CommandBuffer *commandBuffer = nullptr;
- ANGLE_TRY(beginWriteResource(renderer, &commandBuffer));
+ ANGLE_TRY(beginWriteResource(contextVk, &commandBuffer));
// Note that although we're reading from the image, we need to update the layout below.
@@ -1198,7 +1187,7 @@
uint32_t stagingOffset = 0;
size_t allocationSize = area.width * pixelBytes * area.height;
- ANGLE_TRY(mReadPixelsBuffer.allocate(renderer, allocationSize, &readPixelBuffer, &bufferHandle,
+ ANGLE_TRY(mReadPixelsBuffer.allocate(contextVk, allocationSize, &readPixelBuffer, &bufferHandle,
&stagingOffset, &newBufferAllocated));
VkBufferImageCopy region;
@@ -1221,16 +1210,16 @@
// Triggers a full finish.
// TODO(jmadill): Don't block on asynchronous readback.
- ANGLE_TRY(renderer->finish(context));
+ ANGLE_TRY(renderer->finish(contextVk));
// The buffer we copied to needs to be invalidated before we read from it because its not been
// created with the host coherent bit.
- ANGLE_TRY(mReadPixelsBuffer.invalidate(renderer->getDevice()));
+ ANGLE_TRY(mReadPixelsBuffer.invalidate(contextVk));
PackPixels(packPixelsParams, angleFormat, area.width * pixelBytes, readPixelBuffer,
static_cast<uint8_t *>(pixels));
- return vk::NoError();
+ return angle::Result::Continue();
}
const gl::Extents &FramebufferVk::getReadImageExtents() const