Component:StaticTexture3D: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
m Added missing fields
Removed technical Information as it is already moved to the proper pages. Replaced the information with links to the central page and importing information page for Texture3D. Added links and updated the description.
 
(9 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=StaticTexture3DComponent.png
|Image=StaticTexture3DComponent.png
|Name=Static Texture 3D
|Name=Static Texture 3D
}}
}}
The '''StaticTexture3D''' component represents a bunch of [[Texture2D|textures]] stacked on top of each other to make a 3D grid of pixel values, as a [[Texture3D]]. These textures can be displayed in 3D, or sampled via 3D positions in a few different components or in [[ProtoFlux]] Nodes. When [[3D_Texture_Import|importing a Texture3D]], this component is usually applied after the import.


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|URL|Uri|The address of the texture asset
|URL|Uri|The address of the texture asset
|FilterMode|TextureFilterMode|The method of texture filtering
|FilterMode|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:TextureFilterMode|TextureFilterMode]]&gt;'''|TypeAdv1=true| {{Template:Texture FilterMode Field}}
|AnisotropicLevel|Int|
|AnisotropicLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv2=true| {{Template:Texture AnisotropicLevel Field}}
|Uncompressed|Bool|  
|Uncompressed|Bool| Whether to not compress the texture's size before loading into ram/vram. doesn't affect cloud size.
|DirectLoad|Bool|  
|DirectLoad|Bool| Whether to not cache the texture in the local cache for [[Resonite]]
|ForceExactVariant|Bool|  
|ForceExactVariant|Bool| Whether to not generate variants for this texture and force a certain texture type
|PreferredFormat|TextureCompression|TypeString6=Nullable<TextureCompression>|  
|PreferredFormat|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:TextureCompression|TextureCompression]]&gt;'''|TypeAdv6=true| The format to use for texture compression rather than the auto picked one
|PreferredProfile|ColorProfile|TypeString7=Nullable<ColorProfile>|  
|PreferredProfile|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:ColorProfile|ColorProfile]]&gt;'''|TypeAdv7=true| The color profile to use rather than the auto picked one. (usually linear)
|MipMapBias|Float|  
|MipMapBias|Float| {{Template:Texture MipmapBias Field}}
|WrapModeU|TextureWrapMode|The wrapping mode on the texture's U coordinate
|WrapModeU|TextureWrapMode| {{Template:Texture WrapMode Field|X}}
|WrapModeV|TextureWrapMode|The wrapping mode on the texture's V coordinate
|WrapModeV|TextureWrapMode| {{Template:Texture WrapMode Field|Y}}
|WrapModeW|TextureWrapMode|The wrapping mode on the texture's W coordinate
|WrapModeW|TextureWrapMode| {{Template:Texture WrapMode Field|Z}}
|Readable|Bool|Whether or not the texture can be sampled via texture sampling ProtoFlux nodes
|Readable|Bool|Whether or not the texture can be sampled via texture sampling ProtoFlux nodes
}}
== Sync Delegates ==
{{Table ComponentTriggers
|InvertRGB:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Inverts the colors of the image.
|InvertR:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Inverts the red channel of the image.
|InvertG:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Inverts the green channel of the image.
|InvertB:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Inverts the blue channel of the image.
|InvertA:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Inverts the alpha channel of the image.
|ColorToAlpha:[[Type:Func`2|Func`2]]&lt;[[Type:ColorX|ColorX]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:ColorX|ColorX]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Turns the color data of the image into transparency/alpha data.
|AlphaFromIntensity:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Makes alpha/transparency data depending on the color intensity of the image.
|AlphaToMask:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Turns the alpha of the image into a black and white image.
|RemoveAlpha:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Removes the alpha data completely from the image or makes it white.
|GrayscaleAverage:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Make grayscale image based on the average values for the colors per pixel.
|GrayscaleLuminance:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Make grayscale image based on the color luminance per pixel.
|SwapRG:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the red and green channels on the image
|SwapRB:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the red and blue channels on the image
|SwapRA:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the red and alpha channels on the image
|SwapGB:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the green and blue channels on the image
|SwapGA:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the green and alpha channels on the image
|SwapBA:[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Swaps the blue and alpha channels on the image
|AddBackground:[[Type:Func`2|Func`2]]&lt;[[Type:ColorX|ColorX]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:ColorX|ColorX]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| adds a background of a color to a transparent image.
|AdjustGamma:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Adjusts the gamma of the image.
|AdjustAlphaGamma:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Adjusts the gamma of the alpha channel of the image.
|ShiftHue:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Shifts the hue of HSV of the image.
|SetHue:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Sets the Hue of HSV of the image.
|SetSaturation:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Sets the saturation of HSV of the image.
|OffsetSaturation:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Adds to the saturation of HSV of the image.
|MulSaturation:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Multiplies the saturation of HSV of the image.
|SetValue:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Sets the value of HSV of the image.
|MulValue:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Multiplies the value of HSV of the image.
|OffsetValue:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Adds to the value of HSV of the image.
|OffsetAlpha:[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Adds to the alpha of the image.
|Normalize:[[Type:Func`4|Func`4]]&lt;[[Type:Bool|Bool]], [[Type:Bool|Bool]], [[Type:Bool|Bool]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`4|Func`4]]&lt;[[Type:Bool|Bool]], [[Type:Bool|Bool]], [[Type:Bool|Bool]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Normalizes the colors of the image, making it have a bigger color range usage.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Is generated automatically when importing a folder of images that are slices of a cube stacked vertically. Insert into a [[Component:VolumeUnlitMaterial]] to view the colors or a [[Component:LUT Material]] to view it's affect as a filter.


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


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

Latest revision as of 21:39, 19 October 2025

Component image 
Static Texture 3D component as seen in the Scene Inspector

The StaticTexture3D component represents a bunch of textures stacked on top of each other to make a 3D grid of pixel values, as a Texture3D. These textures can be displayed in 3D, or sampled via 3D positions in a few different components or in ProtoFlux Nodes. When importing a Texture3D, this component is usually applied after the import.

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.
URL Uri The address of the texture asset
FilterMode Nullable`1<TextureFilterMode> How to handle the interpolation between pixels.
AnisotropicLevel Nullable`1<Int> The levels of Anisotropic filtering distances when using Anisotropic for FilterMode
Uncompressed Bool Whether to not compress the texture's size before loading into ram/vram. doesn't affect cloud size.
DirectLoad Bool Whether to not cache the texture in the local cache for Resonite
ForceExactVariant Bool Whether to not generate variants for this texture and force a certain texture type
PreferredFormat Nullable`1<TextureCompression> The format to use for texture compression rather than the auto picked one
PreferredProfile Nullable`1<ColorProfile> The color profile to use rather than the auto picked one. (usually linear)
MipMapBias Float Whether to see lower resolution versions of the texture closer up or not (MipMaps).
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].
WrapModeW TextureWrapMode How to repeat or mirror the texture along the Z axis. this goes into affect when Z values are outside of the range [0.0 to 1.0].
Readable Bool Whether or not the texture can be sampled via texture sampling ProtoFlux nodes

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
InvertRGB:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Inverts the colors of the image.
InvertR:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Inverts the red channel of the image.
InvertG:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Inverts the green channel of the image.
InvertB:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Inverts the blue channel of the image.
InvertA:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Inverts the alpha channel of the image.
ColorToAlpha:Func`2<ColorX, Task`1<Bool>> Func`2<ColorX, Task`1<Bool>> X Turns the color data of the image into transparency/alpha data.
AlphaFromIntensity:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Makes alpha/transparency data depending on the color intensity of the image.
AlphaToMask:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Turns the alpha of the image into a black and white image.
RemoveAlpha:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Removes the alpha data completely from the image or makes it white.
GrayscaleAverage:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Make grayscale image based on the average values for the colors per pixel.
GrayscaleLuminance:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Make grayscale image based on the color luminance per pixel.
SwapRG:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the red and green channels on the image
SwapRB:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the red and blue channels on the image
SwapRA:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the red and alpha channels on the image
SwapGB:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the green and blue channels on the image
SwapGA:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the green and alpha channels on the image
SwapBA:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Swaps the blue and alpha channels on the image
AddBackground:Func`2<ColorX, Task`1<Bool>> Func`2<ColorX, Task`1<Bool>> X adds a background of a color to a transparent image.
AdjustGamma:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Adjusts the gamma of the image.
AdjustAlphaGamma:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Adjusts the gamma of the alpha channel of the image.
ShiftHue:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Shifts the hue of HSV of the image.
SetHue:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Sets the Hue of HSV of the image.
SetSaturation:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Sets the saturation of HSV of the image.
OffsetSaturation:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Adds to the saturation of HSV of the image.
MulSaturation:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Multiplies the saturation of HSV of the image.
SetValue:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Sets the value of HSV of the image.
MulValue:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Multiplies the value of HSV of the image.
OffsetValue:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Adds to the value of HSV of the image.
OffsetAlpha:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Adds to the alpha of the image.
Normalize:Func`4<Bool, Bool, Bool, Task`1<Bool>> Func`4<Bool, Bool, Bool, Task`1<Bool>> X Normalizes the colors of the image, making it have a bigger color range usage.

Usage

Is generated automatically when importing a folder of images that are slices of a cube stacked vertically. Insert into a Component:VolumeUnlitMaterial to view the colors or a Component:LUT Material to view it's affect as a filter.

Examples

This article or section is a stub. You can help the Resonite wiki by expanding it.

See Also

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