Flutter Impeller
shader_types.h
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef FLUTTER_IMPELLER_CORE_SHADER_TYPES_H_
6 #define FLUTTER_IMPELLER_CORE_SHADER_TYPES_H_
7 
8 #include <cstddef>
9 #include <cstdint>
10 #include <optional>
11 #include <string_view>
12 #include <vector>
13 
14 #include "flutter/fml/hash_combine.h"
15 #include "flutter/fml/logging.h"
17 #include "impeller/geometry/half.h"
19 
20 namespace impeller {
21 
22 enum class ShaderStage {
23  kUnknown,
24  kVertex,
25  kFragment,
26  kCompute,
27 };
28 
30  switch (stage) {
32  return ShaderStage::kVertex;
36  return ShaderStage::kCompute;
37  }
38  FML_UNREACHABLE();
39 }
40 
41 enum class ShaderType {
42  kUnknown,
43  kVoid,
44  kBoolean,
49  kSignedInt,
54  kHalfFloat,
55  kFloat,
56  kDouble,
57  kStruct,
58  kImage,
60  kSampler,
61 };
62 
65  std::string name;
66  size_t offset;
67  size_t size;
68  size_t byte_length;
69  std::optional<size_t> array_elements;
70 };
71 
73  // This must match the uniform name in the shader program.
74  std::string name;
75  std::vector<ShaderStructMemberMetadata> members;
76 };
77 
78 /// @brief Metadata required to bind a buffer.
79 ///
80 /// OpenGL binding requires the usage of the separate shader metadata struct.
82  /// @brief The name of the uniform slot.
83  const char* name;
84 
85  /// @brief `ext_res_0` is the Metal binding value.
86  size_t ext_res_0;
87 
88  /// @brief The Vulkan descriptor set index.
89  size_t set;
90 
91  /// @brief The Vulkan binding value.
92  size_t binding;
93 };
94 
95 /// @brief Metadata required to bind a combined texture and sampler.
96 ///
97 /// OpenGL binding requires the usage of the separate shader metadata struct.
99  /// @brief The name of the uniform slot.
100  const char* name;
101 
102  /// @brief `ext_res_0` is the Metal binding value.
104 
105  /// @brief The Vulkan descriptor set index.
106  size_t set;
107 
108  /// @brief The Vulkan binding value.
109  size_t binding;
110 };
111 
113  const char* name;
114  size_t location;
115  size_t set;
116  size_t binding;
118  size_t bit_width;
119  size_t vec_size;
120  size_t columns;
121  size_t offset;
122 
123  constexpr size_t GetHash() const {
124  return fml::HashCombine(name, location, set, binding, type, bit_width,
126  }
127 
128  constexpr bool operator==(const ShaderStageIOSlot& other) const {
129  return name == other.name && //
130  location == other.location && //
131  set == other.set && //
132  binding == other.binding && //
133  type == other.type && //
134  bit_width == other.bit_width && //
135  vec_size == other.vec_size && //
136  columns == other.columns && //
137  offset == other.offset;
138  }
139 };
140 
142  size_t stride;
143  size_t binding;
144 
145  constexpr size_t GetHash() const { return fml::HashCombine(stride, binding); }
146 
147  constexpr bool operator==(const ShaderStageBufferLayout& other) const {
148  return stride == other.stride && //
149  binding == other.binding;
150  }
151 };
152 
153 enum class DescriptorType {
157  kImage,
158  kSampler,
160 };
161 
163  uint32_t binding;
166 };
167 
168 template <size_t Size>
169 struct Padding {
170  private:
171  uint8_t pad_[Size];
172 };
173 
174 /// @brief Struct used for padding uniform buffer array elements.
175 template <typename T,
176  size_t Size,
177  class = std::enable_if_t<std::is_standard_layout_v<T>>>
178 struct Padded {
179  T value;
181 
182  Padded(T p_value) : value(p_value){}; // NOLINT(google-explicit-constructor)
183 };
184 
185 inline constexpr Vector4 ToVector(Color color) {
186  return {color.red, color.green, color.blue, color.alpha};
187 }
188 
189 } // namespace impeller
190 
191 #endif // FLUTTER_IMPELLER_CORE_SHADER_TYPES_H_
impeller::ShaderStageIOSlot::binding
size_t binding
Definition: shader_types.h:116
impeller::ShaderStructMemberMetadata
Definition: shader_types.h:63
impeller::ShaderStageIOSlot::name
const char * name
Definition: shader_types.h:113
impeller::ShaderStageIOSlot
Definition: shader_types.h:112
impeller::ShaderUniformSlot::ext_res_0
size_t ext_res_0
ext_res_0 is the Metal binding value.
Definition: shader_types.h:86
impeller::SampledImageSlot::name
const char * name
The name of the uniform slot.
Definition: shader_types.h:100
impeller::DescriptorSetLayout
Definition: shader_types.h:162
impeller::Padded
Struct used for padding uniform buffer array elements.
Definition: shader_types.h:178
impeller::ShaderUniformSlot
Metadata required to bind a buffer.
Definition: shader_types.h:81
impeller::ShaderType::kAtomicCounter
@ kAtomicCounter
impeller::ShaderStageIOSlot::columns
size_t columns
Definition: shader_types.h:120
impeller::RuntimeShaderStage
RuntimeShaderStage
Definition: runtime_types.h:28
impeller::ShaderType::kDouble
@ kDouble
impeller::ShaderStageIOSlot::offset
size_t offset
Definition: shader_types.h:121
impeller::Padded::_PADDING_
Padding< Size > _PADDING_
Definition: shader_types.h:180
impeller::ShaderStage::kUnknown
@ kUnknown
impeller::ShaderType
ShaderType
Definition: shader_types.h:41
impeller::Color
Definition: color.h:124
impeller::ShaderMetadata
Definition: shader_types.h:72
impeller::Vector4
Definition: vector.h:232
impeller::ShaderStageBufferLayout::binding
size_t binding
Definition: shader_types.h:143
impeller::Padded::value
T value
Definition: shader_types.h:179
impeller::ShaderType::kSignedInt64
@ kSignedInt64
impeller::ShaderStructMemberMetadata::byte_length
size_t byte_length
Definition: shader_types.h:68
impeller::ShaderType::kImage
@ kImage
impeller::Color::alpha
Scalar alpha
Definition: color.h:143
impeller::ShaderStage
ShaderStage
Definition: shader_types.h:22
impeller::DescriptorSetLayout::shader_stage
ShaderStage shader_stage
Definition: shader_types.h:165
impeller::Padded::Padded
Padded(T p_value)
Definition: shader_types.h:182
impeller::ShaderType::kVoid
@ kVoid
impeller::ShaderUniformSlot::name
const char * name
The name of the uniform slot.
Definition: shader_types.h:83
impeller::DescriptorType::kImage
@ kImage
impeller::ShaderStageBufferLayout
Definition: shader_types.h:141
impeller::Size
TSize< Scalar > Size
Definition: size.h:137
impeller::ShaderType::kSignedByte
@ kSignedByte
impeller::ShaderMetadata::name
std::string name
Definition: shader_types.h:74
impeller::Color::green
Scalar green
Definition: color.h:133
impeller::ShaderType::kUnsignedShort
@ kUnsignedShort
impeller::ToShaderStage
constexpr ShaderStage ToShaderStage(RuntimeShaderStage stage)
Definition: shader_types.h:29
runtime_types.h
impeller::ShaderType::kUnsignedInt64
@ kUnsignedInt64
impeller::RuntimeShaderStage::kVertex
@ kVertex
impeller::ShaderStructMemberMetadata::offset
size_t offset
Definition: shader_types.h:66
impeller::ShaderType::kUnsignedByte
@ kUnsignedByte
impeller::ShaderType::kFloat
@ kFloat
matrix.h
impeller::ShaderUniformSlot::binding
size_t binding
The Vulkan binding value.
Definition: shader_types.h:92
impeller::RuntimeShaderStage::kFragment
@ kFragment
impeller::ShaderStageIOSlot::bit_width
size_t bit_width
Definition: shader_types.h:118
impeller::Padding
Definition: shader_types.h:169
impeller::ShaderType::kBoolean
@ kBoolean
impeller::ShaderStageIOSlot::set
size_t set
Definition: shader_types.h:115
impeller::ShaderType::kSampler
@ kSampler
impeller::ShaderStructMemberMetadata::size
size_t size
Definition: shader_types.h:67
impeller::ShaderStructMemberMetadata::array_elements
std::optional< size_t > array_elements
Definition: shader_types.h:69
impeller::DescriptorType::kSampler
@ kSampler
impeller::SampledImageSlot
Metadata required to bind a combined texture and sampler.
Definition: shader_types.h:98
impeller::Color::red
Scalar red
Definition: color.h:128
impeller::ShaderType::kSampledImage
@ kSampledImage
impeller::ShaderStage::kFragment
@ kFragment
impeller::ShaderStageIOSlot::GetHash
constexpr size_t GetHash() const
Definition: shader_types.h:123
impeller::DescriptorType::kSampledImage
@ kSampledImage
impeller::ShaderStructMemberMetadata::name
std::string name
Definition: shader_types.h:65
impeller::DescriptorType::kUniformBuffer
@ kUniformBuffer
impeller::ShaderStageIOSlot::location
size_t location
Definition: shader_types.h:114
impeller::ShaderType::kUnsignedInt
@ kUnsignedInt
impeller::ShaderStageIOSlot::operator==
constexpr bool operator==(const ShaderStageIOSlot &other) const
Definition: shader_types.h:128
impeller::ShaderType::kStruct
@ kStruct
half.h
impeller::ShaderType::kSignedShort
@ kSignedShort
impeller::ShaderType::kHalfFloat
@ kHalfFloat
impeller::ShaderType::kSignedInt
@ kSignedInt
impeller::ShaderStageIOSlot::type
ShaderType type
Definition: shader_types.h:117
impeller::ShaderStage::kVertex
@ kVertex
impeller::ToVector
constexpr Vector4 ToVector(Color color)
Definition: shader_types.h:185
impeller::SampledImageSlot::set
size_t set
The Vulkan descriptor set index.
Definition: shader_types.h:106
impeller::RuntimeShaderStage::kCompute
@ kCompute
impeller::ShaderStageBufferLayout::GetHash
constexpr size_t GetHash() const
Definition: shader_types.h:145
impeller::ShaderUniformSlot::set
size_t set
The Vulkan descriptor set index.
Definition: shader_types.h:89
impeller::SampledImageSlot::texture_index
size_t texture_index
ext_res_0 is the Metal binding value.
Definition: shader_types.h:103
impeller::ShaderStageBufferLayout::stride
size_t stride
Definition: shader_types.h:142
impeller::DescriptorType::kInputAttachment
@ kInputAttachment
impeller::ShaderStage::kCompute
@ kCompute
impeller::ShaderStructMemberMetadata::type
ShaderType type
Definition: shader_types.h:64
impeller::ShaderType::kUnknown
@ kUnknown
impeller::SampledImageSlot::binding
size_t binding
The Vulkan binding value.
Definition: shader_types.h:109
impeller::Color::blue
Scalar blue
Definition: color.h:138
impeller::DescriptorSetLayout::descriptor_type
DescriptorType descriptor_type
Definition: shader_types.h:164
impeller::ShaderMetadata::members
std::vector< ShaderStructMemberMetadata > members
Definition: shader_types.h:75
impeller::ShaderStageBufferLayout::operator==
constexpr bool operator==(const ShaderStageBufferLayout &other) const
Definition: shader_types.h:147
impeller
Definition: aiks_blur_unittests.cc:20
impeller::ShaderStageIOSlot::vec_size
size_t vec_size
Definition: shader_types.h:119
impeller::DescriptorSetLayout::binding
uint32_t binding
Definition: shader_types.h:163
impeller::DescriptorType::kStorageBuffer
@ kStorageBuffer
impeller::DescriptorType
DescriptorType
Definition: shader_types.h:153