src/tint/writer/append_vector.h

// 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_TINT_WRITER_APPEND_VECTOR_H_
#define SRC_TINT_WRITER_APPEND_VECTOR_H_

#include "src/tint/program_builder.h"

// Forward declarations
namespace tint::ast {
class CallExpression;
class Expression;
}  // namespace tint::ast
namespace tint::sem {
class Call;
}  // namespace tint::sem

namespace tint::writer {

/// A helper function used to append a vector with an additional scalar.
/// If the scalar's type does not match the target vector element type,
/// then it is value-converted (via TypeInitializer) before being added.
/// All types must have been assigned to the expressions and their child nodes
/// before calling.
/// @param builder the program builder.
/// @param vector the vector to be appended. May be a scalar, `vec2` or `vec3`.
/// @param scalar the scalar to append to the vector. Must be a scalar.
/// @returns a vector expression containing the elements of `vector` followed by
/// the single element of `scalar` cast to the `vector` element type.
const sem::Call* AppendVector(ProgramBuilder* builder,
                              const ast::Expression* vector,
                              const ast::Expression* scalar);

}  // namespace tint::writer

#endif  // SRC_TINT_WRITER_APPEND_VECTOR_H_