blob: bce61ef8268a6b123d3f636a2ab4cc1b12c51f02 [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.
#ifndef SRC_TINT_TYPE_MATRIX_H_
#define SRC_TINT_TYPE_MATRIX_H_
#include <string>
#include "src/tint/type/vector.h"
// Forward declarations
namespace tint::type {
class Vector;
} // namespace tint::type
namespace tint::type {
/// A matrix type
class Matrix final : public utils::Castable<Matrix, Type> {
public:
/// Constructor
/// @param column_type the type of a column of the matrix
/// @param columns the number of columns in the matrix
Matrix(const Vector* column_type, uint32_t columns);
/// Destructor
~Matrix() override;
/// @param other the other node to compare against
/// @returns true if the this type is equal to @p other
bool Equals(const UniqueNode& other) const override;
/// @returns the type of the matrix
const Type* type() const { return subtype_; }
/// @returns the number of rows in the matrix
uint32_t rows() const { return rows_; }
/// @returns the number of columns in the matrix
uint32_t columns() const { return columns_; }
/// @returns the column-vector type of the matrix
const Vector* ColumnType() const { return column_type_; }
/// @returns the name for this type that closely resembles how it would be
/// declared in WGSL.
std::string FriendlyName() const override;
/// @returns the size in bytes of the type. This may include tail padding.
uint32_t Size() const override;
/// @returns the alignment in bytes of the type. This may include tail
/// padding.
uint32_t Align() const override;
/// @returns the number of bytes between columns of the matrix
uint32_t ColumnStride() const;
/// @copydoc Type::Elements
TypeAndCount Elements(const Type* type_if_invalid = nullptr,
uint32_t count_if_invalid = 0) const override;
/// @copydoc Type::Element
const Vector* Element(uint32_t index) const override;
/// @param ctx the clone context
/// @returns a clone of this type
Matrix* Clone(CloneContext& ctx) const override;
private:
const Type* const subtype_;
const Vector* const column_type_;
const uint32_t rows_;
const uint32_t columns_;
};
} // namespace tint::type
#endif // SRC_TINT_TYPE_MATRIX_H_