//
// Copyright 2020 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HGI_METAL_COMPUTE_PIPELINE_H
#define PXR_IMAGING_HGI_METAL_COMPUTE_PIPELINE_H

#include "pxr/pxr.h"
#include "pxr/imaging/hgi/computePipeline.h"

#include "pxr/imaging/hgiMetal/api.h"


PXR_NAMESPACE_OPEN_SCOPE

class HgiMetal;

/// \class HgiMetalComputePipeline
///
/// Metal implementation of HgiComputePipeline.
///
class HgiMetalComputePipeline final : public HgiComputePipeline
{
public:
    HGIMETAL_API
    HgiMetalComputePipeline(HgiMetal *hgi, HgiComputePipelineDesc const& desc);

    HGIMETAL_API
    ~HgiMetalComputePipeline() override;

    /// Apply pipeline state
    HGIMETAL_API
    void BindPipeline(id<MTLComputeCommandEncoder> computeEncoder);
    
    HGIMETAL_API
    id<MTLComputePipelineState> GetMetalPipelineState();

private:
    HgiMetalComputePipeline() = delete;
    HgiMetalComputePipeline & operator=(const HgiMetalComputePipeline&) = delete;
    HgiMetalComputePipeline(const HgiMetalComputePipeline&) = delete;
    
    id<MTLComputePipelineState> _computePipelineState;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif