applicationRenderSettingsSceneIndex.h

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDSI_APPLICATION_RENDER_SETTINGS_SCENE_INDEX_H
#define PXR_IMAGING_HDSI_APPLICATION_RENDER_SETTINGS_SCENE_INDEX_H
 
#include "pxr/imaging/hdsi/api.h"
#include "pxr/imaging/hd/filteringSceneIndex.h"
#include "pxr/imaging/hd/schemaTypeDefs.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
namespace HdsiApplicationRenderSettingsSceneIndex_Impl
{
struct _RenderSettingsInfo;
using _RenderSettingsInfoSharedPtr = std::shared_ptr<_RenderSettingsInfo>;
}
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdsiApplicationRenderSettingsSceneIndex);
 
class HdsiApplicationRenderSettingsSceneIndex final
    : public HdSingleInputFilteringSceneIndexBase
{
public:
    HDSI_API
    static HdsiApplicationRenderSettingsSceneIndexRefPtr
    New(const HdSceneIndexBaseRefPtr &inputSceneIndex,
        const HdContainerDataSourceHandle &inputArgs);
 
    HDSI_API
    HdRenderSettingDescriptorContainerSchema
    GetRenderSettingDescriptorsFromRenderer() const;
 
    enum class RenderSettingsSource
    {
        Resolved,
        ApplicationOverride,
        InputRenderSettings,
        RendererDefault
    };
 
    HDSI_API
    VtValue GetRenderSetting(RenderSettingsSource src, const TfToken &name) const;
 
    HDSI_API
    void SetApplicationOverrideRenderSetting(const TfToken &name, const VtValue &value);
 
    HDSI_API
    static const SdfPath &GetApplicationRenderSettingsPrimPath();
    
    HDSI_API
    HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
 
    HDSI_API
    SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
 
protected:
    HDSI_API
    HdsiApplicationRenderSettingsSceneIndex(
        const HdSceneIndexBaseRefPtr &inputSceneIndex,
        const HdContainerDataSourceHandle &inputArgs);
 
    HDSI_API
    void _PrimsAdded(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::AddedPrimEntries &entries) override;
 
    HDSI_API
    void _PrimsRemoved(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
 
    HDSI_API
    void _PrimsDirtied(
        const HdSceneIndexBase &sender,
        const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
 
private:
    HdsiApplicationRenderSettingsSceneIndex(
        const HdSceneIndexBaseRefPtr &inputSceneIndex,
        const HdRenderSettingDescriptorContainerSchema &descriptors);
 
    HdContainerDataSourceHandle _GetInputRenderSettingsDataSource() const;
    HdContainerDataSourceHandle _GetApplicationRenderSettingsDataSource() const;
    
    HdsiApplicationRenderSettingsSceneIndex_Impl::_RenderSettingsInfoSharedPtr
        const _info;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HDSI_APPLICATION_RENDER_SETTINGS_SCENE_INDEX_H