Tools/TestWebKitAPI/Helpers/GraphicsTestUtilities.h

/*
 * Copyright (C) 2025 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <wtf/Platform.h>

#if !PLATFORM(COCOA) || !__has_feature(modules)

#include "Helpers/Test.h"
#include <WebCore/Color.h>
#include <WebCore/FloatPoint.h>

namespace WebCore {
class Image;
class ImageBuffer;
class NativeImage;

}

namespace TestWebKitAPI {

// Compares a pixel against the expected color. The tolerance is the difference that is allowed
// for each component, use a non-zero one for results that depend on the color matching of the
// platform.
::testing::AssertionResult imageBufferPixelIs(WebCore::Color expected, const WebCore::ImageBuffer&, WebCore::FloatPoint, unsigned tolerance = 0);
::testing::AssertionResult imagePixelIs(WebCore::Color expected, WebCore::Image&, WebCore::FloatPoint, unsigned tolerance = 0);
::testing::AssertionResult imagePixelIs(WebCore::Color expected, WebCore::NativeImage&, WebCore::FloatPoint, unsigned tolerance = 0);

}

#endif // !PLATFORM(COCOA) || !__has_feature(modules)