Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Terrain.GetClosestReflectionProbes

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 GetClosestReflectionProbes(result: List<ReflectionProbeBlendInfo>): void;
public void GetClosestReflectionProbes(List<ReflectionProbeBlendInfo> result);

Parameters

result [in / out] A list to hold the returned reflection probes and their weights. See ReflectionProbeBlendInfo.

Description

Fills the list with reflection probes whose AABB intersects with terrain's AABB. Their weights are also provided. Weight shows how much influence the probe has on the terrain, and is used when the blending between multiple reflection probes occurs.

This function won't touch result if Terrain.reflectionProbeUsage is ReflectionProbeUsage.Off, otherwise the original content of the list will be cleared.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download