shaderCode.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_ST_SHADER_CODE_H
#define PXR_IMAGING_HD_ST_SHADER_CODE_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hdSt/resourceRegistry.h"
#include "pxr/imaging/hdSt/enums.h"
#include "pxr/imaging/hd/version.h"
 
#include "pxr/usd/sdf/path.h"
 
#include "pxr/base/tf/token.h"
 
#include <memory>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
using HdStBindingRequestVector = std::vector<class HdStBindingRequest>;
 
using HdStShaderCodeSharedPtr =
    std::shared_ptr<class HdStShaderCode>;
using HdStShaderCodeSharedPtrVector =
    std::vector<HdStShaderCodeSharedPtr>;
 
using HdSt_MaterialParamVector =
    std::vector<class HdSt_MaterialParam>;
using HdBufferSourceSharedPtr =
    std::shared_ptr<class HdBufferSource>;
using HdBufferSourceSharedPtrVector =
    std::vector<HdBufferSourceSharedPtr>;
using HdBufferArrayRangeSharedPtr =
    std::shared_ptr<class HdBufferArrayRange>;
using HdStTextureHandleSharedPtr =
    std::shared_ptr<class HdStTextureHandle>;
using HdStComputationSharedPtr =
    std::shared_ptr<class HdStComputation>;
 
class HioGlslfx;
class HdSt_ResourceBinder;
class HdStResourceRegistry;
 
class HdStShaderCode : public std::enable_shared_from_this<HdStShaderCode>
{
public:
    typedef size_t ID;
 
    HDST_API
    HdStShaderCode();
    HDST_API
    virtual ~HdStShaderCode();
 
    virtual ID ComputeHash() const = 0;
 
    HDST_API
    static ID ComputeHash(HdStShaderCodeSharedPtrVector const &shaders);
 
    HDST_API
    virtual ID ComputeTextureSourceHash() const;
 
    virtual std::string GetSource(TfToken const &shaderStageKey) const = 0;
 
    HDST_API
    VtDictionary GetLayout(TfTokenVector const &shaderStageKeys) const;
 
    // XXX: Should be pure-virtual
    HDST_API
    virtual HdSt_MaterialParamVector const& GetParams() const;
 
    HDST_API
    virtual bool IsEnabledPrimvarFiltering() const;
 
    HDST_API
    virtual TfTokenVector const& GetPrimvarNames() const;
 
 
 
    struct NamedTextureHandle {
        TfToken name;
        HdStTextureType type;
        HdStTextureHandleSharedPtr handle;
 
        size_t hash;
    };
    using NamedTextureHandleVector = std::vector<NamedTextureHandle>;
 
    HDST_API
    virtual NamedTextureHandleVector const & GetNamedTextureHandles() const;
 
 
    // XXX: Should be pure-virtual
    HDST_API
    virtual HdBufferArrayRangeSharedPtr const& GetShaderData() const;
 
    virtual void BindResources(int program,
                               HdSt_ResourceBinder const &binder) = 0;
 
    virtual void UnbindResources(int program,
                                 HdSt_ResourceBinder const &binder) = 0;
 
    virtual void AddBindings(HdStBindingRequestVector* customBindings) = 0;
 
    HDST_API
    virtual TfToken GetMaterialTag() const;
 
    class ResourceContext {
    public:
        HDST_API
        void AddSource(HdBufferArrayRangeSharedPtr const &range,
                       HdBufferSourceSharedPtr const &source);
 
        HDST_API
        void AddSources(HdBufferArrayRangeSharedPtr const &range,
                        HdBufferSourceSharedPtrVector &&sources);
 
        HDST_API
        void AddComputation(HdBufferArrayRangeSharedPtr const &range,
                            HdStComputationSharedPtr const &computation,
                            HdStComputeQueue const queue);
        
        HdStResourceRegistry * GetResourceRegistry() const {
            return _registry;
        }
 
    private:
        friend class HdStResourceRegistry;
        ResourceContext(HdStResourceRegistry *);
        HdStResourceRegistry *_registry;
    };
 
    HDST_API
    virtual void AddResourcesFromTextures(ResourceContext &ctx) const;
 
private:
 
    // No copying
    HdStShaderCode(const HdStShaderCode &)                      = delete;
    HdStShaderCode &operator =(const HdStShaderCode &)          = delete;
 
    // Returns the HioGlslfx instance used to configure this shader.
    // This can return nullptr for shaders without a GLSLFX instance.
    virtual HioGlslfx const * _GetGlslfx() const;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif //HDST_SHADER_H