2019-07-18 09:25:04 +00:00
|
|
|
// Copyright 2019 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 "dawn_native/Format.h"
|
2020-07-30 15:25:37 +00:00
|
|
|
|
2019-08-02 00:06:38 +00:00
|
|
|
#include "dawn_native/Device.h"
|
|
|
|
#include "dawn_native/Extensions.h"
|
2020-07-30 15:25:37 +00:00
|
|
|
#include "dawn_native/Texture.h"
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
#include <bitset>
|
|
|
|
|
|
|
|
namespace dawn_native {
|
|
|
|
|
2020-10-15 09:05:03 +00:00
|
|
|
namespace {
|
|
|
|
|
2020-10-16 14:07:06 +00:00
|
|
|
static const AspectInfo kStencil8AspectInfo = {{1, 1, 1},
|
|
|
|
wgpu::TextureComponentType::Uint,
|
|
|
|
ComponentTypeBit::Uint};
|
2020-10-15 09:05:03 +00:00
|
|
|
}
|
|
|
|
|
2019-07-18 09:25:04 +00:00
|
|
|
// Format
|
|
|
|
|
2020-12-21 20:14:26 +00:00
|
|
|
// TODO(dawn:527): Remove when unused.
|
2020-10-16 14:07:06 +00:00
|
|
|
ComponentTypeBit ToComponentTypeBit(wgpu::TextureComponentType type) {
|
|
|
|
switch (type) {
|
2019-11-22 17:02:22 +00:00
|
|
|
case wgpu::TextureComponentType::Float:
|
|
|
|
case wgpu::TextureComponentType::Sint:
|
|
|
|
case wgpu::TextureComponentType::Uint:
|
2020-10-16 14:13:16 +00:00
|
|
|
case wgpu::TextureComponentType::DepthComparison:
|
2020-10-16 14:07:06 +00:00
|
|
|
// When the compiler complains that you need to add a case statement here, please
|
|
|
|
// also add a corresponding static assert below!
|
2019-11-22 17:02:22 +00:00
|
|
|
break;
|
|
|
|
}
|
2019-10-31 09:51:11 +00:00
|
|
|
|
2020-10-16 14:07:06 +00:00
|
|
|
// Check that ComponentTypeBit bits are in the same position / order as the respective
|
|
|
|
// wgpu::TextureComponentType value.
|
|
|
|
static_assert(ComponentTypeBit::Float ==
|
|
|
|
static_cast<ComponentTypeBit>(
|
|
|
|
1 << static_cast<uint32_t>(wgpu::TextureComponentType::Float)),
|
|
|
|
"");
|
|
|
|
static_assert(ComponentTypeBit::Uint ==
|
|
|
|
static_cast<ComponentTypeBit>(
|
|
|
|
1 << static_cast<uint32_t>(wgpu::TextureComponentType::Uint)),
|
|
|
|
"");
|
|
|
|
static_assert(ComponentTypeBit::Sint ==
|
|
|
|
static_cast<ComponentTypeBit>(
|
|
|
|
1 << static_cast<uint32_t>(wgpu::TextureComponentType::Sint)),
|
|
|
|
"");
|
2020-10-16 14:13:16 +00:00
|
|
|
static_assert(
|
|
|
|
ComponentTypeBit::DepthComparison ==
|
|
|
|
static_cast<ComponentTypeBit>(
|
|
|
|
1 << static_cast<uint32_t>(wgpu::TextureComponentType::DepthComparison)),
|
|
|
|
"");
|
2020-10-16 14:07:06 +00:00
|
|
|
return static_cast<ComponentTypeBit>(1 << static_cast<uint32_t>(type));
|
2019-11-22 17:02:22 +00:00
|
|
|
}
|
|
|
|
|
2020-12-21 20:14:26 +00:00
|
|
|
ComponentTypeBit SampleTypeToComponentTypeBit(wgpu::TextureSampleType sampleType) {
|
|
|
|
switch (sampleType) {
|
|
|
|
case wgpu::TextureSampleType::Float:
|
|
|
|
case wgpu::TextureSampleType::UnfilterableFloat:
|
|
|
|
return ComponentTypeBit::Float;
|
|
|
|
case wgpu::TextureSampleType::Sint:
|
|
|
|
return ComponentTypeBit::Sint;
|
|
|
|
case wgpu::TextureSampleType::Uint:
|
|
|
|
return ComponentTypeBit::Uint;
|
|
|
|
case wgpu::TextureSampleType::Depth:
|
|
|
|
return ComponentTypeBit::DepthComparison;
|
|
|
|
case wgpu::TextureSampleType::Undefined:
|
|
|
|
UNREACHABLE();
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO(dawn:527): Ideally we can get this path to use that static_cast method as well.
|
|
|
|
}
|
|
|
|
|
2019-07-18 09:25:04 +00:00
|
|
|
bool Format::IsColor() const {
|
2020-07-30 15:25:37 +00:00
|
|
|
return aspects == Aspect::Color;
|
2019-07-18 09:25:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool Format::HasDepth() const {
|
2020-07-30 15:25:37 +00:00
|
|
|
return (aspects & Aspect::Depth) != 0;
|
2019-07-18 09:25:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool Format::HasStencil() const {
|
2020-07-30 15:25:37 +00:00
|
|
|
return (aspects & Aspect::Stencil) != 0;
|
2019-07-18 09:25:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool Format::HasDepthOrStencil() const {
|
2020-07-30 15:25:37 +00:00
|
|
|
return (aspects & (Aspect::Depth | Aspect::Stencil)) != 0;
|
2019-07-18 09:25:04 +00:00
|
|
|
}
|
|
|
|
|
2020-10-15 09:05:03 +00:00
|
|
|
const AspectInfo& Format::GetAspectInfo(wgpu::TextureAspect aspect) const {
|
|
|
|
return GetAspectInfo(ConvertAspect(*this, aspect));
|
2020-07-30 15:29:57 +00:00
|
|
|
}
|
|
|
|
|
2020-10-15 09:05:03 +00:00
|
|
|
const AspectInfo& Format::GetAspectInfo(Aspect aspect) const {
|
2020-08-06 17:00:29 +00:00
|
|
|
ASSERT(HasOneBit(aspect));
|
|
|
|
ASSERT(aspects & aspect);
|
2020-09-24 14:56:50 +00:00
|
|
|
|
2020-10-15 16:42:03 +00:00
|
|
|
// The stencil aspect is the only aspect that's not the first aspect. Since it is always the
|
2020-10-15 09:05:03 +00:00
|
|
|
// same aspect information, special case it to return a constant AspectInfo.
|
|
|
|
if (aspect == Aspect::Stencil) {
|
|
|
|
return kStencil8AspectInfo;
|
|
|
|
} else {
|
|
|
|
return firstAspect;
|
2020-08-06 17:00:29 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-07-18 09:25:04 +00:00
|
|
|
size_t Format::GetIndex() const {
|
|
|
|
return ComputeFormatIndex(format);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Implementation details of the format table of the DeviceBase
|
|
|
|
|
|
|
|
// For the enum for formats are packed but this might change when we have a broader extension
|
2019-09-05 09:12:32 +00:00
|
|
|
// mechanism for webgpu.h. Formats start at 1 because 0 is the undefined format.
|
2019-10-23 11:57:41 +00:00
|
|
|
size_t ComputeFormatIndex(wgpu::TextureFormat format) {
|
2019-09-05 09:12:32 +00:00
|
|
|
// This takes advantage of overflows to make the index of TextureFormat::Undefined outside
|
|
|
|
// of the range of the FormatTable.
|
2019-10-23 11:57:41 +00:00
|
|
|
static_assert(static_cast<uint32_t>(wgpu::TextureFormat::Undefined) - 1 > kKnownFormatCount,
|
2019-09-05 09:12:32 +00:00
|
|
|
"");
|
|
|
|
return static_cast<size_t>(static_cast<uint32_t>(format) - 1);
|
2019-07-18 09:25:04 +00:00
|
|
|
}
|
|
|
|
|
2019-08-02 00:06:38 +00:00
|
|
|
FormatTable BuildFormatTable(const DeviceBase* device) {
|
2019-07-18 09:25:04 +00:00
|
|
|
FormatTable table;
|
|
|
|
std::bitset<kKnownFormatCount> formatsSet;
|
|
|
|
|
2020-10-16 14:07:06 +00:00
|
|
|
using Type = wgpu::TextureComponentType;
|
2019-08-21 12:16:33 +00:00
|
|
|
|
2019-07-18 09:25:04 +00:00
|
|
|
auto AddFormat = [&table, &formatsSet](Format format) {
|
|
|
|
size_t index = ComputeFormatIndex(format.format);
|
|
|
|
ASSERT(index < table.size());
|
|
|
|
|
|
|
|
// This checks that each format is set at most once, the first part of checking that all
|
|
|
|
// formats are set exactly once.
|
|
|
|
ASSERT(!formatsSet[index]);
|
|
|
|
|
2020-11-06 13:41:50 +00:00
|
|
|
// Vulkan describes bytesPerRow in units of texels. If there's any format for which this
|
|
|
|
// ASSERT isn't true, then additional validation on bytesPerRow must be added.
|
|
|
|
ASSERT((kTextureBytesPerRowAlignment % format.firstAspect.block.byteSize) == 0);
|
|
|
|
|
2019-07-18 09:25:04 +00:00
|
|
|
table[index] = format;
|
|
|
|
formatsSet.set(index);
|
|
|
|
};
|
|
|
|
|
2019-10-23 11:57:41 +00:00
|
|
|
auto AddColorFormat = [&AddFormat](wgpu::TextureFormat format, bool renderable,
|
2020-01-15 00:09:42 +00:00
|
|
|
bool supportsStorageUsage, uint32_t byteSize,
|
|
|
|
Type type) {
|
2019-07-18 09:25:04 +00:00
|
|
|
Format internalFormat;
|
|
|
|
internalFormat.format = format;
|
|
|
|
internalFormat.isRenderable = renderable;
|
|
|
|
internalFormat.isCompressed = false;
|
|
|
|
internalFormat.isSupported = true;
|
2020-01-15 00:09:42 +00:00
|
|
|
internalFormat.supportsStorageUsage = supportsStorageUsage;
|
2020-07-30 15:25:37 +00:00
|
|
|
internalFormat.aspects = Aspect::Color;
|
2020-10-15 09:05:03 +00:00
|
|
|
internalFormat.firstAspect.block.byteSize = byteSize;
|
|
|
|
internalFormat.firstAspect.block.width = 1;
|
|
|
|
internalFormat.firstAspect.block.height = 1;
|
2020-10-16 14:07:06 +00:00
|
|
|
internalFormat.firstAspect.baseType = type;
|
|
|
|
internalFormat.firstAspect.supportedComponentTypes = ToComponentTypeBit(type);
|
2019-07-18 09:25:04 +00:00
|
|
|
AddFormat(internalFormat);
|
|
|
|
};
|
|
|
|
|
2020-07-30 15:25:37 +00:00
|
|
|
auto AddDepthStencilFormat = [&AddFormat](wgpu::TextureFormat format, Aspect aspects,
|
2020-11-04 15:27:11 +00:00
|
|
|
uint32_t byteSize) {
|
2019-07-18 09:25:04 +00:00
|
|
|
Format internalFormat;
|
|
|
|
internalFormat.format = format;
|
|
|
|
internalFormat.isRenderable = true;
|
|
|
|
internalFormat.isCompressed = false;
|
|
|
|
internalFormat.isSupported = true;
|
2020-01-15 00:09:42 +00:00
|
|
|
internalFormat.supportsStorageUsage = false;
|
2020-07-30 15:25:37 +00:00
|
|
|
internalFormat.aspects = aspects;
|
2020-10-15 09:05:03 +00:00
|
|
|
internalFormat.firstAspect.block.byteSize = byteSize;
|
|
|
|
internalFormat.firstAspect.block.width = 1;
|
|
|
|
internalFormat.firstAspect.block.height = 1;
|
2020-10-16 14:07:06 +00:00
|
|
|
internalFormat.firstAspect.baseType = wgpu::TextureComponentType::Float;
|
2020-11-04 15:27:11 +00:00
|
|
|
internalFormat.firstAspect.supportedComponentTypes =
|
|
|
|
ComponentTypeBit::Float | ComponentTypeBit::DepthComparison;
|
2020-04-22 19:54:00 +00:00
|
|
|
AddFormat(internalFormat);
|
|
|
|
};
|
|
|
|
|
2019-10-23 11:57:41 +00:00
|
|
|
auto AddCompressedFormat = [&AddFormat](wgpu::TextureFormat format, uint32_t byteSize,
|
2019-08-02 00:06:38 +00:00
|
|
|
uint32_t width, uint32_t height, bool isSupported) {
|
2019-07-18 09:25:04 +00:00
|
|
|
Format internalFormat;
|
|
|
|
internalFormat.format = format;
|
|
|
|
internalFormat.isRenderable = false;
|
|
|
|
internalFormat.isCompressed = true;
|
2019-08-02 00:06:38 +00:00
|
|
|
internalFormat.isSupported = isSupported;
|
2020-01-15 00:09:42 +00:00
|
|
|
internalFormat.supportsStorageUsage = false;
|
2020-07-30 15:25:37 +00:00
|
|
|
internalFormat.aspects = Aspect::Color;
|
2020-10-15 09:05:03 +00:00
|
|
|
internalFormat.firstAspect.block.byteSize = byteSize;
|
|
|
|
internalFormat.firstAspect.block.width = width;
|
|
|
|
internalFormat.firstAspect.block.height = height;
|
2020-10-16 14:07:06 +00:00
|
|
|
internalFormat.firstAspect.baseType = wgpu::TextureComponentType::Float;
|
|
|
|
internalFormat.firstAspect.supportedComponentTypes = ComponentTypeBit::Float;
|
2019-07-18 09:25:04 +00:00
|
|
|
AddFormat(internalFormat);
|
|
|
|
};
|
|
|
|
|
|
|
|
// clang-format off
|
|
|
|
|
|
|
|
// 1 byte color formats
|
2020-01-15 00:09:42 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::R8Unorm, true, false, 1, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R8Snorm, false, false, 1, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R8Uint, true, false, 1, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R8Sint, true, false, 1, Type::Sint);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// 2 bytes color formats
|
2020-01-15 00:09:42 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::R16Uint, true, false, 2, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R16Sint, true, false, 2, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R16Float, true, false, 2, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG8Unorm, true, false, 2, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG8Snorm, false, false, 2, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG8Uint, true, false, 2, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG8Sint, true, false, 2, Type::Sint);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// 4 bytes color formats
|
2020-01-15 00:09:42 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::R32Uint, true, true, 4, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R32Sint, true, true, 4, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::R32Float, true, true, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG16Uint, true, false, 4, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG16Sint, true, false, 4, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG16Float, true, false, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA8Unorm, true, true, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA8UnormSrgb, true, false, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA8Snorm, false, true, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA8Uint, true, true, 4, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA8Sint, true, true, 4, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::BGRA8Unorm, true, false, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::BGRA8UnormSrgb, true, false, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGB10A2Unorm, true, false, 4, Type::Float);
|
|
|
|
|
2020-08-19 21:51:20 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::RG11B10Ufloat, false, false, 4, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGB9E5Ufloat, false, false, 4, Type::Float);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// 8 bytes color formats
|
2020-01-15 00:09:42 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::RG32Uint, true, true, 8, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG32Sint, true, true, 8, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RG32Float, true, true, 8, Type::Float);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA16Uint, true, true, 8, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA16Sint, true, true, 8, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA16Float, true, true, 8, Type::Float);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// 16 bytes color formats
|
2020-01-15 00:09:42 +00:00
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA32Uint, true, true, 16, Type::Uint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA32Sint, true, true, 16, Type::Sint);
|
|
|
|
AddColorFormat(wgpu::TextureFormat::RGBA32Float, true, true, 16, Type::Float);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
2020-10-16 14:07:06 +00:00
|
|
|
// Depth-stencil formats
|
2020-11-04 15:27:11 +00:00
|
|
|
AddDepthStencilFormat(wgpu::TextureFormat::Depth32Float, Aspect::Depth, 4);
|
|
|
|
AddDepthStencilFormat(wgpu::TextureFormat::Depth24Plus, Aspect::Depth, 4);
|
2019-07-18 09:25:04 +00:00
|
|
|
// TODO(cwallez@chromium.org): It isn't clear if this format should be copyable
|
|
|
|
// because its size isn't well defined, is it 4, 5 or 8?
|
2020-07-30 15:25:37 +00:00
|
|
|
AddDepthStencilFormat(wgpu::TextureFormat::Depth24PlusStencil8,
|
2020-11-04 15:27:11 +00:00
|
|
|
Aspect::Depth | Aspect::Stencil, 4);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// BC compressed formats
|
2019-08-02 00:06:38 +00:00
|
|
|
bool isBCFormatSupported = device->IsExtensionEnabled(Extension::TextureCompressionBC);
|
2019-10-23 11:57:41 +00:00
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC1RGBAUnorm, 8, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC1RGBAUnormSrgb, 8, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC4RSnorm, 8, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC4RUnorm, 8, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC2RGBAUnorm, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC2RGBAUnormSrgb, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC3RGBAUnorm, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC3RGBAUnormSrgb, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC5RGSnorm, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC5RGUnorm, 16, 4, 4, isBCFormatSupported);
|
2020-09-10 08:48:57 +00:00
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC6HRGBFloat, 16, 4, 4, isBCFormatSupported);
|
2019-10-23 11:57:41 +00:00
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC6HRGBUfloat, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC7RGBAUnorm, 16, 4, 4, isBCFormatSupported);
|
|
|
|
AddCompressedFormat(wgpu::TextureFormat::BC7RGBAUnormSrgb, 16, 4, 4, isBCFormatSupported);
|
2019-07-18 09:25:04 +00:00
|
|
|
|
|
|
|
// clang-format on
|
|
|
|
|
|
|
|
// This checks that each format is set at least once, the second part of checking that all
|
|
|
|
// formats are checked exactly once.
|
|
|
|
ASSERT(formatsSet.all());
|
|
|
|
|
|
|
|
return table;
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace dawn_native
|