Version: 2020.1
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

TerrainPaintUtility.GetBrushWorldSizeLimits

Leave feedback
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

public static void GetBrushWorldSizeLimits(out float minBrushWorldSize, out float maxBrushWorldSize, float terrainTileWorldSize, int terrainTileTextureResolutionPixels, int minBrushResolutionPixels, int maxBrushResolutionPixels);

Parameters

minBrushWorldSize Returns the minimum Brush size, in world space units.
maxBrushWorldSize Returns the maximum Brush size, in world space units.
terrainTileWorldSize The size of a Terrain tile, in world space units.
terrainTileTextureResolutionPixels The resolution of the Terrain tile texture the Brush edits, in pixels.
minBrushResolutionPixels The minimum Brush resolution, in pixels. Default is 1 pixel.
maxBrushResolutionPixels The maximum Brush resolution, in pixels. Default is 8192 pixels.

Description

Calculates the minimum and maximum Brush size limits, in world space.

Converts the minimum and maximum Brush pixel resolutions into the equivalent world space sizes.

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2021-02-24.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information