blob: aaf9df98bb0c78d243d48908824758f097b22ded [file] [log] [blame]
// Copyright 2020 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.
#ifndef SRC_AST_WORKGROUP_DECORATION_H_
#define SRC_AST_WORKGROUP_DECORATION_H_
#include <array>
#include <string>
#include "src/ast/decoration.h"
namespace tint {
namespace ast {
// Forward declaration
class Expression;
/// A workgroup decoration
class WorkgroupDecoration : public Castable<WorkgroupDecoration, Decoration> {
public:
/// constructor
/// @param program_id the identifier of the program that owns this node
/// @param source the source of this decoration
/// @param x the workgroup x dimension expression
/// @param y the optional workgroup y dimension expression
/// @param z the optional workgroup z dimension expression
WorkgroupDecoration(ProgramID program_id,
const Source& source,
ast::Expression* x,
ast::Expression* y = nullptr,
ast::Expression* z = nullptr);
~WorkgroupDecoration() override;
/// @returns the workgroup dimensions
std::array<ast::Expression*, 3> values() const { return {x_, y_, z_}; }
/// @returns the WGSL name for the decoration
std::string name() const override;
/// Outputs the decoration to the given stream
/// @param sem the semantic info for the program
/// @param out the stream to write to
/// @param indent number of spaces to indent the node when writing
void to_str(const sem::Info& sem,
std::ostream& out,
size_t indent) const override;
/// Clones this node and all transitive child nodes using the `CloneContext`
/// `ctx`.
/// @param ctx the clone context
/// @return the newly cloned node
WorkgroupDecoration* Clone(CloneContext* ctx) const override;
private:
ast::Expression* const x_ = nullptr;
ast::Expression* const y_ = nullptr;
ast::Expression* const z_ = nullptr;
};
} // namespace ast
} // namespace tint
#endif // SRC_AST_WORKGROUP_DECORATION_H_