Class PlayTextureSequence

Namespace

Bonsai.Shaders

Assembly

Bonsai.Shaders.dll

Represents an operator that starts playing the frame sequence of a video texture or texture array.

public class PlayTextureSequence : Combinator<ElementIndex<Texture>>

Inheritance

object

Combinator<ElementIndex<Texture>>

PlayTextureSequence

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Loop

Gets or sets a value indicating whether the video should loop when the end of the file is reached.

public bool Loop { get; set; }

Property Value

bool

PlaybackRate

Gets or sets the rate at which to playback the sequence. A value of zero means the native frame rate will be used.

[Range(0, 2147483647)]
public double PlaybackRate { get; set; }

Property Value

double

TextureName

Gets or sets the name of the texture sequence.

[TypeConverter(typeof(TextureNameConverter))]
public string TextureName { get; set; }

Property Value

string

Methods

Process()

Generates an observable sequence that starts playing the frames of a video texture or texture array in order.

public IObservable<ElementIndex<Texture>> Process()

Returns

IObservable<ElementIndex<Texture>>

An observable sequence reporting the zero-based index of the frame which is currently active in the specified texture.

Process(IObservable<Texture>)

Starts playing the frames of the video texture or texture array in an observable sequence.

public IObservable<ElementIndex<Texture>> Process(IObservable<Texture> source)

Parameters

source IObservable<Texture>

The sequence of Texture objects for which to start playing the frames in orer. The texture must be either a video texture or a texture array.

Returns

IObservable<ElementIndex<Texture>>

An observable sequence reporting the zero-based index of the frame which is currently active in the specified texture.

Process<TSource>(IObservable<TSource>)

Starts playing the frames of a video texture or texture array in order whenever an observable sequence emits a notification.

public override IObservable<ElementIndex<Texture>> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The sequence containing the notifications used to start playing the video texture or texture array.

Returns

IObservable<ElementIndex<Texture>>

An observable sequence reporting the zero-based index of the frame which is currently active in the specified texture.

Type Parameters

TSource

The type of the elements in the source sequence.