OslRenderer.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_OSLRENDERER_H
#define MATERIALX_OSLRENDERER_H

 
#include <MaterialXRenderOsl/Export.h>
 
#include <MaterialXRender/ImageHandler.h>
#include <MaterialXRender/ShaderRenderer.h>
 
MATERIALX_NAMESPACE_BEGIN
 
// Shared pointer to an OslRenderer
using OslRendererPtr = std::shared_ptr<class OslRenderer>;

class MX_RENDEROSL_API OslRenderer : public ShaderRenderer
{
  public:
    static OslRendererPtr create(unsigned int width = 512, unsigned int height = 512, Image::BaseType baseType = Image::BaseType::UINT8);

    virtual ~OslRenderer();

    static string OSL_CLOSURE_COLOR_STRING;


    void initialize(RenderContextHandle renderContextHandle = nullptr) override;


    void createProgram(ShaderPtr shader) override;

    void createProgram(const StageMap& stages) override;

    void validateInputs() override;

    void setSize(unsigned int width, unsigned int height) override;

    void render() override;


    ImagePtr captureImage(ImagePtr image = nullptr) override;


    void setOslCompilerExecutable(const FilePath& executableFilePath)
    {
        _oslCompilerExecutable = executableFilePath;
    }

    void setOslIncludePath(const FileSearchPath& dirPath)
    {
        _oslIncludePath = dirPath;
    }

    void setOslOutputFilePath(const FilePath& dirPath)
    {
        _oslOutputFilePath = dirPath;
    }

    void setShaderParameterOverrides(const StringVec& parameterOverrides)
    {
        _oslShaderParameterOverrides = parameterOverrides;
    }

    void setEnvShaderParameterOverrides(const StringVec& parameterOverrides)
    {
        _envOslShaderParameterOverrides = parameterOverrides;
    }

    void setOslShaderOutput(const string& outputName, const string& outputType)
    {
        _oslShaderOutputName = outputName;
        _oslShaderOutputType = outputType;
    }

    void setOslTestShadeExecutable(const FilePath& executableFilePath)
    {
        _oslTestShadeExecutable = executableFilePath;
    }

    void setOslTestRenderExecutable(const FilePath& executableFilePath)
    {
        _oslTestRenderExecutable = executableFilePath;
    }

    void setOslTestRenderSceneTemplateFile(const FilePath& templateFilePath)
    {
        _oslTestRenderSceneTemplateFile = templateFilePath;
    }

    void setOslShaderName(const string& shaderName)
    {
        _oslShaderName = shaderName;
    }

    void setOslUtilityOSOPath(const FilePath& dirPath)
    {
        _oslUtilityOSOPath = dirPath;
    }

    void useTestRender(bool useTestRender)
    {
        _useTestRender = useTestRender;
    }

    void setRaysPerPixelLit(int rays)
    {
        _raysPerPixelLit = rays;
    }

    void setRaysPerPixelUnlit(int rays)
    {
        _raysPerPixelUnlit = rays;
    }

    void compileOSL(const FilePath& oslFilePath);

 
  protected:
    void shadeOSL(const FilePath& dirPath, const string& shaderName, const string& outputName);

    void renderOSL(const FilePath& dirPath, const string& shaderName, const string& outputName);

    OslRenderer(unsigned int width, unsigned int height, Image::BaseType baseType);
 
  private:
    FilePath _oslCompilerExecutable;
    FileSearchPath _oslIncludePath;
    FilePath _oslOutputFilePath;
    FilePath _oslOutputFileName;
 
    FilePath _oslTestShadeExecutable;
    FilePath _oslTestRenderExecutable;
    FilePath _oslTestRenderSceneTemplateFile;
    string _oslShaderName;
    StringVec _oslShaderParameterOverrides;
    StringVec _envOslShaderParameterOverrides;
    string _oslShaderOutputName;
    string _oslShaderOutputType;
    FilePath _oslUtilityOSOPath;
    bool _useTestRender;
    int _raysPerPixelLit;
    int _raysPerPixelUnlit;
};
 
MATERIALX_NAMESPACE_END
 
#endif