Component:FogBoxVolumeMaterial: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update 'StencilComparison' description,'StencilOperation' description,'StencilID' description,'StencilWriteMask' description,'StencilReadMask' description,'RenderQueue' description,'BlendMode' description,'Sidedness' description,'ZWrite' description,'ZTest' description,'OffsetFactor' description,'OffsetUnits' description,
m Added basic information, added a tip on how to create spherical fog.
 
(4 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=FogBoxVolumeMaterialComponent.png
|Image=FogBoxVolumeMaterialComponent.png
|Name=Fog Box Volume Material
|Name=Fog Box Volume Material
}}
}}
{{stub}}
== Description ==
The FogBoxVolumeMaterial is a material used to create cube-shaped volumetric fog on a mesh. 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 [[Component:LookAtUser|LookAtUser]] component targetting the local User along with a spherical mesh to create an illusion of a sphere-shaped fog.


<!--T:2-->
<!--T:2-->
Line 12: Line 17:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|_shader|{{RootFieldType|AssetRef`1|[[Type:Shader|Shader]]}}|TypeAdv1=true|
|_shader|{{RootFieldType|AssetRef`1|[[Type:Shader|Shader]]}}|TypeAdv1=true|{{Template:Material__shader}}
|BaseColor|ColorX|
|BaseColor|ColorX|{{Template:Material_BaseColor}}
|AccumulationColor|ColorX|
|AccumulationColor|ColorX|{{Template:Material_AccumulationColor}}
|AccumulationColorBottom|ColorX|
|AccumulationColorBottom|ColorX|{{Template:Material_AccumulationColorBottom}}
|AccumulationColorTop|ColorX|
|AccumulationColorTop|ColorX|{{Template:Material_AccumulationColorTop}}
|FogStart|Float|
|FogStart|Float|{{Template:Material_FogStart}}
|FogEnd|Float|
|FogEnd|Float|{{Template:Material_FogEnd}}
|FogDensity|Float|
|FogDensity|Float|{{Template:Material_FogDensity}}
|GammaCurve|Float|
|GammaCurve|Float|{{Template:Material_GammaCurve}}
|WorldSpace|Bool|
|WorldSpace|Bool|{{Template:Material_WorldSpace}}
|ColorMode|'''[[#Color|Color]]'''|TypeAdv11=true|
|ColorMode|'''[[#Color|Color]]'''|TypeAdv11=true|{{Template:Material_ColorMode}}
|SaturationMode|'''[[#Saturation|Saturation]]'''|TypeAdv12=true|
|SaturationMode|'''[[#Saturation|Saturation]]'''|TypeAdv12=true|{{Template:Material_SaturationMode}}
|AccumulationMode|'''[[#Accumulation|Accumulation]]'''|TypeAdv13=true|
|AccumulationMode|'''[[#Accumulation|Accumulation]]'''|TypeAdv13=true|{{Template:Material_AccumulationMode}}
|AccumulationRate|Float|
|AccumulationRate|Float|{{Template:Material_AccumulationRate}}
|BlendMode|BlendMode|{{Template:Material__Desc}}
|BlendMode|BlendMode|{{Template:Material_BlendMode_Desc}}
|RenderQueue|Int|{{Template:Material_RenderQueue_Desc}}
|RenderQueue|Int|{{Template:Material_RenderQueue_Desc}}
}}
== Color ==
{{Table EnumValues
|Constant|0| A single color fog
|VerticalGradient|1| A fog with a gradient pattern
}}
== Saturation ==
{{Table EnumValues
|Unrestricted|0|
|SaturateAlpha|1|
|SaturateColor|2|
}}
== Accumulation ==
{{Table EnumValues
|Linear|0|
|Exponential|1|
|ExponentialSquared|2|
}}
}}


Line 37: Line 62:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]

Latest revision as of 20:07, 13 July 2025

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. 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 targetting 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

Usage

Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:FogBoxVolumeMaterial&oldid=106391"