Deprecates clearColor, clearDepth, and clearStencil values.
- Removes remaining usages of the values in Dawn and removes tests. - Note that the values will be removed from the JSON entirely in follow up CL after Chromium side changes. Change-Id: I30ccb3c412cd97047065ad515f6a5ff4de642420 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/117593 Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Austin Eng <enga@chromium.org> Commit-Queue: Loko Kung <lokokung@google.com>
This commit is contained in:
parent
8fd1de00e0
commit
831ff0e39d
|
@ -167,7 +167,7 @@ ResultOrError<RenderPipelineBase*> GetOrCreateApplyClearValueWithDrawPipeline(
|
||||||
}
|
}
|
||||||
|
|
||||||
Color GetClearColorValue(const RenderPassColorAttachment& attachment) {
|
Color GetClearColorValue(const RenderPassColorAttachment& attachment) {
|
||||||
return HasDeprecatedColor(attachment) ? attachment.clearColor : attachment.clearValue;
|
return attachment.clearValue;
|
||||||
}
|
}
|
||||||
|
|
||||||
ResultOrError<Ref<BufferBase>> CreateUniformBufferWithClearValues(
|
ResultOrError<Ref<BufferBase>> CreateUniformBufferWithClearValues(
|
||||||
|
|
|
@ -239,16 +239,7 @@ MaybeError ValidateRenderPassColorAttachment(DeviceBase* device,
|
||||||
DAWN_INVALID_IF(colorAttachment.loadOp == wgpu::LoadOp::Undefined, "loadOp must be set.");
|
DAWN_INVALID_IF(colorAttachment.loadOp == wgpu::LoadOp::Undefined, "loadOp must be set.");
|
||||||
DAWN_INVALID_IF(colorAttachment.storeOp == wgpu::StoreOp::Undefined, "storeOp must be set.");
|
DAWN_INVALID_IF(colorAttachment.storeOp == wgpu::StoreOp::Undefined, "storeOp must be set.");
|
||||||
|
|
||||||
// TODO(dawn:1269): Remove after the deprecation period.
|
const dawn::native::Color& clearValue = colorAttachment.clearValue;
|
||||||
bool useClearColor = HasDeprecatedColor(colorAttachment);
|
|
||||||
const dawn::native::Color& clearValue =
|
|
||||||
useClearColor ? colorAttachment.clearColor : colorAttachment.clearValue;
|
|
||||||
|
|
||||||
if (useClearColor) {
|
|
||||||
DAWN_TRY(DAWN_MAKE_DEPRECATION_ERROR(
|
|
||||||
device, "clearColor is deprecated, prefer using clearValue instead."));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (colorAttachment.loadOp == wgpu::LoadOp::Clear) {
|
if (colorAttachment.loadOp == wgpu::LoadOp::Clear) {
|
||||||
DAWN_INVALID_IF(std::isnan(clearValue.r) || std::isnan(clearValue.g) ||
|
DAWN_INVALID_IF(std::isnan(clearValue.r) || std::isnan(clearValue.g) ||
|
||||||
std::isnan(clearValue.b) || std::isnan(clearValue.a),
|
std::isnan(clearValue.b) || std::isnan(clearValue.a),
|
||||||
|
@ -380,14 +371,7 @@ MaybeError ValidateRenderPassDepthStencilAttachment(
|
||||||
depthStencilAttachment->stencilReadOnly);
|
depthStencilAttachment->stencilReadOnly);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!std::isnan(depthStencilAttachment->clearDepth)) {
|
if (depthStencilAttachment->depthLoadOp == wgpu::LoadOp::Clear) {
|
||||||
DAWN_TRY(DAWN_MAKE_DEPRECATION_ERROR(
|
|
||||||
device, "clearDepth is deprecated, prefer depthClearValue instead."));
|
|
||||||
DAWN_INVALID_IF(
|
|
||||||
depthStencilAttachment->clearDepth < 0.0f || depthStencilAttachment->clearDepth > 1.0f,
|
|
||||||
"clearDepth is not between 0.0 and 1.0");
|
|
||||||
|
|
||||||
} else if (depthStencilAttachment->depthLoadOp == wgpu::LoadOp::Clear) {
|
|
||||||
DAWN_INVALID_IF(std::isnan(depthStencilAttachment->depthClearValue),
|
DAWN_INVALID_IF(std::isnan(depthStencilAttachment->depthClearValue),
|
||||||
"depthClearValue is NaN.");
|
"depthClearValue is NaN.");
|
||||||
DAWN_INVALID_IF(depthStencilAttachment->depthClearValue < 0.0f ||
|
DAWN_INVALID_IF(depthStencilAttachment->depthClearValue < 0.0f ||
|
||||||
|
@ -395,12 +379,6 @@ MaybeError ValidateRenderPassDepthStencilAttachment(
|
||||||
"depthClearValue is not between 0.0 and 1.0");
|
"depthClearValue is not between 0.0 and 1.0");
|
||||||
}
|
}
|
||||||
|
|
||||||
if (depthStencilAttachment->stencilClearValue == 0 &&
|
|
||||||
depthStencilAttachment->clearStencil != 0) {
|
|
||||||
DAWN_TRY(DAWN_MAKE_DEPRECATION_ERROR(
|
|
||||||
device, "clearStencil is deprecated, prefer stencilClearValue instead."));
|
|
||||||
}
|
|
||||||
|
|
||||||
// *sampleCount == 0 must only happen when there is no color attachment. In that case we
|
// *sampleCount == 0 must only happen when there is no color attachment. In that case we
|
||||||
// do not need to validate the sample count of the depth stencil attachment.
|
// do not need to validate the sample count of the depth stencil attachment.
|
||||||
const uint32_t depthStencilSampleCount = attachment->GetTexture()->GetSampleCount();
|
const uint32_t depthStencilSampleCount = attachment->GetTexture()->GetSampleCount();
|
||||||
|
@ -671,11 +649,6 @@ struct TemporaryResolveAttachment {
|
||||||
|
|
||||||
} // namespace
|
} // namespace
|
||||||
|
|
||||||
bool HasDeprecatedColor(const RenderPassColorAttachment& attachment) {
|
|
||||||
return !std::isnan(attachment.clearColor.r) || !std::isnan(attachment.clearColor.g) ||
|
|
||||||
!std::isnan(attachment.clearColor.b) || !std::isnan(attachment.clearColor.a);
|
|
||||||
}
|
|
||||||
|
|
||||||
Color ClampClearColorValueToLegalRange(const Color& originalColor, const Format& format) {
|
Color ClampClearColorValueToLegalRange(const Color& originalColor, const Format& format) {
|
||||||
const AspectInfo& aspectInfo = format.GetAspectInfo(Aspect::Color);
|
const AspectInfo& aspectInfo = format.GetAspectInfo(Aspect::Color);
|
||||||
double minValue = 0;
|
double minValue = 0;
|
||||||
|
@ -894,10 +867,7 @@ Ref<RenderPassEncoder> CommandEncoder::BeginRenderPass(const RenderPassDescripto
|
||||||
cmd->colorAttachments[index].loadOp = descriptor->colorAttachments[i].loadOp;
|
cmd->colorAttachments[index].loadOp = descriptor->colorAttachments[i].loadOp;
|
||||||
cmd->colorAttachments[index].storeOp = descriptor->colorAttachments[i].storeOp;
|
cmd->colorAttachments[index].storeOp = descriptor->colorAttachments[i].storeOp;
|
||||||
|
|
||||||
Color color = HasDeprecatedColor(descriptor->colorAttachments[i])
|
Color color = descriptor->colorAttachments[i].clearValue;
|
||||||
? descriptor->colorAttachments[i].clearColor
|
|
||||||
: descriptor->colorAttachments[i].clearValue;
|
|
||||||
|
|
||||||
cmd->colorAttachments[index].clearColor =
|
cmd->colorAttachments[index].clearColor =
|
||||||
ClampClearColorValueToLegalRange(color, view->GetFormat());
|
ClampClearColorValueToLegalRange(color, view->GetFormat());
|
||||||
|
|
||||||
|
@ -914,24 +884,10 @@ Ref<RenderPassEncoder> CommandEncoder::BeginRenderPass(const RenderPassDescripto
|
||||||
|
|
||||||
cmd->depthStencilAttachment.view = view;
|
cmd->depthStencilAttachment.view = view;
|
||||||
|
|
||||||
if (!std::isnan(descriptor->depthStencilAttachment->clearDepth)) {
|
|
||||||
// TODO(dawn:1269): Remove this branch after the deprecation period.
|
|
||||||
cmd->depthStencilAttachment.clearDepth =
|
|
||||||
descriptor->depthStencilAttachment->clearDepth;
|
|
||||||
} else {
|
|
||||||
cmd->depthStencilAttachment.clearDepth =
|
cmd->depthStencilAttachment.clearDepth =
|
||||||
descriptor->depthStencilAttachment->depthClearValue;
|
descriptor->depthStencilAttachment->depthClearValue;
|
||||||
}
|
|
||||||
|
|
||||||
if (descriptor->depthStencilAttachment->stencilClearValue == 0 &&
|
|
||||||
descriptor->depthStencilAttachment->clearStencil != 0) {
|
|
||||||
// TODO(dawn:1269): Remove this branch after the deprecation period.
|
|
||||||
cmd->depthStencilAttachment.clearStencil =
|
|
||||||
descriptor->depthStencilAttachment->clearStencil;
|
|
||||||
} else {
|
|
||||||
cmd->depthStencilAttachment.clearStencil =
|
cmd->depthStencilAttachment.clearStencil =
|
||||||
descriptor->depthStencilAttachment->stencilClearValue;
|
descriptor->depthStencilAttachment->stencilClearValue;
|
||||||
}
|
|
||||||
|
|
||||||
// Copy parameters for the depth, reyifing the values when it is not present or
|
// Copy parameters for the depth, reyifing the values when it is not present or
|
||||||
// readonly.
|
// readonly.
|
||||||
|
|
|
@ -107,7 +107,6 @@ void frame() {
|
||||||
colorAttachment.view = backbufferView;
|
colorAttachment.view = backbufferView;
|
||||||
colorAttachment.resolveTarget = nullptr;
|
colorAttachment.resolveTarget = nullptr;
|
||||||
colorAttachment.clearValue = {0.0f, 0.0f, 0.0f, 0.0f};
|
colorAttachment.clearValue = {0.0f, 0.0f, 0.0f, 0.0f};
|
||||||
colorAttachment.clearColor = {NAN, NAN, NAN, NAN};
|
|
||||||
colorAttachment.loadOp = WGPULoadOp_Clear;
|
colorAttachment.loadOp = WGPULoadOp_Clear;
|
||||||
colorAttachment.storeOp = WGPUStoreOp_Store;
|
colorAttachment.storeOp = WGPUStoreOp_Store;
|
||||||
renderpassInfo.colorAttachmentCount = 1;
|
renderpassInfo.colorAttachmentCount = 1;
|
||||||
|
|
|
@ -82,54 +82,6 @@ TEST_P(DeprecationTests, ReadOnlyDepthStencilStoreLoadOpsAttachment) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Test that setting the clearColor, clearDepth, or clearStencil values for render pass attachments
|
|
||||||
// is deprecated. (dawn:1269)
|
|
||||||
TEST_P(DeprecationTests, AttachmentClearColor) {
|
|
||||||
utils::BasicRenderPass renderPass = utils::CreateBasicRenderPass(device, 1, 1);
|
|
||||||
wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
|
|
||||||
wgpu::RenderPassEncoder pass;
|
|
||||||
|
|
||||||
// Check that setting load/store ops with read only depth/stencil attachments gives a warning.
|
|
||||||
wgpu::TextureDescriptor descriptor;
|
|
||||||
descriptor.dimension = wgpu::TextureDimension::e2D;
|
|
||||||
descriptor.size = {1, 1, 1};
|
|
||||||
descriptor.sampleCount = 1;
|
|
||||||
descriptor.format = wgpu::TextureFormat::Depth24PlusStencil8;
|
|
||||||
descriptor.mipLevelCount = 1;
|
|
||||||
descriptor.usage = wgpu::TextureUsage::RenderAttachment;
|
|
||||||
wgpu::Texture depthStencil = device.CreateTexture(&descriptor);
|
|
||||||
|
|
||||||
wgpu::RenderPassDepthStencilAttachment* depthAttachment =
|
|
||||||
&renderPass.renderPassInfo.cDepthStencilAttachmentInfo;
|
|
||||||
renderPass.renderPassInfo.depthStencilAttachment = depthAttachment;
|
|
||||||
depthAttachment->view = depthStencil.CreateView();
|
|
||||||
depthAttachment->depthLoadOp = wgpu::LoadOp::Clear;
|
|
||||||
depthAttachment->stencilLoadOp = wgpu::LoadOp::Clear;
|
|
||||||
|
|
||||||
// A pass that uses none of the deprecated value should be fine.
|
|
||||||
pass = encoder.BeginRenderPass(&renderPass.renderPassInfo);
|
|
||||||
pass.End();
|
|
||||||
|
|
||||||
depthAttachment->clearStencil = 1;
|
|
||||||
|
|
||||||
EXPECT_DEPRECATION_WARNING_ONLY(pass = encoder.BeginRenderPass(&renderPass.renderPassInfo));
|
|
||||||
pass.End();
|
|
||||||
|
|
||||||
depthAttachment->clearStencil = 0;
|
|
||||||
depthAttachment->depthClearValue = 0.0f;
|
|
||||||
depthAttachment->clearDepth = 1.0f;
|
|
||||||
|
|
||||||
EXPECT_DEPRECATION_WARNING_ONLY(pass = encoder.BeginRenderPass(&renderPass.renderPassInfo));
|
|
||||||
pass.End();
|
|
||||||
|
|
||||||
renderPass.renderPassInfo.depthStencilAttachment = nullptr;
|
|
||||||
renderPass.renderPassInfo.cColorAttachments[0].clearColor = {1.0, 2.0, 3.0, 4.0};
|
|
||||||
renderPass.renderPassInfo.cColorAttachments[0].clearValue = {5.0, 4.0, 3.0, 2.0};
|
|
||||||
|
|
||||||
EXPECT_DEPRECATION_WARNING_ONLY(pass = encoder.BeginRenderPass(&renderPass.renderPassInfo));
|
|
||||||
pass.End();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test that endPass() is deprecated for both render and compute passes.
|
// Test that endPass() is deprecated for both render and compute passes.
|
||||||
TEST_P(DeprecationTests, EndPass) {
|
TEST_P(DeprecationTests, EndPass) {
|
||||||
wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
|
wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
|
||||||
|
|
Loading…
Reference in New Issue