Component:VolumeUnlitMaterial

From Resonite Wiki
Revision as of 19:04, 6 February 2025 by 989onan (talk | contribs) (add some info)
Component image 
Volume Unlit Material component as seen in the Scene Inspector

The VolumeUnlitMaterial component is used to display 3d textures like Xrays, sunbeams, MRIs, CT scans, or any other 3d texture in a volumetric 3d cube that can optionally be sliced. Can also be used for volumetric lighting, but high texture resolutions can be large and cause considerable render lag.

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.
Mode DisplayMode How to display the texture in 3D space.
BlendMode BlendMode How to blend this material's colors vs what it rendered on top of.
RenderQueue Int changes at which point a material renders on the render stack
Volume Texture3D The 3D texture this material should display.
StepSize Float How many cell details there should be.
Gain Float How much to gain up the color.
Exp Float What exponent to raise colors to.
AccumulationCutoff Float if color goes beyond this brightness, don't render it.
HitThreshold Float
InputRange Float What range duration within 0<->1 do the colors in the 3d image have? Useful for isolating particular ranges for densities in a CT scan.
InputOffset Float at what point does the range start?
UseAlphaChannel Bool Whether to use the alpha channel in the pixel data of Volume.
Slices list of SlicePlane Slice planes that cut the volume along local positions and directions.
Highlights list of Highlight A list of Highlights to use.

Usage

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


DisplayMode

Values
Name Value Description
Additive 0 Volumetric adds onto the color of things behind it unclamped.
AdditiveCutoff 1 Volumetric adds onto the color of things behind it clamped.
HitThreshold 2

SlicePlane

Fields
Name Type Description
Normal Float3 The normal direction of the slice in local space.
Offset Float The position of the slice in local space.

Highlight

Fields
Name Type Description
Normal Float3
Offset Float
Range Float
Color ColorX

Examples

  • Khawn2u's RTX world with sunbeams.
  • displays for imported 3D textures

See Also