Interface IBrushRenderUnderCursor
Implement this interface to wrap all of the functionality required to render a terrain-brush under the cursor.
Inherited Members
Namespace: UnityEditor.Experimental.TerrainAPI
Syntax
public interface IBrushRenderUnderCursor : IPaintContextRender, IDisposableMethods
AcquireHeightmap(Boolean, Rect, Int32)
Gets the PaintContext for the height-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireHeightmap(bool writable, Rect boundsInTerrainSpace, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | writable | "true" if we wish to allow writing to the height-map, "false" otherwise. |
| Rect | boundsInTerrainSpace | The bounds of the height-map to use (in pixels). |
| System.Int32 | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | The paint context created. |
AcquireNormalmap(Boolean, Rect, Int32)
Gets the PaintContext for the normal-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireNormalmap(bool writable, Rect boundsInTerrainSpace, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | writable | "true" if we wish to allow writing to the normal-map, "false" otherwise. |
| Rect | boundsInTerrainSpace | The bounds of the normal-map to use (in pixels). |
| System.Int32 | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | The paint context created. |
AcquireTexture(Boolean, Rect, TerrainLayer, Int32)
Gets the PaintContext for the texture-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireTexture(bool writable, Rect boundsInTerrainSpace, TerrainLayer layer, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | writable | "true" if we wish to allow writing to the texture-map, "false" otherwise. |
| Rect | boundsInTerrainSpace | The bounds of the texture-map to use (in pixels). |
| TerrainLayer | layer | The terrain layer to acquire the texture-map for. |
| System.Int32 | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | The paint context created. |
CalculateBrushTransform(out BrushTransform)
Calculates the brush transform under the cursor (taking into account scattering).
Declaration
bool CalculateBrushTransform(out BrushTransform brushTransform)Parameters
| Type | Name | Description |
|---|---|---|
| BrushTransform | brushTransform | The brush-transform on the terrain at the specified UV co-ordinates. |
Returns
| Type | Description |
|---|---|
| System.Boolean | "true" if calculated successfully, "false" otherwise. |
Release(PaintContext)
Releases the PaintContext specified, if this was made writable when acquired then we write back into the texture at this point.
Declaration
void Release(PaintContext paintContext)Parameters
| Type | Name | Description |
|---|---|---|
| PaintContext | paintContext | The paint context to be released. |