2020-03-02 20:47:43 +00:00
|
|
|
// 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_AST_STRUCT_MEMBER_OFFSET_DECORATION_H_
|
|
|
|
#define SRC_AST_STRUCT_MEMBER_OFFSET_DECORATION_H_
|
|
|
|
|
2021-06-09 18:53:57 +00:00
|
|
|
#include <string>
|
|
|
|
|
2021-03-11 17:39:32 +00:00
|
|
|
#include "src/ast/decoration.h"
|
2020-03-02 20:47:43 +00:00
|
|
|
|
|
|
|
namespace tint {
|
|
|
|
namespace ast {
|
|
|
|
|
|
|
|
/// A struct member offset decoration
|
2021-03-15 20:34:22 +00:00
|
|
|
/// @note The WGSL spec removed the `[[offset(n)]]` decoration for `[[size(n)]]`
|
|
|
|
/// and `[[align(n)]]` in https://github.com/gpuweb/gpuweb/pull/1447. However
|
|
|
|
/// this decoration is kept because the SPIR-V reader has to deal with absolute
|
|
|
|
/// offsets, and transforming these to size / align is complex and can be done
|
|
|
|
/// in a number of ways. The Resolver is responsible for consuming the size and
|
|
|
|
/// align decorations and transforming these into absolute offsets. It is
|
|
|
|
/// trivial for the Resolver to handle `[[offset(n)]]` or `[[size(n)]]` /
|
|
|
|
/// `[[align(n)]]` decorations, so this is what we do, keeping all the layout
|
|
|
|
/// logic in one place.
|
2020-11-30 23:30:58 +00:00
|
|
|
class StructMemberOffsetDecoration
|
2021-03-11 17:39:32 +00:00
|
|
|
: public Castable<StructMemberOffsetDecoration, Decoration> {
|
2020-03-02 20:47:43 +00:00
|
|
|
public:
|
|
|
|
/// constructor
|
2021-04-13 23:27:27 +00:00
|
|
|
/// @param program_id the identifier of the program that owns this node
|
2020-11-03 21:48:20 +00:00
|
|
|
/// @param source the source of this decoration
|
2020-12-14 21:10:07 +00:00
|
|
|
/// @param offset the offset value
|
2021-04-13 23:27:27 +00:00
|
|
|
StructMemberOffsetDecoration(ProgramID program_id,
|
|
|
|
const Source& source,
|
|
|
|
uint32_t offset);
|
2020-03-02 20:47:43 +00:00
|
|
|
~StructMemberOffsetDecoration() override;
|
|
|
|
|
|
|
|
/// @returns the offset value
|
2020-03-24 21:40:10 +00:00
|
|
|
uint32_t offset() const { return offset_; }
|
2020-03-02 20:47:43 +00:00
|
|
|
|
2021-06-09 18:53:57 +00:00
|
|
|
/// @returns the WGSL name for the decoration
|
|
|
|
std::string name() const override;
|
|
|
|
|
2020-12-01 18:04:17 +00:00
|
|
|
/// Clones this node and all transitive child nodes using the `CloneContext`
|
|
|
|
/// `ctx`.
|
|
|
|
/// @param ctx the clone context
|
|
|
|
/// @return the newly cloned node
|
|
|
|
StructMemberOffsetDecoration* Clone(CloneContext* ctx) const override;
|
|
|
|
|
2020-03-02 20:47:43 +00:00
|
|
|
private:
|
2020-12-15 14:52:38 +00:00
|
|
|
uint32_t const offset_;
|
2020-03-02 20:47:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace ast
|
|
|
|
} // namespace tint
|
|
|
|
|
|
|
|
#endif // SRC_AST_STRUCT_MEMBER_OFFSET_DECORATION_H_
|