---

title: RoomEnvironment category: Addons layout: docs

RoomEnvironment

This class represents a scene with a basic room setup that can be used as input for PMREMGenerator#fromScene. The resulting PMREM represents the room's lighting and can be used for Image Based Lighting by assigning it to Scene#environment or directly as an environment map to PBR materials.

The implementation is based on the EnvironmentScene component from the model-viewer project.

Code Example

const environment = new RoomEnvironment();
const pmremGenerator = new THREE.PMREMGenerator( renderer );
const envMap = pmremGenerator.fromScene( environment ).texture;
scene.environment = envMap;

Import

RoomEnvironment is an addon, and must be imported explicitly, see Installation#Addons.

import { RoomEnvironment } from 'three/addons/environments/RoomEnvironment.js';

Constructor

new RoomEnvironment()

Methods

.dispose()

Frees internal resources. This method should be called when the environment is no longer required.

Source

examples/jsm/environments/RoomEnvironment.js