src/dawn_native/ComputePipeline.h

// 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 DAWNNATIVE_COMPUTEPIPELINE_H_
#define DAWNNATIVE_COMPUTEPIPELINE_H_

#include "common/NonCopyable.h"
#include "dawn_native/Pipeline.h"

namespace dawn_native {

    class DeviceBase;
    struct EntryPointMetadata;

    // We use FlatComputePipelineDescriptor to keep all the members of ComputePipelineDescriptor
    // (especially the members in pointers) valid in CreateComputePipelineAsyncTask when the
    // creation of the compute pipeline is executed asynchronously.
    struct FlatComputePipelineDescriptor : public ComputePipelineDescriptor, public NonMovable {
      public:
        explicit FlatComputePipelineDescriptor(const ComputePipelineDescriptor* descriptor);

        void SetLayout(Ref<PipelineLayoutBase> appliedLayout);

      private:
        std::string mLabel;
        Ref<PipelineLayoutBase> mLayout;
        std::string mEntryPoint;
        Ref<ShaderModuleBase> mComputeModule;
    };

    MaybeError ValidateComputePipelineDescriptor(DeviceBase* device,
                                                 const ComputePipelineDescriptor* descriptor);

    class ComputePipelineBase : public PipelineBase {
      public:
        ComputePipelineBase(DeviceBase* device, const ComputePipelineDescriptor* descriptor);
        ~ComputePipelineBase() override;

        static ComputePipelineBase* MakeError(DeviceBase* device);

        // Functors necessary for the unordered_set<ComputePipelineBase*>-based cache.
        struct EqualityFunc {
            bool operator()(const ComputePipelineBase* a, const ComputePipelineBase* b) const;
        };

      private:
        ComputePipelineBase(DeviceBase* device, ObjectBase::ErrorTag tag);

        // CreateComputePipelineAsyncTask is declared as a friend of ComputePipelineBase as it
        // needs to call the private member function ComputePipelineBase::Initialize().
        friend class CreateComputePipelineAsyncTask;
        virtual MaybeError Initialize(const ComputePipelineDescriptor* descriptor);
    };

}  // namespace dawn_native

#endif  // DAWNNATIVE_COMPUTEPIPELINE_H_