Struct UniformSampler
Returns uniformly distributed random values within a designated range.
Inherited Members
Namespace: UnityEngine.Experimental.Perception.Randomization.Samplers
Syntax
[Serializable]
public struct UniformSampler : ISamplerConstructors
UniformSampler(Single, Single, UInt32)
Constructs a new uniform distribution sampler
Declaration
public UniformSampler(float min, float max, uint baseSeed = 539662031U)Parameters
| Type | Name | Description |
|---|---|---|
| Single | min | The smallest value contained within the range |
| Single | max | The largest value contained within the range |
| UInt32 | baseSeed | The base random seed to use for this sampler |
Properties
baseSeed
The base seed used to initialize this sampler's state
Declaration
public uint baseSeed { get; set; }Property Value
| Type | Description |
|---|---|
| UInt32 |
Implements
range
A range bounding the values generated by this sampler
Declaration
public FloatRange range { get; set; }Property Value
| Type | Description |
|---|---|
| FloatRange |
Implements
state
The current random state of this sampler
Declaration
public uint state { get; set; }Property Value
| Type | Description |
|---|---|
| UInt32 |
Implements
Methods
IterateState(Int32)
Deterministically offsets a sampler's state
Declaration
public void IterateState(int offsetIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | offsetIndex | The index used to offset the sampler's state. Typically set to either the current scenario iteration or a job's batch index. |
Implements
ResetState()
Resets a sampler's state to its base random seed
Declaration
public void ResetState()Implements
Sample()
Generates one sample
Declaration
public float Sample()Returns
| Type | Description |
|---|---|
| Single | The generated sample |
Implements
Samples(Int32, out JobHandle)
Schedules a job to generate an array of samples
Declaration
public NativeArray<float> Samples(int sampleCount, out JobHandle jobHandle)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | sampleCount | The number of samples to generate |
| JobHandle | jobHandle | The handle of the scheduled job |
Returns
| Type | Description |
|---|---|
| NativeArray<Single> | A NativeArray of generated samples |