Component:OverlayUnlitMaterial: Difference between revisions

From Resonite Wiki
imported>Mysticporo
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=OverlayUnlitMaterialComponent.png |Name=Overlay Unlit Material }} <!--T:2--> == Fields == {..."
 
Automated: update '_shader' description,'BehindTintColor' description,'FrontTintColor' description,'BehindTexture' description,'BehindTextureScale' description,'BehindTextureOffset' description,'FrontTexture' description,'FrontTextureScale' description,'FrontTextureOffset' description,'AlphaCutoff' description,'UseVertexColors' description,'VertexColorInterpolationSpace' description,'PolarUVmapping' description,'PolarPower' description,
 
(7 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=OverlayUnlitMaterialComponent.png
|Image=OverlayUnlitMaterialComponent.png
|Name=Overlay Unlit Material
|Name=Overlay Unlit Material
}}
}}
The '''OverlayUnlitMaterial''' component is a material that is similar to a [[Component:UnlitMaterial]] except it renders differently when in front or behind an object.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|_shader|IAssetProvider`1|TypeString1=IAssetProvider<Shader>|
|_shader|{{RootFieldType|AssetRef`1|[[Type:Shader|Shader]]}}|TypeAdv1=true|{{Template:Material__shader}}
|BehindTintColor|Color|
|BehindTintColor|ColorX|{{Template:Material_BehindTintColor}}
|FrontTintColor|Color|
|FrontTintColor|ColorX|{{Template:Material_FrontTintColor}}
|BehindTexture|IAssetProvider`1|TypeString4=IAssetProvider<ITexture2D>|
|BehindTexture|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv4=true|{{Template:Material_BehindTexture}}
|BehindTextureScale|Float2|
|BehindTextureScale|Float2|{{Template:Material_BehindTextureScale}}
|BehindTextureOffset|Float2|
|BehindTextureOffset|Float2|{{Template:Material_BehindTextureOffset}}
|FrontTexture|IAssetProvider`1|TypeString7=IAssetProvider<ITexture2D>|
|FrontTexture|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv7=true|{{Template:Material_FrontTexture}}
|FrontTextureScale|Float2|
|FrontTextureScale|Float2|{{Template:Material_FrontTextureScale}}
|FrontTextureOffset|Float2|
|FrontTextureOffset|Float2|{{Template:Material_FrontTextureOffset}}
|BlendMode|BlendMode|
|BlendMode|BlendMode|{{Template:Material_BlendMode_Desc}}
|AlphaCutoff|Float|
|AlphaCutoff|Float|{{Template:Material_AlphaCutoff}}
|UseVertexColors|Bool|
|UseVertexColors|Bool|{{Template:Material_UseVertexColors}}
|Sidedness|Sidedness|
|VertexColorInterpolationSpace|ColorProfile|{{Template:Material_VertexColorInterpolationSpace}}
|ZWrite|ZWrite|
|Sidedness|Sidedness|{{Template:Material_Sidedness_Desc}}
|PolarUVmapping|Bool|
|ZWrite|ZWrite|{{Template:Material_ZWrite_Desc}}
|PolarPower|Float|
|PolarUVmapping|Bool|{{Template:Material_PolarUVmapping}}
|OffsetFactor|Float|
|PolarPower|Float|{{Template:Material_PolarPower}}
|OffsetUnits|Float|
|OffsetFactor|Float|{{Template:Material_OffsetFactor_Desc}}
|RenderQueue|Int|
|OffsetUnits|Float|{{Template:Material_OffsetUnits_Desc}}
|RenderQueue|Int|{{Template:Material_RenderQueue_Desc}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach to a slot and put into the materials of a renderer like a [[Component:SkinnedMeshRenderer]] or a [[Component:MeshRenderer]] with a mesh to view what the material looks like.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Overlay Unlit Material]]
[[Category:Components{{#translation:}}|Overlay Unlit Material]]
[[Category:Materials:Unlit{{#translation:}}|Overlay Unlit Material]]
[[Category:Materials{{#translation:}}|Overlay Unlit Material]]
[[Category:Components:Assets:Materials:Unlit{{#translation:}}|Overlay Unlit Material]]
[[Category:Components:Assets:Materials:Unlit{{#translation:}}|Overlay Unlit Material]]

Latest revision as of 20:43, 29 June 2025

Component image 
Overlay Unlit Material component as seen in the Scene Inspector

The OverlayUnlitMaterial component is a material that is similar to a Component:UnlitMaterial except it renders differently when in front or behind an object.

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.
BehindTintColor ColorX The color tint when the material is behind an object.
FrontTintColor ColorX The color tint when the material is in front of an object.
BehindTexture ITexture2D The texture to use when the material is behind an object.
BehindTextureScale Float2 The UV scale of BehindTexture.
BehindTextureOffset Float2 The UV offset of BehindTexture.
FrontTexture ITexture2D The texture to use when the material is in front of an object.
FrontTextureScale Float2 The UV scale of FrontTexture.
FrontTextureOffset Float2 The UV offset of FrontTexture.
BlendMode BlendMode How to blend this material's colors vs what it rendered on top of.
AlphaCutoff Float If BlendMode is set to cutout, discard rendering of pixels for the surface that fall below this alpha threshold.
UseVertexColors Bool Whether the material should use vertex colors from the mesh.
VertexColorInterpolationSpace ColorProfile How to interpolate vertex colors on the mesh.
Sidedness Sidedness Render on both sides of the mesh, front, or back.
ZWrite ZWrite whether this material should respect the distance it is from the camera.
PolarUVmapping Bool Whether to use polar UV unwrapping.
PolarPower Float The power of the polar UV unwrapping.
OffsetFactor Float how much this material should be pushed forwards or backwards on the depth buffer factor wise
OffsetUnits Float how much this material should be pushed forwards or backwards on the depth buffer unit wise
RenderQueue Int changes at which point a material renders on the render stack

Usage

Attach to a slot and put into the materials of a renderer like a Component:SkinnedMeshRenderer or a Component:MeshRenderer with a mesh to view what the material looks like.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also