Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TerrainData.GetDetailLayer

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function GetDetailLayer(xBase: int, yBase: int, width: int, height: int, layer: int): int[,];
public int[,] GetDetailLayer(int xBase, int yBase, int width, int height, int layer);

Parameters

Description

Returns a 2D array of the detail object density in the specific location.

The Terrain system uses detail layer density maps. Each map is essentially a grayscale image where each pixel value denotes the number of detail objects that will be procedurally placed terrain area. That corresponds to the pixel. Since several different detail types may be used, the map is arranged into "layers" - the array indices of the layers are determined by the order of the detail types defined in the Terrain inspector (ie, when the Paint Details tool is selected).

	// Set all pixels in a detail map below a certain threshold to zero.
	function DetailMapCutoff(t: Terrain, threshold: float) {
		// Get all of layer zero.
		var map = t.terrainData.GetDetailLayer(0, 0, t.terrainData.detailWidth, t.terrainData.detailHeight, 0);
		
		// For each pixel in the detail map...
		for (var y = 0; y < t.terrainData.detailHeight; y++) {
			for (var x = 0; x < t.terrainData.detailWidth; x++) {
				// If the pixel value is below the threshold then
				// set it to zero.
				if (map[x, y] < threshold) {
					map[x, y] = 0.0;
				}
			}
		}
		
		// Assign the modified map back.
		t.terrainData.SetDetailLayer(0, 0, 0, map);
	}