An image of the environment surrounding a 3D scene, captured in all directions, together with its orientation and brightness. More...

#include <luciad/maps/effects/EnvironmentMap.h>

Classes
class	CubeMapBuilder
	Builder for an `luciad::EnvironmentMap` from six cubemap faces. More...
class	EquirectangularBuilder
	Builder for an `luciad::EnvironmentMap` from a single equirectangular (2:1) image. More...

Public Member Functions
	EnvironmentMap (const EnvironmentMap &)=delete
EnvironmentMap &	operator= (const EnvironmentMap &)=delete

Static Public Member Functions
static CubeMapBuilder	newCubeMapBuilder ()
	Creates a new builder for an environment map from six cubemap faces.
static EquirectangularBuilder	newEquirectangularBuilder ()
	Creates a new builder for an environment map from a single equirectangular (2:1) image.

Detailed Description

An image of the environment surrounding a 3D scene, captured in all directions, together with its orientation and brightness.

An environment map can be used by luciad::EnvironmentMapEffect as a skybox and/or as a reflection map. See that class for what each role does.

Create one with EnvironmentMap::newEquirectangularBuilder for a single equirectangular (2:1) image, or with EnvironmentMap::newCubeMapBuilder for six-square, equally sized face images.

HDR imagery is supported and recommended for reflection maps: supply images with a floating point pixel format (PixelFormat::Rgb32 or PixelFormat::Rgba32).

An environment map is an opaque value: once built, it cannot be inspected or modified.

Since: 2026.1

Constructor & Destructor Documentation

◆ EnvironmentMap()

luciad::EnvironmentMap::EnvironmentMap ( const EnvironmentMap & )

delete

Member Function Documentation

◆ newCubeMapBuilder()

CubeMapBuilder luciad::EnvironmentMap::newCubeMapBuilder ( )

static

Creates a new builder for an environment map from six cubemap faces.

Returns: a new builder.

◆ newEquirectangularBuilder()

EquirectangularBuilder luciad::EnvironmentMap::newEquirectangularBuilder ( )

static

Creates a new builder for an environment map from a single equirectangular (2:1) image.

Returns: a new builder.

◆ operator=()

EnvironmentMap & luciad::EnvironmentMap::operator= ( const EnvironmentMap & )