1 // Copyright 2020 The Tint Authors.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #ifndef SRC_AST_STORAGE_CLASS_H_
16 #define SRC_AST_STORAGE_CLASS_H_
17
18 #include <ostream>
19
20 namespace tint {
21 namespace ast {
22
23 /// Storage class of a given pointer.
24 enum class StorageClass {
25 kInvalid = -1,
26 kNone,
27 kInput,
28 kOutput,
29 kUniform,
30 kWorkgroup,
31 kUniformConstant,
32 kStorage,
33 kImage,
34 kPrivate,
35 kFunction
36 };
37
38 /// @returns true if the StorageClass is host-shareable
39 /// @param sc the StorageClass
40 /// @see https://gpuweb.github.io/gpuweb/wgsl.html#host-shareable
IsHostShareable(StorageClass sc)41 inline bool IsHostShareable(StorageClass sc) {
42 return sc == ast::StorageClass::kUniform || sc == ast::StorageClass::kStorage;
43 }
44
45 /// @param sc the StorageClass
46 /// @return the name of the given storage class
47 const char* ToString(StorageClass sc);
48
49 /// @param out the std::ostream to write to
50 /// @param sc the StorageClass
51 /// @return the std::ostream so calls can be chained
52 std::ostream& operator<<(std::ostream& out, StorageClass sc);
53
54 } // namespace ast
55 } // namespace tint
56
57 #endif // SRC_AST_STORAGE_CLASS_H_
58