This repository has been archived on 2023-02-02. You can view files and clone it, but cannot push or open issues or pull requests.
mfgames-nitride-cil/src/MfGames.Nitride/Pipelines/IPipeline.cs
D. Moonfire 9e93eb6ce6 refactor!: fixed missed namespaces
- reformatted code and cleaned up references
2023-01-14 18:19:42 -06:00

28 lines
882 B
C#

using System.Collections.Generic;
using MfGames.Gallium;
namespace MfGames.Nitride.Pipelines;
/// <summary>
/// Implements the basic signature for a pipeline, a distinct unit of
/// processing that reads, manipulates, and writes data.
/// </summary>
public interface IPipeline
{
/// <summary>
/// Gets the dependencies for the pipeline.
/// </summary>
IEnumerable<IPipeline> GetDependencies();
/// <summary>
/// Performs various operations such as reading, writing, and
/// transformation on the given entities before returning a new
/// collection, which may or may not include some of the original
/// entities.
/// </summary>
/// <param name="entities">The entities to process.</param>
/// <returns>The resulting entities after the process runs.</returns>
IAsyncEnumerable<Entity> RunAsync(IEnumerable<Entity> entities);
}