Class ColorHsvaParameter | Perception | 0.5.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class ColorHsvaParameter

    A numeric parameter for generating color samples using HSVA samplers

    Inheritance
    Object
    Parameter
    NumericParameter<Color>
    ColorHsvaParameter
    Inherited Members
    NumericParameter<Color>.sampleType
    NumericParameter<Color>.GenericSample()
    NumericParameter<Color>.Validate()
    Parameter.GetDisplayName(Type)
    Parameter.ResetState()
    Parameter.IterateState(Int32)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.Experimental.Perception.Randomization.Parameters
    Syntax
    [Serializable]
    public class ColorHsvaParameter : NumericParameter<Color>

    Fields

    alpha

    The sampler used for randomizing the alpha component of generated samples

    Declaration
    [SerializeReference]
    public ISampler alpha
    Field Value
    Type Description
    ISampler

    hue

    The sampler used for randomizing the hue component of generated samples

    Declaration
    [SerializeReference]
    public ISampler hue
    Field Value
    Type Description
    ISampler

    saturation

    The sampler used for randomizing the saturation component of generated samples

    Declaration
    [SerializeReference]
    public ISampler saturation
    Field Value
    Type Description
    ISampler

    value

    The sampler used for randomizing the value component of generated samples

    Declaration
    [SerializeReference]
    public ISampler value
    Field Value
    Type Description
    ISampler

    Methods

    Sample()

    Generates an RGBA color sample

    Declaration
    public override Color Sample()
    Returns
    Type Description
    Color

    The generated RGBA sample

    Overrides
    UnityEngine.Experimental.Perception.Randomization.Parameters.NumericParameter<UnityEngine.Color>.Sample()

    SampleHsva()

    Generates an HSVA color sample

    Declaration
    public ColorHsva SampleHsva()
    Returns
    Type Description
    ColorHsva

    The generated HSVA sample

    Samples(Int32, out JobHandle)

    Schedules a job to generate an array of RGBA color samples

    Declaration
    public override NativeArray<Color> 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<Color>

    A NativeArray of samples

    Overrides
    UnityEngine.Experimental.Perception.Randomization.Parameters.NumericParameter<UnityEngine.Color>.Samples(System.Int32, Unity.Jobs.JobHandle)

    SamplesHsva(Int32, out JobHandle)

    Schedules a job to generate an array of HSVA color samples

    Declaration
    public NativeArray<ColorHsva> SamplesHsva(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<ColorHsva>

    A NativeArray of samples

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023