blob: 9b005d6f1b51f5ca64de37052bd32646257bdb58 [file] [log] [blame]
// Copyright 2017 The Dawn 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_DAWN_NATIVE_PIPELINELAYOUT_H_
#define SRC_DAWN_NATIVE_PIPELINELAYOUT_H_
#include <array>
#include <bitset>
#include <string>
#include <vector>
#include "dawn/common/Constants.h"
#include "dawn/common/ContentLessObjectCacheable.h"
#include "dawn/common/ityp_array.h"
#include "dawn/common/ityp_bitset.h"
#include "dawn/native/BindingInfo.h"
#include "dawn/native/CachedObject.h"
#include "dawn/native/Error.h"
#include "dawn/native/Forward.h"
#include "dawn/native/ObjectBase.h"
#include "dawn/native/dawn_platform.h"
namespace dawn::native {
MaybeError ValidatePipelineLayoutDescriptor(
DeviceBase*,
const PipelineLayoutDescriptor* descriptor,
PipelineCompatibilityToken pipelineCompatibilityToken = PipelineCompatibilityToken(0));
using BindGroupLayoutArray = ityp::array<BindGroupIndex, Ref<BindGroupLayoutBase>, kMaxBindGroups>;
using BindGroupLayoutMask = ityp::bitset<BindGroupIndex, kMaxBindGroups>;
struct StageAndDescriptor {
SingleShaderStage shaderStage;
ShaderModuleBase* module;
std::string entryPoint;
size_t constantCount = 0u;
ConstantEntry const* constants = nullptr;
};
class PipelineLayoutBase : public ApiObjectBase,
public CachedObject,
public ContentLessObjectCacheable<PipelineLayoutBase> {
public:
PipelineLayoutBase(DeviceBase* device,
const PipelineLayoutDescriptor* descriptor,
ApiObjectBase::UntrackedByDeviceTag tag);
PipelineLayoutBase(DeviceBase* device, const PipelineLayoutDescriptor* descriptor);
~PipelineLayoutBase() override;
static PipelineLayoutBase* MakeError(DeviceBase* device, const char* label);
static ResultOrError<Ref<PipelineLayoutBase>> CreateDefault(
DeviceBase* device,
std::vector<StageAndDescriptor> stages);
ObjectType GetType() const override;
const BindGroupLayoutBase* GetFrontendBindGroupLayout(BindGroupIndex group) const;
BindGroupLayoutBase* GetFrontendBindGroupLayout(BindGroupIndex group);
const BindGroupLayoutInternalBase* GetBindGroupLayout(BindGroupIndex group) const;
BindGroupLayoutInternalBase* GetBindGroupLayout(BindGroupIndex group);
const BindGroupLayoutMask& GetBindGroupLayoutsMask() const;
bool HasPixelLocalStorage() const;
const std::vector<wgpu::TextureFormat>& GetStorageAttachmentSlots() const;
// Utility functions to compute inherited bind groups.
// Returns the inherited bind groups as a mask.
BindGroupLayoutMask InheritedGroupsMask(const PipelineLayoutBase* other) const;
// Returns the index of the first incompatible bind group in the range
// [0, kMaxBindGroups]
BindGroupIndex GroupsInheritUpTo(const PipelineLayoutBase* other) const;
// Functions necessary for the unordered_set<PipelineLayoutBase*>-based cache.
size_t ComputeContentHash() override;
struct EqualityFunc {
bool operator()(const PipelineLayoutBase* a, const PipelineLayoutBase* b) const;
};
protected:
PipelineLayoutBase(DeviceBase* device, ObjectBase::ErrorTag tag, const char* label);
void DestroyImpl() override;
BindGroupLayoutArray mBindGroupLayouts;
BindGroupLayoutMask mMask;
bool mHasPLS = false;
std::vector<wgpu::TextureFormat> mStorageAttachmentSlots;
};
} // namespace dawn::native
#endif // SRC_DAWN_NATIVE_PIPELINELAYOUT_H_