booleanambientBake 

If enabled, the ambient lighting will be baked into lightmaps. This will be either the Scene#skybox if set up, otherwise Scene#ambientLight. Defaults to false.

numberambientBakeNumSamples 

If Scene#ambientBake is true, this specifies the number of samples used to bake the ambient light into the lightmap. Defaults to 1. Maximum value is 255.

numberambientBakeOcclusionBrightness 

If Scene#ambientBake is true, this specifies the brightness of ambient occlusion. Typical range is -1 to 1. Defaults to 0, representing no change to brightness.

numberambientBakeOcclusionContrast 

If Scene#ambientBake is true, this specifies the contrast of ambient occlusion. Typical range is -1 to 1. Defaults to 0, representing no change to contrast.

numberambientBakeSpherePart 

If Scene#ambientBake is true, this specifies a part of the sphere which represents the source of ambient light. The valid range is 0..1, representing a part of the sphere from top to the bottom. A value of 0.5 represents the upper hemisphere. A value of 1 represents a full sphere. Defaults to 0.4, which is a smaller upper hemisphere as this requires fewer samples to bake.

ColorambientLight 

The color of the scene's ambient light. Defaults to black (0, 0, 0).

numberambientLuminance 

The luminosity of the scene's ambient light in lux (lm/m^2). Used if physicalUnits is true. Defaults to 0.

booleanclusteredLightingEnabled 

True if the clustered lighting is enabled. Set to false before the first frame is rendered to use non-clustered lighting. Defaults to true.

TextureenvAtlas 

The environment lighting atlas.

numberexposure 

The exposure value tweaks the overall brightness of the scene. Ignored if physicalUnits is true. Defaults to 1.

stringfog 

The type of fog used by the scene. Can be:

• FOG_NONE
• FOG_LINEAR
• FOG_EXP
• FOG_EXP2

Defaults to FOG_NONE.

ColorfogColor 

The color of the fog (if enabled). Defaults to black (0, 0, 0).

numberfogDensity 

The density of the fog (if enabled). This property is only valid if the fog property is set to FOG_EXP or FOG_EXP2. Defaults to 0.

numberfogEnd 

The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to FOG_LINEAR. Defaults to 1000.

numberfogStart 

The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to FOG_LINEAR. Defaults to 1.

numbergammaCorrection 

The gamma correction to apply when rendering the scene. Can be:

• GAMMA_NONE
• GAMMA_SRGB

Defaults to GAMMA_SRGB.

LayerCompositionlayers 

A LayerComposition that defines rendering order of this scene.

LightingParamslighting 

A LightingParams that defines lighting parameters.

booleanlightmapFilterEnabled 

Enables bilateral filter on runtime baked color lightmaps, which removes the noise and banding while preserving the edges. Defaults to false. Note that the filtering takes place in the image space of the lightmap, and it does not filter across lightmap UV space seams, often making the seams more visible. It's important to balance the strength of the filter with number of samples used for lightmap baking to limit the visible artifacts.

numberlightmapFilterRange 

A range parameter of the bilateral filter. It's used when Scene#lightmapFilterEnabled is enabled. Larger value applies more widespread blur. This needs to be a positive non-zero value. Defaults to 10.

numberlightmapFilterSmoothness 

A spatial parameter of the bilateral filter. It's used when Scene#lightmapFilterEnabled is enabled. Larger value blurs less similar colors. This needs to be a positive non-zero value. Defaults to 0.2.

booleanlightmapHDR 

Enables HDR lightmaps. This can result in smoother lightmaps especially when many samples are used. Defaults to false.

numberlightmapMaxResolution 

The maximum lightmap resolution. Defaults to 2048.

numberlightmapMode 

The lightmap baking mode. Can be:

• BAKE_COLOR: single color lightmap
• BAKE_COLORDIR: single color lightmap + dominant light direction (used for bump or specular). Only lights with bakeDir=true will be used for generating the dominant light direction.

Defaults to BAKE_COLORDIR.

numberlightmapPixelFormat 

The lightmap pixel format.

numberlightmapSizeMultiplier 

The lightmap resolution multiplier. Defaults to 1.

booleanphysicalUnits 

Use physically based units for cameras and lights. When used, the exposure value is ignored.

Texture[]prefilteredCubemaps 

Set of 6 prefiltered cubemaps.

Entityroot 

The root entity of the scene, which is usually the only child to the Application root entity.

Textureskybox 

The base cubemap texture used as the scene's skybox, if mip level is 0. Defaults to null.

numberskyboxIntensity 

Multiplier for skybox intensity. Defaults to 1. Unused if physical units are used.

numberskyboxLuminance 

Luminance (in lm/m^2) of skybox. Defaults to 0. Only used if physical units are used.

numberskyboxMip 

The mip level of the skybox to be displayed. Only valid for prefiltered cubemap skyboxes. Defaults to 0 (base level).

QuatskyboxRotation 

The rotation of the skybox to be displayed. Defaults to Quat.IDENTITY.

numbertoneMapping 

The tonemapping transform to apply when writing fragments to the frame buffer. Can be:

• TONEMAP_LINEAR
• TONEMAP_FILMIC
• TONEMAP_HEJL
• TONEMAP_ACES
• TONEMAP_ACES2

Defaults to TONEMAP_LINEAR.

setSkybox([cubemaps]) 

Sets the cubemap for the scene skybox.

Parameters

cubemaps

Texture[]

An array of cubemaps corresponding to the skybox at different mip levels. If undefined, scene will remove skybox. Cubemap array should be of size 7, with the first element (index 0) corresponding to the base cubemap (mip level 0) with original resolution. Each remaining element (index 1-6) corresponds to a fixed prefiltered resolution (128x128, 64x64, 32x32, 16x16, 8x8, 4x4).

set:layers 

Fired when the layer composition is set. Use this event to add callbacks or advanced properties to your layers.

this.app.scene.on('set:layers', function (oldComp, newComp) {
    const list = newComp.layerList;
    for (let i = 0; i < list.length; i++) {
        const layer = list[i];
        switch (layer.name) {
            case 'MyLayer':
                layer.onEnable = myOnEnableFunction;
                layer.onDisable = myOnDisableFunction;
                break;
            case 'MyOtherLayer':
                layer.shaderPass = myShaderPass;
                break;
        }
    }
});

Parameters

oldComp	LayerComposition	Previously used LayerComposition.
newComp	LayerComposition	Newly set LayerComposition.

set:skybox 

Fired when the skybox is set.

Parameters

usedTex

Texture

Previously used cubemap texture. New is in the Scene#skybox.

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

name	string	Name of event to fire.
arg1	*	First argument that is passed to the event handler.
arg2	*	Second argument that is passed to the event handler.
arg3	*	Third argument that is passed to the event handler.
arg4	*	Fourth argument that is passed to the event handler.
arg5	*	Fifth argument that is passed to the event handler.
arg6	*	Sixth argument that is passed to the event handler.
arg7	*	Seventh argument that is passed to the event handler.
arg8	*	Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

const handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

const evt = obj.on('test', function (a, b) {
    console.log(a + b);
});
// some time later
evt.off();

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

Can be used for removing event in the future.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

• can be used for removing event in the future.