src/tint/lang/core/io_attributes.h

// Copyright 2024 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_IO_ATTRIBUTES_H_
#define SRC_TINT_LANG_CORE_IO_ATTRIBUTES_H_

#include <cstdint>
#include <optional>

#include "src/tint/lang/core/builtin_value.h"
#include "src/tint/lang/core/interpolation.h"

namespace tint::core {

/// Attributes that can be applied to an object that will be used for shader IO.
struct IOAttributes {
    /// The value of a `@location` attribute.
    std::optional<uint32_t> location;
    /// The value of a `@blend_src` attribute.
    std::optional<uint32_t> blend_src;
    /// The value of a `@color` attribute.
    std::optional<uint32_t> color;
    /// The value of a `@builtin` attribute.
    std::optional<core::BuiltinValue> builtin;
    /// The values of a `@interpolate` attribute.
    std::optional<core::Interpolation> interpolation;
    /// True if the object is annotated with `@invariant`.
    bool invariant = false;
};

}  // namespace tint::core

#endif  // SRC_TINT_LANG_CORE_IO_ATTRIBUTES_H_