Skip to main content

Meshes & Effects

Mesh visuals and mesh building, VFX, post effects, and Gaussian splats.

Commonly used

Guides

All APIs in this topic

Add components to a scene object and reference assets and other modules with a script input.

Components, assets, and modules

APIDescription
BaseMeshVisualBase for all mesh rendering components.
GaussianSplattingAssetAsset that contains Gaussian Splats.
GaussianSplattingVisualAllows displaying GaussianSplattingAsset and play its animation.
GltfAssetRepresents a GLTF 3D Model.
LiquifyVisualApplies a liquify effect to anything rendered behind it.
MaterialMeshVisualInherits from BaseMeshVisual and provides access to the Material used in the rendering process.
PinToMeshComponentAttaches the SceneObject to the mesh surface of a specific RenderMeshVisual.
PostEffectVisualUses an input color lookup table image to adjust the coloring of the Lens.
RenderMeshRepresents a mesh asset.
RenderMeshVisualExtends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene.
SkinRepresents skinning data for rigged meshes.
VertexCacheUsed to help control vertex animations on the SceneObject.
VFXAssetDefines a VFX to use with VFXComponent.
VFXComponentRenders VFXAsset in scene.
VisualBase class for all visual Components.

Objects and data

APIDescription
DynamicMeshRenderObjectProviderRenderObjectProvider for mesh objects generated procedurally.
GltfSettingsSettings for importing a glTF Asset.
MeshBuilderA class for generating meshes at runtime.
MeshRenderObjectProvider
PassWrappersAllows for retrieval of a collection of Pass objects used by VFXAsset
ProceduralMeshRenderObjectProviderRenderObjectProvider for mesh objects generated procedurally.
Properties
RenderObjectProviderProvider for RenderMesh data.

Enums

APIDescription
MeshIndexTypePossible index data types used by MeshBuilder.
MeshTopologyMesh topology types used by MeshBuilder.