Class ImageComparisonSettings | Graphics Tests Framework | 7.1.13-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class ImageComparisonSettings

    Settings to control how image comparison is performed by ImageAssert.

    Inheritance
    Object
    ImageComparisonSettings
    Namespace: UnityEngine.TestTools.Graphics
    Syntax
    [Serializable]
    public class ImageComparisonSettings

    Fields

    AverageCorrectnessThreshold

    The maximum permitted average error value across the entire image. If the average per-pixel difference across the image is above this value, the images are considered not to be equal.

    Declaration
    public float AverageCorrectnessThreshold
    Field Value
    Type Description
    Single

    PerPixelCorrectnessThreshold

    The permitted perceptual difference between individual pixels of the images.

    The deltaE for each pixel of the image is compared and any differences below this threshold are ignored.

    Declaration
    public float PerPixelCorrectnessThreshold
    Field Value
    Type Description
    Single

    TargetHeight

    The height to use for the rendered image. If a reference image already exists for this test and has a different size the test will fail.

    Declaration
    public int TargetHeight
    Field Value
    Type Description
    Int32

    TargetWidth

    The width to use for the rendered image. If a reference image already exists for this test and has a different size the test will fail.

    Declaration
    public int TargetWidth
    Field Value
    Type Description
    Int32

    UseHDR

    Use HDR rendering

    Declaration
    public bool UseHDR
    Field Value
    Type Description
    Boolean
    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