src/tint/type/storage_texture.h

// 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_STORAGE_TEXTURE_H_
#define SRC_TINT_TYPE_STORAGE_TEXTURE_H_

#include <string>

#include "src/tint/type/access.h"
#include "src/tint/type/texel_format.h"
#include "src/tint/type/texture.h"
#include "src/tint/type/texture_dimension.h"

// Forward declarations
namespace tint::type {
class Manager;
}  // namespace tint::type

namespace tint::type {

/// A storage texture type.
class StorageTexture final : public Castable<StorageTexture, Texture> {
  public:
    /// Constructor
    /// @param dim the dimensionality of the texture
    /// @param format the texel format of the texture
    /// @param access the access control type of the texture
    /// @param subtype the storage subtype. Use SubtypeFor() to calculate this.
    StorageTexture(TextureDimension dim,
                   type::TexelFormat format,
                   type::Access access,
                   Type* subtype);

    /// Destructor
    ~StorageTexture() 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 storage subtype
    Type* type() const { return subtype_; }

    /// @returns the texel format
    type::TexelFormat texel_format() const { return texel_format_; }

    /// @returns the access control
    type::Access access() const { return access_; }

    /// @param symbols the program's symbol table
    /// @returns the name for this type that closely resembles how it would be
    /// declared in WGSL.
    std::string FriendlyName(const SymbolTable& symbols) const override;

    /// @param format the storage texture image format
    /// @param type_mgr the Manager used to build the returned type
    /// @returns the storage texture subtype for the given TexelFormat
    static Type* SubtypeFor(type::TexelFormat format, Manager& type_mgr);

    /// @param ctx the clone context
    /// @returns a clone of this type
    StorageTexture* Clone(CloneContext& ctx) const override;

  private:
    type::TexelFormat const texel_format_;
    type::Access const access_;
    Type* const subtype_;
};

}  // namespace tint::type

#endif  // SRC_TINT_TYPE_STORAGE_TEXTURE_H_