//
// 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_BLIT_CMDS_H
#define PXR_IMAGING_HGI_METAL_BLIT_CMDS_H

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

PXR_NAMESPACE_OPEN_SCOPE

class HgiMetal;


/// \class HgiMetalBlitCmds
///
/// Metal implementation of HgiBlitCmds.
///
class HgiMetalBlitCmds final : public HgiBlitCmds
{
public:
    HGIMETAL_API
    ~HgiMetalBlitCmds() override;

    HGIMETAL_API
    void PushDebugGroup(const char* label) override;

    HGIMETAL_API
    void PopDebugGroup() override;

    HGIMETAL_API
    void CopyTextureGpuToCpu(HgiTextureGpuToCpuOp const& copyOp) override;
    
    HGIMETAL_API
    void CopyBufferGpuToGpu(HgiBufferGpuToGpuOp const& copyOp) override;

    HGIMETAL_API
    void CopyBufferCpuToGpu(HgiBufferCpuToGpuOp const& copyOp) override;

    HGIMETAL_API
    void GenerateMipMaps(HgiTextureHandle const& texture) override;

protected:
    friend class HgiMetal;

    HGIMETAL_API
    HgiMetalBlitCmds(HgiMetal* hgi);

    HGIMETAL_API
    bool _Submit(Hgi* hgi) override;

private:
    HgiMetalBlitCmds() = delete;
    HgiMetalBlitCmds & operator=(const HgiMetalBlitCmds&) = delete;
    HgiMetalBlitCmds(const HgiMetalBlitCmds&) = delete;

    void _CreateEncoder();

    HgiMetal* _hgi;
    id<MTLBlitCommandEncoder> _blitEncoder;
    NSString* _label;

    // BlitCmds is used only one frame so storing multi-frame state on BlitCmds
    // will not survive.
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif