Select your preferred scripting language. All code snippets will be displayed in this language.
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
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
Returns true when
obj is excluded by the filter and false if otherwise.
Checks if the Transform for
obj is within the depth range to be filtered.
Filtering is defined as including or excluding objects based upon a specific condition. Depth filtering checks the z-position of a GameObject Transform.position and includes it when it is within the depth range and excludes it if otherwise.
IsFilteringDepth returns true when useDepth is set to true and the
obj transform's z-position is outside the depth defined by minDepth and maxDepth. This indicates the
obj is filtered which means it should be excluded. IsFilteringDepth returns false if otherwise.
Note:: Setting useOutsideDepth to true inverts the function behavior and it returns opposite results.
See Also: useDepth, ::ref:minDepth & maxDepth.
Did you find this page useful? Please give it a rating: