SgGaussianSplats

Renders a point cloud using 3D Gaussian splatting for soft, volumetric visuals. Used to approximate complex surfaces or effects like particles, fog, or scanned geometry. Enables efficient rendering of large datasets with smooth blending between points.

Inherits from

Usage

To use this class, add the following require at the top of your script:

local SgGaussianSplats = require 'engine/sceneobjects/sggaussiansplats'

Reference

class SgGaussianSplats
module:
create(options, parent)

Create a new gaussian splats object in the scenegraph.

Parameters:

  • options (table) – A table of options to fill the parameters

  • parent (SceneObject) – The parent scene object to add this to

Returns:

a promise which will resolve to the created object

Return type:

Promise

Usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
-- Options can be omitted. This example shows the defaults,
-- only specify the ones you want different.
SgGaussianSplats:create({
    active = true,
    name = "",
    transform = Transform.new(),
    layers = {0},
    tags = {},
    receiveShadow = false,
    castShadow = false,
    splats = nil
})

Examples