Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Gather(Func<ITerrainInfo, Texture>, Color, Material, int, Action<ITerrainInfo>, Action<ITerrainInfo>)

Gathers user-specified Texture data into sourceRenderTexture.
Read time 1 minuteLast updated 7 days ago

Definition

public void Gather(Func<PaintContext.ITerrainInfo, Texture> terrainSource, Color defaultColor, Material blitMaterial = null, int blitPass = 0, Action<PaintContext.ITerrainInfo> beforeBlit = null, Action<PaintContext.ITerrainInfo> afterBlit = null)

Parameters

terrainSource

Func<ITerrainInfo, Texture>
A function that returns the Texture data to collect from each Terrain.

defaultColor

Color
The default color for 
sourceRenderTexture
.

blitMaterial

Material
The material used to copy the data. If null, the default blit material is used.

blitPass

int
The material pass used to copy the data.

beforeBlit

Action<ITerrainInfo>
An optional action to call before copying from each Terrain. The default is null.

afterBlit

Action<ITerrainInfo>
An optional action to call after copying from each Terrain. The default is null.

Remarks

This function collects Texture data from all Terrain tiles in the PaintContext, and merges that data into 
sourceRenderTexture
. The 
terrainSource
function specifies what data to collect from each Terrain. Gather assumes that the Texture data, which 
terrainSource
returns, is mapped over the Terrain tile in a manner similar to the Heightmap and Alphamaps.
First, the function clears 
sourceRenderTexture
to 
defaultColor
.
Then, it uses the following steps to gather each Terrain in the PaintContext:
  1. Calls 
    terrainSource
    to retrieve the Texture.
  2. Calls 
    beforeBlit
    .
  3. Uses 
    blitMaterial
    and 
    blitPass
    to copy The Texture into 
    sourceRenderTexture
    .
  4. Calls 
    afterBlit
    .
Additional Resources: PaintContext, PaintContext.Scatter.