Component:SimplexTexture: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
add info, templates
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SimplexTextureComponent.png
|Image=SimplexTextureComponent.png
|Name=Simplex Texture
|Name=Simplex Texture
}}
}}
The '''SimplexTexture''' component is used to generate procedural noise to use in any [[material]].


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|FilterMode|TextureFilterMode|
|FilterMode|TextureFilterMode| {{Template:Texture FilterMode Field}}
|AnisotropicLevel|Int|
|AnisotropicLevel|Int| {{Template:Texture AnisotropicLevel Field}}
|WrapModeU|TextureWrapMode|
|WrapModeU|TextureWrapMode| {{Template:Texture WrapMode Field|X}}
|WrapModeV|TextureWrapMode|
|WrapModeV|TextureWrapMode| {{Template:Texture WrapMode Field|Y}}
|MipmapBias|Float|
|MipmapBias|Float| {{Template:Texture MipmapBias Field}}
|Profile|ColorProfile|
|Profile|ColorProfile| {{Template:Texture Profile Field}}
|Size|Int2|
|Size|Int2| {{Template:ProceduralTexture Size Field}}
|Mipmaps|Bool|
|Mipmaps|Bool| {{Template:Texture Mipmaps Field}}
|Format|TextureFormat|
|Format|TextureFormat| {{Template:Texture TextureFormat Field}}
|Offset|Float2|
|Offset|Float2| How much to shift the procedural noise.
|Scale|Float2|
|Scale|Float2| scales the pattern up or down inside the image.
|Background|ColorX|
|Background|ColorX| The background color of the noise.
|Foreground|ColorX|
|Foreground|ColorX| The color of the noise itself.
|Use3D|Bool|
|Use3D|Bool| Whether to allow <code>ZOffset</code> to affect the texture, and generates 3D noise.
|ZOffset|Float|
|ZOffset|Float| The offset in the 3D noise, which takes a slice of the 3D noise for the texture.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeTexture()|[[Type:Action|Action]]| {{Template:BakeTexture Sync Method}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Insert into any [[material]] to view what this texture looks like.


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


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
 
[[Category:Components{{#translation:}}|Simplex Texture]]
[[Category:Components{{#translation:}}|Simplex Texture]]
[[Category:Components:Assets:Procedural Textures{{#translation:}}|Simplex Texture]]
[[Category:Components:Assets:Procedural Textures{{#translation:}}|Simplex Texture]]

Latest revision as of 16:11, 19 November 2024

Component image 
Simplex Texture component as seen in the Scene Inspector

The SimplexTexture component is used to generate procedural noise to use in any material.

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.
FilterMode TextureFilterMode How to handle the interpolation between pixels.
AnisotropicLevel Int The levels of Anisotropic filtering distances when using Anisotropic for FilterMode
WrapModeU TextureWrapMode How to repeat or mirror the texture along the X axis. this goes into affect when X values are outside of the range [0.0 to 1.0].
WrapModeV TextureWrapMode How to repeat or mirror the texture along the Y axis. this goes into affect when Y values are outside of the range [0.0 to 1.0].
MipmapBias Float Whether to see lower resolution versions of the texture closer up or not (MipMaps).
Profile ColorProfile The color profile to use for this texture's rendering.
Size Int2 The size of the procedural texture in pixels.
Mipmaps Bool Whether to enable the rendering of mipmaps, which are lower res textures at further distances from the camera to improve performance.
Format TextureFormat TextureFormat describes how Texture's pixel are stored in the VRAM.
Offset Float2 How much to shift the procedural noise.
Scale Float2 scales the pattern up or down inside the image.
Background ColorX The background color of the noise.
Foreground ColorX The color of the noise itself.
Use3D Bool Whether to allow ZOffset to affect the texture, and generates 3D noise.
ZOffset Float The offset in the 3D noise, which takes a slice of the 3D noise for the texture.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
BakeTexture() Action BakeTexture first generates a Component:StaticTexture2D that is the same as this procedural texture. The resulting static texture replaces every reference to the original procedural texture. Lastly the original procedural texture is deleted.

Usage

Insert into any material to view what this texture looks like.

Examples

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


See Also