simpleLightingShader.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDST_SIMPLE_LIGHTING_SHADER_H
#define PXR_IMAGING_HDST_SIMPLE_LIGHTING_SHADER_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hdSt/binding.h"
#include "pxr/imaging/hdSt/lightingShader.h"
 
#include "pxr/imaging/hd/version.h"
 
#include "pxr/imaging/glf/simpleLightingContext.h"
 
#include <memory>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdRenderIndex;
class HdRenderParam;
class HdSceneDelegate;
class HdStRenderBuffer;
struct HdRenderPassAovBinding;
using HdStSimpleLightingShaderSharedPtr =
    std::shared_ptr<class HdStSimpleLightingShader>;
using HdRenderPassAovBindingVector = std::vector<HdRenderPassAovBinding>;
 
class HdStSimpleLightingShader : public HdStLightingShader 
{
public:
    HDST_API
    HdStSimpleLightingShader(const Hgi* hgi);
    HDST_API
    ~HdStSimpleLightingShader() override;
 
    HDST_API
    ID ComputeHash() const override;
    HDST_API
    std::string GetSource(TfToken const &shaderStageKey) const override;
    HDST_API
    void BindResources(int program,
                       HdSt_ResourceBinder const &binder) override;
    HDST_API
    void UnbindResources(int program,
                         HdSt_ResourceBinder const &binder) override;
 
    HDST_API
    void AddBufferBinding(HdStBindingRequest const& req);
 
    HDST_API
    void RemoveBufferBinding(TfToken const &name);
 
    HDST_API
    void ClearBufferBindings();
 
    HDST_API
    void AddBindings(HdStBindingRequestVector *customBindings) override;
 
    HDST_API
    void AddResourcesFromTextures(ResourceContext &ctx) const override;
 
    HDST_API
    HdSt_MaterialParamVector const& GetParams() const override;
 
    HDST_API
    void SetCamera(
        GfMatrix4d const &worldToViewMatrix,
        GfMatrix4d const &projectionMatrix) override;
    
    GlfSimpleLightingContextRefPtr GetLightingContext() const {
        return _lightingContext;
    };
 
    HDST_API
    void AllocateTextureHandles(
        HdRenderIndex const &renderIndex,
        const SdfPath& graphPath);
 
    const HdStTextureHandleSharedPtr &
    GetDomeLightEnvironmentTextureHandle() const {
        return _domeLightEnvironmentTextureHandle;
    }
 
    HDST_API
    NamedTextureHandleVector const &GetNamedTextureHandles() const override;
 
    HDST_API
    const HdStTextureHandleSharedPtr &GetTextureHandle(
        const TfToken &name) const;
 
    HDST_API
    const HdStTextureHandleSharedPtr &
    GetDomeLightEnvironmentCubemapTextureHandle() const;
 
    HdRenderPassAovBindingVector const& GetShadowAovBindings() {
        return _shadowAovBindings;
    }
 
    HDST_API
    void SetDomeLightCubemapTargetMemory(unsigned int targetMemoryMB);
 
    HDST_API
    void SetMaxLights(uint32_t maxLights);
 
    // Limit set based to half the max samplers allowed by selected Hgi backend.
    HDST_API
    uint32_t GetMaxShadows() const {
        return _maxShadows;
    }
 
private:
    void _AllocateShadowTextures(
        HdStResourceRegistry* const resourceRegistry,
        const SdfPath& graphPath);
    void _CleanupAovBindings();
 
    GlfSimpleLightingContextRefPtr _lightingContext; 
    std::unique_ptr<class HioGlslfx> _glslfx;
 
    // Lexicographic ordering for stable output between runs.
    std::map<TfToken, HdStBindingRequest> _customBuffers;
 
    // The environment map used as source for the dome light textures.
    //
    // Handle is allocated in AllocateTextureHandles. Actual loading
    // happens during commit.
    HdStTextureHandleSharedPtr _domeLightEnvironmentTextureHandle;
 
    // Other dome light textures.
    NamedTextureHandleVector _namedTextureHandles;
 
    NamedTextureHandleVector _domeLightTextureHandles;
 
    // Maximum target memory of computed dome light cubemap texture (in MB)
    unsigned int _domeLightCubemapTargetMemoryMB;
    
    NamedTextureHandle _shadowTextureHandle;
    
    HdSt_MaterialParamVector _lightTextureParams;
 
    HdRenderParam *_renderParam;
 
    HdRenderPassAovBindingVector _shadowAovBindings;
 
    std::vector<HdStPooledRenderBufferUniquePtr> _shadowBuffers;
 
    HdStPooledRenderBufferUniquePtr _shadowBufferFallback;
 
    uint32_t _maxLights;
    uint32_t _maxShadows;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HDST_SIMPLE_LIGHTING_SHADER_H