legacyRenderControlInterface.h

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_LEGACY_RENDER_CONTROL_INTERFACE_H
#define PXR_IMAGING_HD_LEGACY_RENDER_CONTROL_INTERFACE_H
 
#include "pxr/pxr.h"
 
#include "pxr/imaging/hd/api.h"
 
#include "pxr/imaging/hd/aov.h"
#include "pxr/imaging/hd/command.h"
#include "pxr/usd/sdf/path.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
struct HdRenderDelegateInfo;
class HdRenderBuffer;
using HdRenderSettingDescriptorList =
    std::vector<struct HdRenderSettingDescriptor>;
using HdCommandDescriptors =
    std::vector<struct HdCommandDescriptor>;
 
class HdLegacyRenderControlInterface
{
public:
 
    virtual void Execute(
        const SdfPathVector &taskPaths) = 0;
 
    virtual bool AreTasksConverged(
        const SdfPathVector &taskPaths) const = 0;
 
    virtual bool GetTaskContextData(
        const TfToken &name, VtValue *data) const = 0;
 
    virtual void SetTaskContextData(
        const TfToken &name, const VtValue &data) = 0;
 
 
 
    virtual HdAovDescriptor GetDefaultAovDescriptor(
        const TfToken &name) const = 0;
 
    virtual HdRenderBuffer * GetRenderBuffer(
        const SdfPath &path) const = 0;
 
 
    
    virtual HdRenderSettingDescriptorList
        GetRenderSettingDescriptors() const = 0;
    virtual VtValue GetRenderSetting(
        const TfToken &name) const = 0;
    virtual void SetRenderSetting(
        const TfToken &name, VtValue const &value) = 0;
 
 
 
    virtual HdCommandDescriptors GetCommandDescriptors() = 0;
 
    virtual bool InvokeCommand(
        TfToken const &name, const HdCommandArgs &args = {}) = 0;
 
    
    
    virtual bool IsPauseSupported() const = 0;
    virtual bool Pause() = 0;
    virtual bool Resume() = 0;
    virtual bool IsStopSupported() const = 0;
    virtual bool Stop(bool blocking = true) = 0;
    virtual bool Restart() = 0;
 
 
    
    virtual TfToken GetMaterialBindingPurpose() const = 0;
    virtual TfTokenVector GetMaterialRenderContexts() const = 0;
    virtual TfTokenVector GetRenderSettingsNamespaces() const = 0;
    virtual bool IsPrimvarFilteringNeeded() const = 0;
    virtual TfTokenVector GetShaderSourceTypes() const = 0;
    virtual bool IsCoordSysSupported() const = 0;
 
    HD_API
    HdRenderDelegateInfo GetRenderDelegateInfo() const;
    
 
    virtual bool RequiresStormTasks() const = 0;
 
    virtual VtDictionary GetRenderStats() = 0;
 
    virtual SdfPath GetRprimPathFromPrimId(int primIdx) = 0;
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif