Interface IPipeline
public interface IPipeline
The pipeline is a list of streams that are executed in order for every invoked flush.
Multiple pipelines can be created for different purposes, they can be used for the same display.
Multiple pipelines can be created for different purposes, they can be used for the same display.
WARNING: This pipeline is not thread-safe and should only be used on a single thread.
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
addNode
(IPipelineStream stream) Deprecated.void
addStream
(IPipelineStream stream) Adds the given stream to the streams executed on a flush.
They are executed in the order in which they are added.default void
destroy()
Destroys the pipeline and internal related resources.
WARNING: This method should be called when the pipeline is no longer needed.void
flush
(IPipelineInput input) Flushes the pipeline.output()
Currently only used internally, but is a working part of the API.void
output
(IPipelineOutput output) Currently only used internally, but is a working part of the API.default void
removeNode
(IPipelineStream stream) Deprecated.misleading name, useremoveStream(IPipelineStream)
insteadboolean
removeStream
(IPipelineStream stream) Removes the given stream from the streams executed on a flush.
They are executed in the order in which they are added.@Unmodifiable List
<IPipelineStream> streams()
The returned streams are executed in the order in which they are added on a flush.
-
Method Details
-
output
IPipelineOutput output()Currently only used internally, but is a working part of the API.- Returns:
- the output instance used for flushing
-
output
Currently only used internally, but is a working part of the API.- Parameters:
output
- the output instance used for flushing
-
addStream
Adds the given stream to the streams executed on a flush.
They are executed in the order in which they are added.- Parameters:
stream
- the stream to add
-
addNode
Deprecated.misleading name, useaddStream(IPipelineStream)
instead -
removeStream
Removes the given stream from the streams executed on a flush.
They are executed in the order in which they are added.- Parameters:
stream
- the stream to remove
-
removeNode
Deprecated.misleading name, useremoveStream(IPipelineStream)
instead -
streams
@Unmodifiable List<IPipelineStream> streams()The returned streams are executed in the order in which they are added on a flush.- Returns:
- the streams executed on a flush
-
flush
Flushes the pipeline. This will execute all streams in the order in which they are added.- Parameters:
input
- the input to use for the pipeline- See Also:
-
destroy
default void destroy()Destroys the pipeline and internal related resources.
WARNING: This method should be called when the pipeline is no longer needed. It is not guaranteed that a pipeline will work correctly after this method is called.
-
addStream(IPipelineStream)
instead