rendererPluginRegistry.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_REGISTRY_H
#define PXR_IMAGING_HD_RENDERER_PLUGIN_REGISTRY_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/renderDelegate.h"
#include "pxr/base/tf/singleton.h"
#include "pxr/imaging/hf/pluginRegistry.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdRendererCreateArgsSchema;
class HdRendererPlugin;
class HdRendererPluginHandle;
class HdPluginRenderDelegateUniqueHandle;
 
class HdRendererPluginRegistry final  : public HfPluginRegistry
{
public:
    HD_API
    static HdRendererPluginRegistry &GetInstance();
 
    template<typename T, typename... Bases>
    static void Define();
 
    HD_API
    TfToken GetDefaultPluginId(
        const HdRendererCreateArgsSchema &rendererCreateArgs);
 
    HD_API
    HdRendererPluginHandle GetOrCreateRendererPlugin(const TfToken &pluginId);
 
 
    HD_API
    TfToken GetDefaultPluginId(bool gpuEnabled = true);
 
    HD_API
    TfToken GetDefaultPluginId(
        HdRendererCreateArgs const &rendererCreateArgs);
 
    HD_API
    HdRendererPlugin *GetRendererPlugin(const TfToken &pluginId);
 
    HD_API
    HdPluginRenderDelegateUniqueHandle CreateRenderDelegate(
        const TfToken &pluginId,
        const HdRenderSettingsMap &settingsMap = {});
 
 
private:
    // Friend required by TfSingleton to access constructor (as it is private).
    friend class TfSingleton<HdRendererPluginRegistry>;
 
    void _CollectAdditionalMetadata(
        const PlugRegistry &plugRegistry, const TfType &pluginType) override;
 
    // Singleton gets private constructed
    HdRendererPluginRegistry();
    ~HdRendererPluginRegistry() override;
 
    //
    HdRendererPluginRegistry(const HdRendererPluginRegistry &)            = delete;
    HdRendererPluginRegistry &operator=(const HdRendererPluginRegistry &) = delete;
};
 
 
template<typename T, typename... Bases>
void HdRendererPluginRegistry::Define()
{
    HfPluginRegistry::Define<T, HdRendererPlugin, Bases...>();
}
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_RENDERER_PLUGIN_REGISTRY_H