Class FilterStack

Provides methods for handling individual Filter within a FilterStack.

Inheritance

object

Object

ScriptableObject

FilterStack

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.TerrainTools

Assembly: Unity.TerrainTools.Editor.dll

Syntax

[Serializable]
public class FilterStack : ScriptableObject

Fields

filters

The System.Collections.Generic.List`1 that contains all the Filters for this FilterStack.

Declaration

[SerializeField]
public List<Filter> filters

Field Value

Type	Description
List<Filter>

Properties

hasEnabledFilters

Checks if the filters are enabled.

Declaration

public bool hasEnabledFilters { get; }

Property Value

Type	Description
bool

Methods

Add(Filter)

Adds a Filter reference to the end of the FilterStack list of Filters.

Declaration

public void Add(Filter filter)

Parameters

Type	Name	Description
Filter	filter	The Filter reference to add.

Clear(bool)

Removes all Filters.

Declaration

public void Clear(bool destroy = false)

Parameters

Type	Name	Description
bool	destroy	When the value is true, the filters will be destroyed.

Eval(FilterContext, RenderTexture, RenderTexture)

Evaluates the FilterStack. Composited result will be copied into fc.destinationRenderTexture.

Declaration

public void Eval(FilterContext fc, RenderTexture source, RenderTexture dest)

Parameters

Type	Name	Description
FilterContext	fc	The FilterContext that should be used for composition.
RenderTexture	source	The source render texture to blit from.
RenderTexture	dest	The destination render texture for blitting to.

Exceptions

Type	Condition
InvalidOperationException	Throws an exception if source or destination RenderTexture is null.

Insert(int, Filter)

Inserts the specified Filter at the specified index.

Declaration

public void Insert(int index, Filter filter)

Parameters

Type	Name	Description
int	index	The index at which the Filter reference should be inserted.
Filter	filter	The Filter reference to insert.

Exceptions

Type	Condition
IndexOutOfRangeException	Throws an exception if the specified index is not within the valid range.

Remove(Filter)

Removes the specified Filter.

Declaration

public bool Remove(Filter filter)

Parameters

Type	Name	Description
Filter	filter	The Filter reference to remove.

Returns

Type	Description
bool	Returns true if the specified Filter was found and removed; otherwise, returns false.

RemoveAt(int)

Removes the Filter at the specified index.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
int	index	The index of the Filter to be removed.

Exceptions

Type	Condition
IndexOutOfRangeException	Throws an exception if the specified index is not within the valid range.