Harmonics.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_HARMONICS_H
#define MATERIALX_HARMONICS_H
 
 
#include <MaterialXRender/Export.h>
#include <MaterialXRender/Image.h>
#include <MaterialXRender/Types.h>
 
MATERIALX_NAMESPACE_BEGIN
 
template <class C, size_t B> class ShCoeffs
{
  public:
    static const size_t NUM_BANDS = B;
    static const size_t NUM_COEFFS = B * B;
 
  public:
    ShCoeffs() = default;
    explicit ShCoeffs(const std::array<C, NUM_COEFFS>& arr) :
        _arr(arr) { }
 
 
    bool operator==(const ShCoeffs& rhs) const { return _arr == rhs._arr; }
 
    bool operator!=(const ShCoeffs& rhs) const { return _arr != rhs._arr; }
 
 
    C& operator[](size_t i) { return _arr.at(i); }
 
    const C& operator[](size_t i) const { return _arr.at(i); }
 
 
  protected:
    std::array<C, NUM_COEFFS> _arr;
};
 
using Sh3ScalarCoeffs = ShCoeffs<double, 3>;
 
using Sh3ColorCoeffs = ShCoeffs<Color3d, 3>;
 
MX_RENDER_API Sh3ColorCoeffs projectEnvironment(ConstImagePtr env, bool irradiance = false);
 
MX_RENDER_API ImagePtr normalizeEnvironment(ConstImagePtr env, float envRadiance, float maxTexelRadiance);
 
MX_RENDER_API void computeDominantLight(ConstImagePtr env, Vector3& lightDir, Color3& lightColor);
 
MX_RENDER_API ImagePtr renderEnvironment(const Sh3ColorCoeffs& shEnv, unsigned int width, unsigned int height);
 
MX_RENDER_API ImagePtr renderReferenceIrradiance(ConstImagePtr env, unsigned int width, unsigned int height);
 
MATERIALX_NAMESPACE_END
 
#endif