Component:ReflectionMaterial: Difference between revisions

From Resonite Wiki
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,
Automated: update '_shader' description,'ReflectionTexture' description,'NormalMap' description,'NormalMapScale' description,'NormalMapOffset' description,'Distort' description,'TintColor' description,'AlphaCutoff' description,
 
(One intermediate revision by one other user not shown)
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|_shader|{{RootFieldType|AssetRef`1|[[Type:Shader|Shader]]}}|TypeAdv1=true| Internal.
|_shader|{{RootFieldType|AssetRef`1|[[Type:Shader|Shader]]}}|TypeAdv1=true|{{Template:Material__shader}}
|ReflectionTexture|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv2=true| A texture usually generated by a [[Component:CameraPortal|Camera Portal]] or previously rendered by a Camera Portal.
|ReflectionTexture|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv2=true|{{Template:Material_ReflectionTexture}}
|NormalMap|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv3=true| What normal map to use on the reflected image. This can be used as a way to create an illusion of moving heat in a portal gateway, or to add irregularity in the surface of a mirror.
|NormalMap|{{RootFieldType|AssetRef`1|[[Type:ITexture2D|ITexture2D]]}}|TypeAdv3=true|{{Template:Material_NormalMap}}
|NormalMapScale|Float2| The scaling of the normal map across the rendered surface.
|NormalMapScale|Float2|{{Template:Material_NormalMapScale}}
|NormalMapOffset|Float2| The offset position of the normal map across the rendered surface.
|NormalMapOffset|Float2|{{Template:Material_NormalMapOffset}}
|Distort|Float| How much effect the normal map should have on the reflection.
|Distort|Float|{{Template:Material_Distort}}
|TintColor|ColorX| What color to tint the projected image.
|TintColor|ColorX|{{Template:Material_TintColor}}
|BlendMode|BlendMode|{{Template:Material_BlendMode_Desc}}
|BlendMode|BlendMode|{{Template:Material_BlendMode_Desc}}
|AlphaCutoff|Float| If the reflected image has alpha, then render nothing for alpha below this threshold.
|AlphaCutoff|Float|{{Template:Material_AlphaCutoff}}
|Sidedness|Sidedness|{{Template:Material_Sidedness_Desc}}
|Sidedness|Sidedness|{{Template:Material_Sidedness_Desc}}
|ZWrite|ZWrite|{{Template:Material_ZWrite_Desc}}
|ZWrite|ZWrite|{{Template:Material_ZWrite_Desc}}
Line 34: Line 34:
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
Line 41: Line 42:


</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Reflection Material]]
[[Category:Components{{#translation:}}|Reflection Material]]
[[Category:Materials:Special{{#translation:}}|Reflection Material]]
[[Category:Materials:Special{{#translation:}}|Reflection Material]]
[[Category:Materials{{#translation:}}|Reflection Material]]
[[Category:Materials{{#translation:}}|Reflection Material]]
[[Category:Components:Assets:Materials:Special{{#translation:}}|Reflection Material]]
[[Category:Components:Assets:Materials:Special{{#translation:}}|Reflection Material]]

Latest revision as of 20:44, 29 June 2025

Component image 
Reflection Material component as seen in the Scene Inspector

Used with Camera Portals to render what the component sees into a visual result. Like mirrors, portals, a Tardis, gateways, and Non-Euclidean tunnels.

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.
ReflectionTexture ITexture2D A texture usually generated by a Camera Portal or previously rendered by a Camera Portal.
NormalMap ITexture2D The normal map is used as a way to change the appearance of a surface when shined on by lights, to give the illusion of a raised surface.
NormalMapScale Float2 The UV scaling of the normal map texture.
NormalMapOffset Float2 The UV offset of the normal texture.
Distort Float How much effect the normal map should have on the reflection.
TintColor ColorX What color to tint the projected image.
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.
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.
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 provide the needed render texture to view, which is usually generated by a camera portal. The material will then show either a mirror or portal like effect.

Examples

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

See Also