Component:FogBoxVolumeMaterial

Component image 

Fog Box Volume Material component as seen in the Scene Inspector

This article or section is a stub. You can help the Resonite wiki by expanding it.

Description

The FogBoxVolumeMaterial is a material used to create cube-shaped volumetric fog on a mesh, such as a Texture3D. Using this material on non-cube-like meshes may result in visual artifacts and/or denser fog in places where the corners of the cube would be.

Although only cube-shaped meshes are officially supported, users may use the LookAtUser component targeting the local User along with a spherical mesh to create an illusion of a sphere-shaped fog.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
HighPriorityIntegration	Bool	If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
_shader	Shader	Internal.
BaseColor	ColorX	Starting color for the fog volume
AccumulationColor	ColorX	Color to use for a Constant fog
AccumulationColorBottom	ColorX	Color at the end of a Vertical Gradient fog
AccumulationColorTop	ColorX	Color at the start of a Vertical Gradient fog
FogStart	Float	Template:Material FogStart
FogEnd	Float	Template:Material FogEnd
FogDensity	Float	Template:Material FogDensity
GammaCurve	Float	The gamma curve of the material colors.
WorldSpace	Bool	Template:Material WorldSpace
ColorMode	Color	Template:Material ColorMode
SaturationMode	Saturation	Template:Material SaturationMode
AccumulationMode	Accumulation	Template:Material AccumulationMode
AccumulationRate	Float	Template:Material AccumulationRate
BlendMode	BlendMode	How to blend this material's colors vs what it rendered on top of.
RenderQueue	Int	changes at which point a material renders on the render stack

Color

Values

Name	Value	Description
Constant	0	A single color fog
VerticalGradient	1	A fog with a gradient pattern

Saturation

Values

Name	Value	Description
Unrestricted	0
SaturateAlpha	1
SaturateColor	2

Accumulation

Values

Name	Value	Description
Linear	0
Exponential	1
ExponentialSquared	2