Class FilterStack
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
Methods
Add(Filter)
Adds a Filter reference to the end of the FilterStack list of Filters
The Filter reference to add
Declaration
public void Add(Filter filter)
Parameters
Type |
Name |
Description |
Filter |
filter |
|
Clear(Boolean)
Declaration
public void Clear(bool destroy = false)
Parameters
Type |
Name |
Description |
Boolean |
destroy |
|
Eval(FilterContext, RenderTexture, RenderTexture)
Evaluate the FilterStack. Composited result will be copied into fc.destinationRenderTexture
The FilterContext that should be used for composition
Throws an exception if source or destination RenderTexture is null
Declaration
public void Eval(FilterContext fc, RenderTexture source, RenderTexture dest)
Parameters
Insert(Int32, Filter)
Inserts the specified Filter at the specified index
The index at which the Filter reference should be inserted
The Filter reference to insert
Throws an exception if the specified index is not within the valid range
Declaration
public void Insert(int index, Filter filter)
Parameters
Remove(Filter)
Removes the specified Filter
The Filter reference to remove
Returns true if the specified Filter was found and removed; otherwise, returns false.
Declaration
public bool Remove(Filter filter)
Parameters
Type |
Name |
Description |
Filter |
filter |
|
Returns
RemoveAt(Int32)
Removes the Filter at the specified index
The index of the Filter to be removed
Throws an exception if the specified index is not within the valid range
Declaration
public void RemoveAt(int index)
Parameters
Type |
Name |
Description |
Int32 |
index |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.