1. Epic GamesDeveloper
  3. UMaterialExpressionVolumetricAdvancedMaterialOutput

UMaterialExpressionVolumetricAdvancedMaterialOutput

Material output expression for writing advanced volumetric material properties.

API > API/Runtime > API/Runtime/Engine

Material output expression for writing advanced volumetric material properties.

   
Name UMaterialExpressionVolumetricAdvancedMaterialOutput
Type class
Header File /Engine/Source/Runtime/Engine/Public/Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
Include Path #include "Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h"

Syntax

UCLASS (MinimalAPI, CollapseCategories, HideCategories=Object)  
class UMaterialExpressionVolumetricAdvancedMaterialOutput : public UMaterialExpressionCustomOutput

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialExpressionVolumetricAdvancedMaterialOutput ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bClampMultiScatteringContribution bool Set whether multiple scattering contribution entry is clamped in [0,1] or not. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Options"
bGrayScaleMaterial bool Set this for the material to only be considered grey scale, only using the R chanel of the input parameters internally. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Options"
bGroundContribution bool Sample the shadowed lighting contribution from the ground onto the medium (single scattering). Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Options"
bRayMarchVolumeShadow bool Disable this to use the cloud shadow map instead of secondary raymarching. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Options"
ConservativeDensity FExpressionInput This is a 3-components float vector. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="This is a 4-components float vector. The X component must represent the participating medium conservative density. This is used to accelerate the ray marching by early skipping expensive material evaluation. For example, the bare minimum would be a top down 2D density texture skipping evaluating the full material in empty regions (better, would be a simple blobby volume representation of clouds). The Y, Z and W components can contain parameters that can be recovered during the material graph evaluation using the VolumetricAdvancedMaterialInput node. Evaluated per sample.")
ConstMultiScatteringContribution float Only used if MultiScatteringContribution is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Multi-Scattering"
  • Meta=(OverridingInputProperty="MultiScatteringContribution", UIMin=0.0f, UIMax=1.0f, ClampMin=0.0f, ClampMax=1.0f)
ConstMultiScatteringEccentricity float Only used if MultiScatteringEccentricity is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Multi-Scattering"
  • Meta=(OverridingInputProperty="MultiScatteringEccentricity", UIMin=0.0f, UIMax=1.0f, ClampMin=0.0f, ClampMax=1.0f)
ConstMultiScatteringOcclusion float Only used if MultiScatteringOcclusion is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Multi-Scattering"
  • Meta=(OverridingInputProperty="MultiScatteringOcclusion", UIMin=0.0f, UIMax=1.0f, ClampMin=0.0f, ClampMax=1.0f)
ConstPhaseBlend float Only used if PhaseBlend is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Phase"
  • Meta=(OverridingInputProperty="PhaseBlend", UIMin=0.0f, UIMax=1.0f, ClampMin=0.999f, ClampMax=0.999f)
ConstPhaseG float Only used if PhaseG is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Phase"
  • Meta=(OverridingInputProperty="PhaseG", UIMin=0.999f, UIMax=0.999f, ClampMin=0.999f, ClampMax=0.999f)
ConstPhaseG2 float Only used if PhaseG2 is not hooked up. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Phase"
  • Meta=(OverridingInputProperty="PhaseG2", UIMin=0.999f, UIMax=0.999f, ClampMin=0.999f, ClampMax=0.999f)
MultiScatteringApproximationOctaveCount uint32 How many octave to use for the multiple-scattering approximation. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Multi-Scattering"
  • Meta=(UIMin=0, UIMax=1, ClampMin=0, ClampMax=2)
MultiScatteringContribution FExpressionInput Multi-scattering approximation: represents how much contribution each successive octave will add. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Multi-scattering approximation: represents how much contribution each successive octave will add. Evaluated per pixel. Valid range is [0,1], from low to high contribution. Defaults to ConstMultiScatteringContribution from properties panel if not specified. Evaluated per pixel (globally).")
MultiScatteringEccentricity FExpressionInput Multi-scattering approximation: represents how much the phase will become isotropic for each successive octave. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Multi-scattering approximation: represents how much the phase will become isotropic for each successive octave. Evaluated per pixel. Valid range is [0,1], from anisotropic to isotropic phase. Defaults to ConstMultiScatteringEccentricity from properties panel if not specified. Evaluated per pixel (globally).")
MultiScatteringOcclusion FExpressionInput Multi-scattering approximation: represents how much occlusion will be reduced for each successive octave. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Multi-scattering approximation: represents how much occlusion will be reduced for each successive octave. Evaluated per pixel. Valid range is [0,1], from low to high occlusion. Defaults to ConstMultiScatteringOcclusion from properties panel if not specified. Evaluated per pixel (globally).")
PerSamplePhaseEvaluation bool Set this to true to force the phase function to be evaluated per sample, instead once per pixel (globally). Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • EditAnywhere
  • Category="Phase"
PhaseBlend FExpressionInput Lerp factor when blending the two phase functions parameterized by G and G2. Valid range is [0,1]. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Lerp factor when blending the two phase functions parameterized by G and G2. Valid range is [0,1] Defaults to ConstPhaseBlend from properties panel if not specified. Evaluated per sample if EvaluatePhaseOncePerSample is true.")
PhaseG FExpressionInput Parameter 'g' input to the phase function describing how much forward(g<0) or backward (g>0) light scatter around. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Parameter 'g' input to the phase function describing how much forward(g<0) or backward (g>0) light scatter around. Valid range is [-1,1]. Defaults to ConstPhaseG from properties panel if not specified. Evaluated per sample if EvaluatePhaseOncePerSample is true.")
PhaseG2 FExpressionInput Parameter 'g' input to the second phase function describing how much forward(g<0) or backward (g>0) light scatter around. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h
  • Meta=(RequiredInput="false", ToolTip="Parameter 'g' input to the second phase function describing how much forward(g<0) or backward (g>0) light scatter around. Valid range is [-1,1]. Defaults to ConstPhaseG2 from properties panel if not specified. Evaluated per sample if EvaluatePhaseOncePerSample is true.")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetEvaluatePhaseOncePerSample()

   Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

uint32 GetMultiScatteringApproximationOctaveCount()

   Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

Overridden from UMaterialExpressionCustomOutput

Name Remarks Include Path Unreal Specifiers

virtual FString GetDisplayName()

   Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

virtual FString GetFunctionName()

   Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

virtual int32 GetNumOutputs()

 Override to enable multiple outputs. Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

Overridden from UMaterialExpression

Name Remarks Include Path Unreal Specifiers

virtual int32 Compile ( FMaterialCompiler* Compiler,
int32 OutputIndex
)

 Create the new shader code chunk needed for the Abs expression Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

virtual void GetCaption ( TArray< FString >& OutCaptions
) const

 Returns the text to display on the material expression (in the material editor). Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page