Class RenderGroup

Namespace

nadena.dev.ndmf.preview

A group of renderers that will be processed together.

public class RenderGroup

Inheritance

object

RenderGroup

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

IsEmpty

public bool IsEmpty { get; }

Property Value

bool

Renderers

public ImmutableList<Renderer> Renderers { get; }

Property Value

ImmutableList<Renderer>

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(RenderGroup)

protected bool Equals(RenderGroup other)

Parameters

other RenderGroup

Returns

bool

For(Renderer)

public static RenderGroup For(Renderer renderer)

Parameters

renderer Renderer

Returns

RenderGroup

For(IEnumerable<Renderer>)

public static RenderGroup For(IEnumerable<Renderer> renderers)

Parameters

renderers IEnumerable<Renderer>

Returns

RenderGroup

GetData<T>()

public T GetData<T>()

Returns

T

Type Parameters

T

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WithData<T>(T)

Returns a RenderGroup with additional data attached. The attached data can be retrieved later using GetData.

This overload uses legacy heuristic equality rules; use an explicit equality overload instead.

[Obsolete("Use an explicit equality overload instead.")]
public RenderGroup WithData<T>(T data)

Parameters

data T

Returns

RenderGroup

Type Parameters

T

WithData<T>(T, IEqualityComparer<T>)

Returns a RenderGroup with additional data attached. The attached data can be retrieved later using GetData.

The comparer defines how the attached data participates in RenderGroup identity, which may be used to retain target groups or reuse preview nodes. A filter must use consistent equality semantics for the same data type.

public RenderGroup WithData<T>(T data, IEqualityComparer<T> comparer)

Parameters

data T

comparer IEqualityComparer<T>

Returns

RenderGroup

Type Parameters

T

WithData<T>(T, Func<T, T, bool>)

Returns a RenderGroup with additional data attached. The attached data can be retrieved later using GetData.

The equality function defines how the attached data participates in RenderGroup identity, which may be used to retain target groups or reuse preview nodes. A filter must use consistent equality semantics for the same data type.

public RenderGroup WithData<T>(T data, Func<T, T, bool> equals)

Parameters

data T

equals Func<T, T, bool>

Returns

RenderGroup

Type Parameters

T