Component:ReflectionMaterial: Difference between revisions

From Resonite Wiki
imported>Mysticporo
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=ReflectionMaterialComponent.png |Name=Reflection Material }} <!--T:2--> == Fields == {{Tabl..."
 
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,
 
(8 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ReflectionMaterialComponent.png
|Image=ReflectionMaterialComponent.png
|Name=Reflection Material
|Name=Reflection Material
}}
}}
Used with Camera Portals to render what the component sees into a visual result. Like mirrors, portals, a Tardis, gateways, and Non-Euclidean tunnels.


<!--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| Internal.
|ReflectionTexture|IAssetProvider`1|TypeString2=IAssetProvider<ITexture2D>|
|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.
|NormalMap|IAssetProvider`1|TypeString3=IAssetProvider<ITexture2D>|
|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.
|NormalMapScale|Float2|
|NormalMapScale|Float2| The scaling of the normal map across the rendered surface.
|NormalMapOffset|Float2|
|NormalMapOffset|Float2| The offset position of the normal map across the rendered surface.
|Distort|Float|
|Distort|Float| How much effect the normal map should have on the reflection.
|TintColor|Color|
|TintColor|ColorX| What color to tint the projected image.
|BlendMode|BlendMode|
|BlendMode|BlendMode|{{Template:Material_BlendMode_Desc}}
|AlphaCutoff|Float|
|AlphaCutoff|Float| If the reflected image has alpha, then render nothing for alpha below this threshold.
|Sidedness|Sidedness|
|Sidedness|Sidedness|{{Template:Material_Sidedness_Desc}}
|ZWrite|ZWrite|
|ZWrite|ZWrite|{{Template:Material_ZWrite_Desc}}
|OffsetFactor|Float|
|OffsetFactor|Float|{{Template:Material_OffsetFactor_Desc}}
|OffsetUnits|Float|
|OffsetUnits|Float|{{Template:Material_OffsetUnits_Desc}}
|RenderQueue|Int|
|RenderQueue|Int|{{Template:Material_RenderQueue_Desc}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== 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.


<!--T:4-->
<!--T:4-->
Line 35: Line 36:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:CameraPortal]]
* [[Component:RenderTextureProvider]]
 
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Reflection Material]]
[[Category:Components{{#translation:}}|Reflection Material]]
[[Category:Materials:Special{{#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 00:50, 14 November 2024

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.
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 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.
NormalMapScale Float2 The scaling of the normal map across the rendered surface.
NormalMapOffset Float2 The offset position of the normal map across the rendered surface.
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 the reflected image has alpha, then render nothing for alpha below this 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 Template:Material RenderQueue Desc

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

See Also