rendererPlugin.h

//
// Copyright 2017 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_RENDERER_PLUGIN_H
#define PXR_IMAGING_HD_RENDERER_PLUGIN_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hf/pluginBase.h"
#include "pxr/imaging/hd/renderDelegate.h"

PXR_NAMESPACE_OPEN_SCOPE

class HdRenderer;
class HdPluginRenderDelegateUniqueHandle;
class HdPluginRendererUniqueHandle;
class HdRendererCreateArgsSchema;
TF_DECLARE_REF_PTRS(HdSceneIndexBase);

class HdRendererPlugin : public HfPluginBase
{
public:


    HD_API
    virtual
    bool IsSupported(
        const HdRendererCreateArgsSchema &rendererCreateArgs,
        std::string *reasonWhyNot = nullptr) const = 0;

    HD_API
    virtual
    HdContainerDataSourceHandle GetSceneIndexCreateArgs() const;

    HD_API
    HdPluginRendererUniqueHandle CreateRenderer(
        HdSceneIndexBaseRefPtr const &sceneIndex,
        const HdRendererCreateArgsSchema &rendererCreateArgs);


    HD_API
    TfToken GetPluginId() const;

    HD_API
    std::string GetDisplayName() const;


    HD_API
    HdPluginRenderDelegateUniqueHandle CreateDelegate(
        HdRenderSettingsMap const &settingsMap = {});
    virtual HdRenderDelegate *CreateRenderDelegate() = 0;

    HD_API
    virtual HdRenderDelegate *CreateRenderDelegate(
        HdRenderSettingsMap const& settingsMap);

    virtual void DeleteRenderDelegate(HdRenderDelegate *renderDelegate) = 0;


protected:
    HdRendererPlugin() = default;
    HD_API
    ~HdRendererPlugin() override;

    HD_API
    virtual std::unique_ptr<HdRenderer> _CreateRenderer(
        HdSceneIndexBaseRefPtr const &sceneIndex,
        const HdRendererCreateArgsSchema &rendererCreateArgs);

    // Instantiates render delegate and uses "back-end" emulation.
    HD_API
    std::unique_ptr<HdRenderer> _CreateRendererFromRenderDelegate(
        HdSceneIndexBaseRefPtr const &sceneIndex,
        const HdRendererCreateArgsSchema &rendererCreateArgs);

private:
    // This class doesn't require copy support.
    HdRendererPlugin(const HdRendererPlugin &)             = delete;
    HdRendererPlugin &operator =(const HdRendererPlugin &) = delete;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_IMAGING_HD_RENDERER_PLUGIN_H