Options
All
  • Public
  • Public/Protected
  • All
Menu

PBRSettings lets you configure the PBR shading to apply.

Note that to take effect the map graphics effects should be configured with a light.

Note that PBR shading requires browser support for some specific WebGL functionality. Float textures and some additional texture functions are required. Image-based lighting also requires additional mip level support. Running the device support sample is a good way to check if these requirements are fulfilled.

since

2021.1

Hierarchy

  • PBRSettings

Overview

Properties

Optional directionalLighting

directionalLighting: boolean

Indicates whether PBR shading should include directional lighting. This is lighting coming from the light that is configured on the map.

default

true

Optional imageBasedLighting

imageBasedLighting: boolean

Indicates whether PBR shading should include image-based lighting. This is lighting coming from the environment around the styled object. This environment lighting is taken from the reflection map. This means that to take effect the map graphics effects should be configured with an EnvironmentMapEffect with a reflection map.

Note that additional mip level support from the browser is required. Running the device support sample is a good way to check if these requirements are fulfilled.

default

true

Optional lightIntensity

lightIntensity: number

The light intensity to use for the PBR lighting. Positive values brighten and negative values darken the shading.

default

0

Optional material

material: PBRMaterial | null

Modify PBR material properties.

default

null

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method