axmol/core/renderer/backend/metal/RenderPipelineMTL.h

/****************************************************************************
 Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.

 https://axis-project.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/

#pragma once

#include "../RenderPipeline.h"
#include <string>
#include <vector>
#include <memory>
#include "tsl/robin_map.h"
#import <Metal/Metal.h>

NS_AX_BACKEND_BEGIN
/**
 * @addtogroup _metal
 * @{
 */

/**
 * Create and compile a new MTLRenderPipelineState object synchronously.
 */
class RenderPipelineMTL : public RenderPipeline
{
public:
    /**
     * @param mtlDevice The device for which MTLRenderPipelineState object was created.
     * @param descriptor Specify the render pipeline description.
     */
    RenderPipelineMTL(id<MTLDevice> mtlDevice);
    ~RenderPipelineMTL();
    virtual void update(const RenderTarget* renderTarget, const PipelineDescriptor&) override;

    /**
     * Get a MTLRenderPipelineState object.
     * @return A MTLRenderPipelineState object.
     */
    inline id<MTLRenderPipelineState> getMTLRenderPipelineState() const { return _mtlRenderPipelineState; }

private:
    void setVertexLayout(MTLRenderPipelineDescriptor*, const PipelineDescriptor&);
    void setBlendState(MTLRenderPipelineColorAttachmentDescriptor*, const BlendDescriptor&);
    void setShaderModules(const PipelineDescriptor&);
    void setBlendStateAndFormat(const BlendDescriptor&);
    void chooseAttachmentFormat(const RenderTarget* renderTarget,
                                PixelFormat colorAttachmentsFormat[MAX_COLOR_ATTCHMENT],
                                PixelFormat&,
                                PixelFormat&);

    id<MTLRenderPipelineState> _mtlRenderPipelineState = nil;
    id<MTLDevice> _mtlDevice                           = nil;

    MTLRenderPipelineDescriptor* _mtlRenderPipelineDescriptor = nil;
    PixelFormat _colorAttachmentsFormat[MAX_COLOR_ATTCHMENT]  = {PixelFormat::NONE};
    PixelFormat _depthAttachmentFormat                        = PixelFormat::NONE;
    PixelFormat _stencilAttachmentFormat                      = PixelFormat::NONE;

    tsl::robin_map<uint32_t, id<MTLRenderPipelineState>> _mtlStateCache;
};

// end of _metal group
/// @}
NS_AX_BACKEND_END