Meziantou.FrameworkFilterInput Struct
An input of a primitive of a FilterGraph: the drawing, its alpha, or the result of an earlier primitive.
public readonly struct FilterInput : IEquatable<FilterInput>Remarks
The default value is FilterInput.Previous.
- Implements
Properties
| Name | Description |
|---|---|
| Kind | Gets what the input is. |
| Previous | Gets the result of the primitive before, or the drawing for the first primitive. |
| ResultIndex | Gets the index of the primitive whose result the input is, for FilterInputKind.Result; 0 otherwise. |
| SourceAlpha | Gets the alpha of the drawing that is filtered, with black colors. |
| SourceGraphic | Gets the drawing that is filtered. |
Kind
FilterInput.csPrevious
FilterInput.csGets the result of the primitive before, or the drawing for the first primitive.
public static FilterInput Previous { get; }Property value
ResultIndex
FilterInput.csGets the index of the primitive whose result the input is, for FilterInputKind.Result; 0 otherwise.
public int ResultIndex { get; }Property value
SourceAlpha
FilterInput.csGets the alpha of the drawing that is filtered, with black colors.
public static FilterInput SourceAlpha { get; }Property value
SourceGraphic
FilterInput.csMethods
| Name | Description |
|---|---|
| Equals(FilterInput) | Indicates whether the current object is equal to another object of the same type. |
| Equals(object?) | Indicates whether this instance and a specified object are equal. |
| FromResult(int) | Gets the result of an earlier primitive of the graph. |
| GetHashCode() | Returns the hash code for this instance. |
Equals overloads
Equals(FilterInput)
FilterInput.csIndicates whether the current object is equal to another object of the same type.
public bool Equals(FilterInput other)Parameters
otherFilterInput- An object to compare with this object.
Returns
bool true if the current object is equal to the other parameter; otherwise, false.
Equals(object?)
FilterInput.csFromResult(int)
FilterInput.csGets the result of an earlier primitive of the graph.
public static FilterInput FromResult(int index)Parameters
indexint- The index of the primitive in the graph. It must be before the primitive that reads it.
Returns
FilterInput The input.
Exceptions
ArgumentOutOfRangeExceptionindexis negative.
GetHashCode()
FilterInput.csOperators
| Name | Description |
|---|---|
| operator ==(FilterInput, FilterInput) | Compares two inputs for equality. |
| operator !=(FilterInput, FilterInput) | Compares two inputs for inequality. |
operator ==(FilterInput, FilterInput)
FilterInput.csCompares two inputs for equality.
public static bool operator ==(FilterInput left, FilterInput right)Parameters
leftFilterInput- The first input.
rightFilterInput- The second input.
Returns
bool true if they are the same input; otherwise false.
operator !=(FilterInput, FilterInput)
FilterInput.csCompares two inputs for inequality.
public static bool operator !=(FilterInput left, FilterInput right)Parameters
leftFilterInput- The first input.
rightFilterInput- The second input.
Returns
bool true if they are different inputs; otherwise false.