EnvironmentMap Struct Reference

#include <drake/geometry/render_vtk/render_engine_vtk_params.h>

Public Member Functions
template<typename Archive >
void	Serialize (Archive *a)
	Passes this object to an Archive. More...

Public Attributes
bool	skybox {true}
	If true, the environment map will be rendered in a sky box. More...
std::variant< NullTexture, EquirectangularMap >	texture
	The texture to use for the environment map. More...

Member Function Documentation

Serialize()

void Serialize

(

Archive *

a

)

Passes this object to an Archive.

Refer to YAML Serialization for background.

Member Data Documentation

skybox

bool skybox {true}

If true, the environment map will be rendered in a sky box.

If false, it won't be visible in the background, but it will illuminate objects.

texture

std::variant<NullTexture, EquirectangularMap> texture

The texture to use for the environment map.

If none is defined, there is no environment map.

In yaml, this must be spelled out with the type tag. E.g.,

environment_map:
  skybox: true
  texture: !EquirectangularMap
    path: /path/to/environment_image.hdr

Warning

This feature is considered to be experimental and may change or be removed at any time, without any deprecation notice ahead of time.

Note

This will change from a simple file path to a more comprehensive URI soon. So, be aware you will have to change /path/image.png to file:///path/image.png in the near future.

---

The documentation for this struct was generated from the following file:

• drake/geometry/render_vtk/render_engine_vtk_params.h