A unique ID of the layer. Layer IDs are stored inside ModelComponent#layers, RenderComponent#layers, CameraComponent#layers, LightComponent#layers and ElementComponent#layers instead of names. Can be used in LayerComposition#getLayerById.
Make this layer render the same mesh instances that another layer does instead of having its own mesh instance list. Both layers must share cameras. Frustum culling is only performed for one layer. Useful for rendering multiple passes using different shaders.
Name of the layer. Can be used in LayerComposition#getLayerByName.
Custom function that is called after the layer has been disabled. This happens when:
Custom function that is called before every mesh instance in this layer is rendered. It is not recommended to set this function when rendering many objects every frame due to performance reasons.
Custom function that is called after the layer has been enabled. This happens when:
Useful for allocating resources this layer will use (e.g. creating render targets).
Custom function that is called after visibility culling is performed for this layer. Useful for reverting changes done in Layer#onPreCull and determining final mesh instance visibility (see MeshInstance#visibleThisFrame). This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called after this layer is rendered. Useful to revert changes made in Layer#onPreRender. This function is called after the last occurrence of this layer in LayerComposition. It will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called after opaque mesh instances (not semi-transparent) in this layer are rendered. This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called after semi-transparent mesh instances in this layer are rendered. This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called before visibility culling is performed for this layer. Useful, for example, if you want to modify camera projection while still using the same camera and make frustum culling work correctly with it (see CameraComponent#calculateTransform and CameraComponent#calculateProjection). This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called before this layer is rendered. Useful, for example, for reacting on screen size changes. This function is called before the first occurrence of this layer in LayerComposition. It will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called before opaque mesh instances (not semi-transparent) in this layer are rendered. This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Custom function that is called before semi-transparent mesh instances in this layer are rendered. This function will receive camera index as the only argument. You can get the actual camera being used by looking up LayerComposition#cameras with this index.
Defines the method used for sorting opaque (that is, not semi-transparent) mesh instances before rendering. Can be:
Defaults to SORTMODE_MATERIALMESH.
A type of shader to use during rendering. Possible values are:
Defaults to SHADER_FORWARD.
Defines the method used for sorting semi-transparent mesh instances before rendering. Can be:
Defaults to SORTMODE_BACK2FRONT.
Gets whether the camera will clear the color buffer when it renders this layer.
Sets whether the camera will clear the color buffer when it renders this layer.
Gets whether the camera will clear the depth buffer when it renders this layer.
Sets whether the camera will clear the depth buffer when it renders this layer.
Gets whether the camera will clear the stencil buffer when it renders this layer.
Sets whether the camera will clear the stencil buffer when it renders this layer.
Gets the enabled state of the layer.
Sets the enabled state of the layer. Disabled layers are skipped. Defaults to true.
Adds a camera to this layer.
Adds a light to this layer.
Adds an array of mesh instances to this layer.
Array of MeshInstance.
OptionalskipShadowCasters: booleanSet it to true if you don't want these mesh instances to cast shadows in this layer. Defaults to false.
Adds an array of mesh instances to this layer, but only as shadow casters (they will not be rendered anywhere, but only cast shadows on other objects).
Array of MeshInstance.
Removes a camera from this layer.
Removes a light from this layer.
Removes multiple mesh instances from this layer.
Array of MeshInstance. If they were added to this layer, they will be removed.
OptionalskipShadowCasters: booleanSet it to true if you want to still cast shadows from removed mesh instances or if they never did cast shadows before. Defaults to false.
Removes multiple mesh instances from the shadow casters list of this layer, meaning they will stop casting shadows.
Array of MeshInstance. If they were added to this layer, they will be removed.
A Layer represents a renderable subset of the scene. It can contain a list of mesh instances, lights and cameras, their render settings and also defines custom callbacks before, after or during rendering. Layers are organized inside LayerComposition in a desired order.