Version: 2019.2
LanguageEnglish
  • C#

UnityEngine.TerrainModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The Terrain module implements Unity's Terrain rendering engine available through the Terrain component.

Classes

DetailPrototypeDetail prototype used by the Terrain GameObject.
PaintContextThe context for a paint operation that may span multiple connected Terrains.
SplatPrototypeA Splat prototype is just a texture that is used by the TerrainData.
TerrainThe Terrain component renders the terrain.
TerrainCallbacksThis static class provides events that Unity triggers when Terrain data changes.
TerrainDataThe TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps.
TerrainExtensionsExtension methods to the Terrain class, used only for the UpdateGIMaterials method used by the Global Illumination System.
TerrainLayerDescription of a terrain layer.
TerrainPaintUtilityA set of utility functions for custom terrain paint tools.
TerrainUtilityProvides a set of utility functions that are used by the terrain tools.
TreeTree Component for the tree creator.
TreePrototypeSimple class that contains a pointer to a tree prototype.

Structs

BrushTransformRepresents a linear 2D transformation between brush UV space and a target XY space (typically this is a Terrain-local object space.)
PatchExtentsStructure containing minimum and maximum terrain patch height values.
TreeInstanceContains information about a tree placed in the Terrain game object.

Enumerations

DetailRenderModeRender mode for detail prototypes.
TerrainChangedFlagsIndicate the types of changes to the terrain in OnTerrainChanged callback.
TerrainHeightmapSyncControlControls what Terrain heightmap data to synchronize when there are changes to the heightmap texture.
TerrainRenderFlagsEnum provding terrain rendering options.

Did you find this page useful? Please give it a rating: