blob: 6cefb10587a93d2ed5578d9313eca37d64eb14d0 [file] [log] [blame]
// Copyright 2023 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef SRC_TINT_LANG_CORE_IR_FUNCTION_PARAM_H_
#define SRC_TINT_LANG_CORE_IR_FUNCTION_PARAM_H_
#include <utility>
#include "src/tint/api/common/binding_point.h"
#include "src/tint/lang/core/builtin_value.h"
#include "src/tint/lang/core/ir/location.h"
#include "src/tint/lang/core/ir/value.h"
#include "src/tint/utils/containers/vector.h"
#include "src/tint/utils/ice/ice.h"
#include "src/tint/utils/rtti/castable.h"
namespace tint::core::ir {
/// A function parameter in the IR.
class FunctionParam : public Castable<FunctionParam, Value> {
public:
/// Constructor
/// @param type the type of the var
explicit FunctionParam(const core::type::Type* type);
~FunctionParam() override;
/// @returns the type of the var
const core::type::Type* Type() const override { return type_; }
/// @copydoc Value::Clone()
FunctionParam* Clone(CloneContext& ctx) override;
/// Sets the builtin information. Note, it is currently an error if the builtin is already set.
/// @param val the builtin to set
void SetBuiltin(core::BuiltinValue val) {
TINT_ASSERT(!builtin_.has_value());
builtin_ = val;
}
/// @returns the builtin set for the parameter
std::optional<core::BuiltinValue> Builtin() const { return builtin_; }
/// Clears the builtin attribute.
void ClearBuiltin() { builtin_ = {}; }
/// Sets the parameter as invariant
/// @param val the value to set for invariant
void SetInvariant(bool val) { invariant_ = val; }
/// @returns true if parameter is invariant
bool Invariant() const { return invariant_; }
/// Sets the location
/// @param location the location
void SetLocation(ir::Location location) { location_ = std::move(location); }
/// Sets the location
/// @param loc the location value
/// @param interpolation if the location interpolation settings
void SetLocation(uint32_t loc, std::optional<core::Interpolation> interpolation) {
location_ = {loc, interpolation};
}
/// @returns the location if `Attributes` contains `kLocation`
std::optional<ir::Location> Location() const { return location_; }
/// Clears the location attribute.
void ClearLocation() { location_ = {}; }
/// Sets the binding point
/// @param group the group
/// @param binding the binding
void SetBindingPoint(uint32_t group, uint32_t binding) { binding_point_ = {group, binding}; }
/// @returns the binding points if `Attributes` contains `kBindingPoint`
std::optional<struct BindingPoint> BindingPoint() const { return binding_point_; }
private:
const core::type::Type* type_ = nullptr;
std::optional<core::BuiltinValue> builtin_;
std::optional<struct Location> location_;
std::optional<struct BindingPoint> binding_point_;
bool invariant_ = false;
};
} // namespace tint::core::ir
#endif // SRC_TINT_LANG_CORE_IR_FUNCTION_PARAM_H_