/******************************************************************************
* Copyright (c) 2018(-2024) STMicroelectronics.
* All rights reserved.
*
* This file is part of the TouchGFX 4.24.1 distribution.
*
* This software is licensed under terms that can be found in the LICENSE file in
* the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
*******************************************************************************/

/**
 * @file touchgfx/transforms/DisplayTransformation.hpp
 *
 * Declares the touchgfx::DisplayTransformation class.
 */
#ifndef TOUCHGFX_DISPLAYTRANSFORMATION_HPP
#define TOUCHGFX_DISPLAYTRANSFORMATION_HPP

#include <touchgfx/hal/Types.hpp>

namespace touchgfx
{
/**
 * Defines transformations from display space to framebuffer space. The display might be
 * (considered) in portrait mode from 0,0 to 272,480, while the actual framebuffer is
 * from 0,0 to 480,272. This class handles the transformations.
 */
class DisplayTransformation
{
public:
    /**
     * Transform x,y from display to framebuffer coordinates.
     *
     * @param [in,out] x the x part to translate.
     * @param [in,out] y the y part to translate.
     */
    static void transformDisplayToFrameBuffer(int16_t& x, int16_t& y);

    /**
     * Transform x,y from display to framebuffer coordinates.
     *
     * @param [in,out] x the x part to translate.
     * @param [in,out] y the y part to translate.
     */
    static void transformDisplayToFrameBuffer(float& x, float& y);

    /**
     * Transform x,y from framebuffer to display coordinates.
     *
     * @param [in,out] x the x part to translate.
     * @param [in,out] y the y part to translate.
     */
    static void transformFrameBufferToDisplay(int16_t& x, int16_t& y);

    /**
     * Transform x,y from coordinates relative to the in rect to framebuffer coordinates.
     *
     * Transform x,y from coordinates relative to the in rect to framebuffer coordinates.
     *
     * @param [in,out] x  the x part to translate.
     * @param [in,out] y  the y part to translate.
     * @param          in the rectangle defining the coordinate space.
     */
    static void transformDisplayToFrameBuffer(int16_t& x, int16_t& y, const Rect& in);

    /**
     * Transform x,y from coordinates relative to the in rect to framebuffer coordinates.
     *
     * Transform x,y from coordinates relative to the in rect to framebuffer coordinates.
     *
     * @param [in,out] x  the x part to translate.
     * @param [in,out] y  the y part to translate.
     * @param          in the rectangle defining the coordinate space.
     */
    static void transformDisplayToFrameBuffer(float& x, float& y, const Rect& in);

    /**
     * Transform rectangle from display to framebuffer coordinates.
     *
     * @param [in,out] r the rectangle to translate.
     */
    static void transformDisplayToFrameBuffer(Rect& r);

    /**
     * Transform rectangle from framebuffer to display coordinates.
     *
     * @param [in,out] r the rectangle to translate.
     */
    static void transformFrameBufferToDisplay(Rect& r);

    /**
     * Transform rectangle r from coordinates relative to the in rect to framebuffer
     * coordinates.
     *
     * Transform rectangle r from coordinates relative to the in rect to framebuffer
     * coordinates.
     *
     * @param [in,out] r  the rectangle to translate.
     * @param          in the rectangle defining the coordinate space.
     */
    static void transformDisplayToFrameBuffer(Rect& r, const Rect& in);
};

} // namespace touchgfx

#endif // TOUCHGFX_DISPLAYTRANSFORMATION_HPP
