# EnvironmentMap(bpy_struct)

base class — `bpy_struct`

class `bpy.types.``EnvironmentMap`(bpy_struct)

  Environment map created by the renderer and cached for subsequent renders

  `clip_end`

    Objects further than this are not visible to map

    Type: | float in [0.01, inf], default 0.0

  `clip_start`

    Objects nearer than this are not visible to map

    Type: | float in [0.001, inf], default 0.0

  `depth`

    Number of times a map will be rendered recursively (mirror effects)

    Type: | int in [0, 5], default 0

  `is_valid`

    True if this map is ready for use, False if it needs rendering

    Type: | boolean, default False, (readonly)

  `layers_ignore`

    Hide objects on these layers when generating the Environment Map

    Type: | boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False)

  `mapping`
    - `CUBE` Cube, Use environment map with six cube sides.
    - `PLANE` Plane, Only one side is rendered, with Z axis pointing in direction of image.

    Type: | enum in [‘CUBE’, ‘PLANE’], default ‘CUBE’

  `resolution`

    Pixel resolution of the rendered environment map

    Type: | int in [50, 4096], default 0

  `source`
    - `STATIC` Static, Calculate environment map only once.
    - `ANIMATED` Animated, Calculate environment map at each rendering.
    - `IMAGE_FILE` Image File, Load a saved environment map image from disk.

    Type: | enum in [‘STATIC’, ‘ANIMATED’, ‘IMAGE_FILE’], default ‘STATIC’

  `viewpoint_object`

    Object to use as the environment map’s viewpoint location

    Type: | `Object`

  `zoom`

    Type: | float in [0.1, 5], default 0.0

  `clear`()

    Discard the environment map and free it from memory

  `save`(filepath, scene=None, layout=(0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 1.0))

    Save the environment map to disc using the scene render settings

    Parameters: | filepath (string, (never None)) – File path, Location of the output file scene (`Scene`, (optional)) – Overrides the scene from which image parameters are taken layout (float array of 12 items in [0, 1000], (optional)) – File layout, Flat array describing the X,Y position of each cube face in the output image, where 1 is the size of a face - order is [+Z -Z +Y -X -Y +X] (use -1 to skip a face)

Inherited Properties

`bpy_struct.id_data` |

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` | `bpy_struct.keyframe_delete` `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`

References

`EnvironmentMapTexture.environment_map` |