# LightingParams

Class · category: Graphics

Source: https://github.com/playcanvas/engine/blob/970d89f6d3bc6667f4e1f88153abd6e7e82ed52c/src/scene/lighting/lighting-params.js#L11

Lighting parameters, allow configuration of the global lighting parameters. For details see
[Clustered Lighting](https://developer.playcanvas.com/user-manual/graphics/lighting/clustered-lighting/).

## Properties

### atlasSplit

```ts
atlasSplit: number[] | null = null
```

Atlas textures split description, which applies to both the shadow and cookie texture atlas.
Defaults to null, which enables to automatic split mode. For details see [Configuring Atlas
Split](https://developer.playcanvas.com/user-manual/graphics/lighting/clustered-lighting/#configuring-atlas).

### debugLayer

```ts
debugLayer: number
```

Layer ID of a layer to contain the debug rendering of clustered lighting. Defaults to
undefined, which disables the debug rendering. Debug rendering is only included in the debug
version of the engine.

## Accessors

### areaLightsEnabled

```ts
get areaLightsEnabled(): boolean
set areaLightsEnabled(value: boolean)
```

Gets whether clustered lighting supports area lights.

### cells

```ts
get cells(): Vec3
set cells(value: Vec3)
```

Gets the number of cells along each world space axis the space containing lights is
subdivided into.

### cookieAtlasResolution

```ts
get cookieAtlasResolution(): number
set cookieAtlasResolution(value: number)
```

Gets the resolution of the atlas texture storing all non-directional cookie textures.

### cookiesEnabled

```ts
get cookiesEnabled(): boolean
set cookiesEnabled(value: boolean)
```

Gets whether clustered lighting supports cookie textures.

### maxLights

```ts
get maxLights(): number
set maxLights(value: number)
```

Gets the maximum number of lights the clustered lighting can use in a single frame.

### maxLightsPerCell

```ts
get maxLightsPerCell(): number
set maxLightsPerCell(value: number)
```

Gets the maximum number of lights a cell can store.

### shadowAtlasResolution

```ts
get shadowAtlasResolution(): number
set shadowAtlasResolution(value: number)
```

Gets the resolution of the atlas texture storing all non-directional shadow textures.

### shadowsEnabled

```ts
get shadowsEnabled(): boolean
set shadowsEnabled(value: boolean)
```

Gets whether clustered lighting supports shadow casting.

### shadowType

```ts
get shadowType(): number
set shadowType(value: number)
```

Gets the type of shadow filtering used by all shadows.