Struct Param

Namespace

Sigil.Sound

Assembly

Sigil.Sound.dll

A value that drives an operator: a constant, another Sigil.Sound.Sound (audio-rate modulation), or a function of time in seconds. Converts implicitly from all three, so one overload covers them.

public readonly struct Param

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

ConstantValue

The constant value; only meaningful when Sigil.Sound.Param.IsConstant is true.

public float ConstantValue { get; }

Property Value

float

IsConstant

True when this parameter never changes.

public bool IsConstant { get; }

Property Value

bool

Methods

Compile(RenderContext)

Creates the per-render source that produces this parameter's values block by block.

public ParamSource Compile(RenderContext context)

Parameters

context RenderContext

Returns

ParamSource

ToString()

A short description of the parameter, used in the description of the sound it is part of.

public override string ToString()

Returns

string

Operators

implicit operator Param(float)

A constant parameter.

public static implicit operator Param(float value)

Parameters

value float

Returns

Param

implicit operator Param(double)

A constant parameter.

public static implicit operator Param(double value)

Parameters

value double

Returns

Param

implicit operator Param(Sound)

A parameter whose value is a sound, rendered at the audio rate and averaged to mono: audio-rate modulation.

public static implicit operator Param(Sound sound)

Parameters

sound Sound

Returns

Param

implicit operator Param(Func<double, float>)

A parameter that is a function of time in seconds, such as t => (float)(440 + 20 * Math.Sin(t)).

public static implicit operator Param(Func<double, float> function)

Parameters

function Func<double, float>

Returns

Param