blob: 506c0d317d91ff4da45b783e056537a4bd150eed [file] [log] [blame]
// Copyright 2021 The Dawn Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "tests/DawnTest.h"
#include <sstream>
#include <vector>
#include "utils/ComboRenderPipelineDescriptor.h"
#include "utils/WGPUHelpers.h"
constexpr uint32_t kRTSize = 1;
enum class DrawMode {
NonIndexed,
Indexed,
};
enum class CheckIndex : uint32_t {
Vertex = 0x0000001,
Instance = 0x0000002,
};
namespace wgpu {
template <>
struct IsDawnBitmask<CheckIndex> {
static constexpr bool enable = true;
};
} // namespace wgpu
class FirstIndexOffsetTests : public DawnTest {
public:
void TestVertexIndex(DrawMode mode, uint32_t firstVertex);
void TestInstanceIndex(DrawMode mode, uint32_t firstInstance);
void TestBothIndices(DrawMode mode, uint32_t firstVertex, uint32_t firstInstance);
protected:
void SetUp() override {
DawnTest::SetUp();
// WGSL doesn't have the ability to tag attributes as "flat". "flat" is required on u32
// attributes for correct runtime behavior under Vulkan and codegen under OpenGL(ES).
// TODO(tint:451): Remove once resolved by spec/tint
DAWN_SUPPRESS_TEST_IF(IsVulkan() || IsOpenGL() || IsOpenGLES());
}
private:
void TestImpl(DrawMode mode,
CheckIndex checkIndex,
uint32_t vertexIndex,
uint32_t instanceIndex);
};
void FirstIndexOffsetTests::TestVertexIndex(DrawMode mode, uint32_t firstVertex) {
TestImpl(mode, CheckIndex::Vertex, firstVertex, 0);
}
void FirstIndexOffsetTests::TestInstanceIndex(DrawMode mode, uint32_t firstInstance) {
TestImpl(mode, CheckIndex::Instance, 0, firstInstance);
}
void FirstIndexOffsetTests::TestBothIndices(DrawMode mode,
uint32_t firstVertex,
uint32_t firstInstance) {
using wgpu::operator|;
TestImpl(mode, CheckIndex::Vertex | CheckIndex::Instance, firstVertex, firstInstance);
}
// Conditionally tests if first/baseVertex and/or firstInstance have been correctly passed to the
// vertex shader. Since vertex shaders can't write to storage buffers, we pass vertex/instance
// indices to a fragment shader via u32 attributes. The fragment shader runs once and writes the
// values to a storage buffer. If vertex index is used, the vertex buffer is padded with 0s.
void FirstIndexOffsetTests::TestImpl(DrawMode mode,
CheckIndex checkIndex,
uint32_t firstVertex,
uint32_t firstInstance) {
using wgpu::operator&;
std::stringstream vertexInputs;
std::stringstream vertexOutputs;
std::stringstream vertexBody;
std::stringstream fragmentInputs;
std::stringstream fragmentBody;
vertexInputs << " [[location(0)]] position : vec4<f32>;\n";
vertexOutputs << " [[builtin(position)]] position : vec4<f32>;\n";
if ((checkIndex & CheckIndex::Vertex) != 0) {
vertexInputs << " [[builtin(vertex_index)]] vertex_index : u32;\n";
vertexOutputs << " [[location(1)]] vertex_index : u32;\n";
vertexBody << " output.vertex_index = input.vertex_index;\n";
fragmentInputs << " [[location(1)]] vertex_index : u32;\n";
fragmentBody << " idx_vals.vertex_index = input.vertex_index;\n";
}
if ((checkIndex & CheckIndex::Instance) != 0) {
vertexInputs << " [[builtin(instance_index)]] instance_index : u32;\n";
vertexOutputs << " [[location(2)]] instance_index : u32;\n";
vertexBody << " output.instance_index = input.instance_index;\n";
fragmentInputs << " [[location(2)]] instance_index : u32;\n";
fragmentBody << " idx_vals.instance_index = input.instance_index;\n";
}
std::string vertexShader = R"(
struct VertexInputs {
)" + vertexInputs.str() + R"(
};
struct VertexOutputs {
)" + vertexOutputs.str() + R"(
};
[[stage(vertex)]] fn main(input : VertexInputs) -> VertexOutputs {
var output : VertexOutputs;
)" + vertexBody.str() + R"(
output.position = input.position;
return output;
})";
std::string fragmentShader = R"(
[[block]] struct IndexVals {
vertex_index : u32;
instance_index : u32;
};
[[group(0), binding(0)]] var<storage, read_write> idx_vals : IndexVals;
struct FragInputs {
)" + fragmentInputs.str() + R"(
};
[[stage(fragment)]] fn main(input : FragInputs) {
)" + fragmentBody.str() + R"(
})";
utils::BasicRenderPass renderPass = utils::CreateBasicRenderPass(device, kRTSize, kRTSize);
constexpr uint32_t kComponentsPerVertex = 4;
utils::ComboRenderPipelineDescriptor pipelineDesc;
pipelineDesc.vertex.module = utils::CreateShaderModule(device, vertexShader.c_str());
pipelineDesc.cFragment.module = utils::CreateShaderModule(device, fragmentShader.c_str());
pipelineDesc.primitive.topology = wgpu::PrimitiveTopology::PointList;
pipelineDesc.vertex.bufferCount = 1;
pipelineDesc.cBuffers[0].arrayStride = kComponentsPerVertex * sizeof(float);
pipelineDesc.cBuffers[0].attributeCount = 1;
pipelineDesc.cAttributes[0].format = wgpu::VertexFormat::Float32x4;
pipelineDesc.cTargets[0].format = renderPass.colorFormat;
wgpu::RenderPipeline pipeline = device.CreateRenderPipeline(&pipelineDesc);
std::vector<float> vertexData(firstVertex * kComponentsPerVertex);
vertexData.insert(vertexData.end(), {0, 0, 0, 1});
wgpu::Buffer vertices = utils::CreateBufferFromData(
device, vertexData.data(), vertexData.size() * sizeof(float), wgpu::BufferUsage::Vertex);
wgpu::Buffer indices =
utils::CreateBufferFromData<uint32_t>(device, wgpu::BufferUsage::Index, {0});
wgpu::Buffer buffer = utils::CreateBufferFromData(
device, wgpu::BufferUsage::CopySrc | wgpu::BufferUsage::Storage, {0u, 0u});
wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
wgpu::RenderPassEncoder pass = encoder.BeginRenderPass(&renderPass.renderPassInfo);
pass.SetPipeline(pipeline);
pass.SetVertexBuffer(0, vertices);
pass.SetBindGroup(0,
utils::MakeBindGroup(device, pipeline.GetBindGroupLayout(0), {{0, buffer}}));
if (mode == DrawMode::Indexed) {
pass.SetIndexBuffer(indices, wgpu::IndexFormat::Uint32);
pass.DrawIndexed(1, 1, 0, firstVertex, firstInstance);
} else {
pass.Draw(1, 1, firstVertex, firstInstance);
}
pass.EndPass();
wgpu::CommandBuffer commands = encoder.Finish();
queue.Submit(1, &commands);
std::array<uint32_t, 2> expected = {firstVertex, firstInstance};
EXPECT_BUFFER_U32_RANGE_EQ(expected.data(), buffer, 0, expected.size());
}
// Test that vertex_index starts at 7 when drawn using Draw()
TEST_P(FirstIndexOffsetTests, NonIndexedVertexOffset) {
TestVertexIndex(DrawMode::NonIndexed, 7);
}
// Test that instance_index starts at 11 when drawn using Draw()
TEST_P(FirstIndexOffsetTests, NonIndexedInstanceOffset) {
TestInstanceIndex(DrawMode::NonIndexed, 11);
}
// Test that vertex_index and instance_index start at 7 and 11 respectively when drawn using Draw()
TEST_P(FirstIndexOffsetTests, NonIndexedBothOffset) {
TestBothIndices(DrawMode::NonIndexed, 7, 11);
}
// Test that vertex_index starts at 7 when drawn using DrawIndexed()
TEST_P(FirstIndexOffsetTests, IndexedVertex) {
TestVertexIndex(DrawMode::Indexed, 7);
}
// Test that instance_index starts at 11 when drawn using DrawIndexed()
TEST_P(FirstIndexOffsetTests, IndexedInstance) {
TestInstanceIndex(DrawMode::Indexed, 11);
}
// Test that vertex_index and instance_index start at 7 and 11 respectively when drawn using
// DrawIndexed()
TEST_P(FirstIndexOffsetTests, IndexedBothOffset) {
TestBothIndices(DrawMode::Indexed, 7, 11);
}
DAWN_INSTANTIATE_TEST(FirstIndexOffsetTests,
D3D12Backend({"use_tint_generator"}),
MetalBackend(),
OpenGLBackend(),
OpenGLESBackend(),
VulkanBackend());