// Copyright 2018 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_VULKAN_BINDGROUPVK_H_
#define DAWNNATIVE_VULKAN_BINDGROUPVK_H_

#include "dawn_native/BindGroup.h"

#include "common/PlacementAllocated.h"
#include "common/vulkan_platform.h"
#include "dawn_native/vulkan/BindGroupLayoutVk.h"
#include "dawn_native/vulkan/DescriptorSetAllocation.h"

namespace dawn_native { namespace vulkan {

    class Device;

    // The Vulkan BindGroup is dependent on UseTintGenerator or not.
    // When UseTintGenerator is on, VkWriteDescriptorSet::dstBinding is set to BindingIndex,
    // otherwise it is set to BindingNumber.
    class BindGroup final : public BindGroupBase, public PlacementAllocated {
      public:
        static ResultOrError<Ref<BindGroup>> Create(Device* device,
                                                    const BindGroupDescriptor* descriptor);

        BindGroup(Device* device,
                  const BindGroupDescriptor* descriptor,
                  DescriptorSetAllocation descriptorSetAllocation);

        VkDescriptorSet GetHandle() const;

      private:
        ~BindGroup() override;

        // The descriptor set in this allocation outlives the BindGroup because it is owned by
        // the BindGroupLayout which is referenced by the BindGroup.
        DescriptorSetAllocation mDescriptorSetAllocation;
    };

}}  // namespace dawn_native::vulkan

#endif  // DAWNNATIVE_VULKAN_BINDGROUPVK_H_