GenOptions.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_GENOPTIONS_H
#define MATERIALX_GENOPTIONS_H
 
 
#include <MaterialXGenShader/Export.h>
 
#include <MaterialXFormat/File.h>
 
MATERIALX_NAMESPACE_BEGIN
 
enum ShaderInterfaceType
{
    SHADER_INTERFACE_COMPLETE,
 
    SHADER_INTERFACE_REDUCED
};
 
enum HwSpecularEnvironmentMethod
{
    SPECULAR_ENVIRONMENT_NONE,
 
    SPECULAR_ENVIRONMENT_FIS,
 
    SPECULAR_ENVIRONMENT_PREFILTER
};
 
enum HwDirectionalAlbedoMethod
{
    DIRECTIONAL_ALBEDO_ANALYTIC,
 
    DIRECTIONAL_ALBEDO_TABLE,
 
    DIRECTIONAL_ALBEDO_MONTE_CARLO
};
 
enum HwTransmissionRenderMethod
{
    TRANSMISSION_REFRACTION,
 
    TRANSMISSION_OPACITY,
};
 
class MX_GENSHADER_API GenOptions
{
  public:
    GenOptions() :
        shaderInterfaceType(SHADER_INTERFACE_COMPLETE),
        fileTextureVerticalFlip(false),
        addUpstreamDependencies(true),
        libraryPrefix("libraries"),
        emitColorTransforms(true),
        hwTransparency(false),
        hwSpecularEnvironmentMethod(SPECULAR_ENVIRONMENT_FIS),
        hwDirectionalAlbedoMethod(DIRECTIONAL_ALBEDO_ANALYTIC),
        hwTransmissionRenderMethod(TRANSMISSION_REFRACTION),
        hwSrgbEncodeOutput(false),
        hwWriteDepthMoments(false),
        hwShadowMap(false),
        hwAmbientOcclusion(false),
        hwMaxActiveLightSources(3),
        hwNormalizeUdimTexCoords(false),
        hwWriteAlbedoTable(false),
        hwWriteEnvPrefilter(false),
        hwImplicitBitangents(true)
    {
    }
    virtual ~GenOptions() { }
 
    // TODO: Add options for:
    //  - shader gen optimization level
    //  - graph flattening or not
 
    ShaderInterfaceType shaderInterfaceType;
 
    bool fileTextureVerticalFlip;
 
    string targetColorSpaceOverride;
 
    string targetDistanceUnit;
 
    bool addUpstreamDependencies;
 
    FilePath libraryPrefix;
 
    bool emitColorTransforms;
 
    bool hwTransparency;
 
    HwSpecularEnvironmentMethod hwSpecularEnvironmentMethod;
 
    HwDirectionalAlbedoMethod hwDirectionalAlbedoMethod;
 
    HwTransmissionRenderMethod hwTransmissionRenderMethod;
 
    bool hwSrgbEncodeOutput;
 
    bool hwWriteDepthMoments;
 
    bool hwShadowMap;
 
    bool hwAmbientOcclusion;
 
    unsigned int hwMaxActiveLightSources;
 
    bool hwNormalizeUdimTexCoords;
 
    bool hwWriteAlbedoTable;
 
    bool hwWriteEnvPrefilter;
 
    bool hwImplicitBitangents;
};
 
MATERIALX_NAMESPACE_END
 
#endif