blob: 9c98159b769451d14eb4f54a86fb31812b3703a3 [file] [log] [blame]
// Copyright 2022 The Tint 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.
////////////////////////////////////////////////////////////////////////////////
// File generated by 'tools/src/cmd/gen' using the template:
// src/tint/lang/core/address_space.h.tmpl
//
// To regenerate run: './tools/run gen'
//
// Do not modify this file directly
////////////////////////////////////////////////////////////////////////////////
#ifndef SRC_TINT_LANG_CORE_ADDRESS_SPACE_H_
#define SRC_TINT_LANG_CORE_ADDRESS_SPACE_H_
#include <cstdint>
#include "src/tint/utils/traits/traits.h"
namespace tint::core {
/// Address space of a given pointer.
enum class AddressSpace : uint8_t {
kUndefined,
kIn,
kOut,
kFunction,
kHandle, // Tint-internal enum entry - not parsed
kPixelLocal,
kPrivate,
kPushConstant,
kStorage,
kUniform,
kWorkgroup,
};
/// @param value the enum value
/// @returns the string for the given enum value
std::string_view ToString(AddressSpace value);
/// @param out the stream to write to
/// @param value the AddressSpace
/// @returns @p out so calls can be chained
template <typename STREAM, typename = traits::EnableIfIsOStream<STREAM>>
auto& operator<<(STREAM& out, AddressSpace value) {
return out << ToString(value);
}
/// ParseAddressSpace parses a AddressSpace from a string.
/// @param str the string to parse
/// @returns the parsed enum, or AddressSpace::kUndefined if the string could not be parsed.
AddressSpace ParseAddressSpace(std::string_view str);
constexpr const char* kAddressSpaceStrings[] = {
"__in", "__out", "function", "pixel_local", "private",
"push_constant", "storage", "uniform", "workgroup",
};
/// @returns true if the AddressSpace is host-shareable
/// @param address_space the AddressSpace
/// @see https://gpuweb.github.io/gpuweb/wgsl.html#host-shareable
inline bool IsHostShareable(AddressSpace address_space) {
return address_space == AddressSpace::kUniform || address_space == AddressSpace::kStorage ||
address_space == AddressSpace::kPushConstant;
}
} // namespace tint::core
#endif // SRC_TINT_LANG_CORE_ADDRESS_SPACE_H_