Parallax.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include "Core/Levels/CameraFraming.h"
#include "Core/Math/Rect.h"
#include "Core/Math/Vector2.h"

 
namespace hmi {

inline constexpr float PARALLAX_FACTOR_NONE = 1.0f;

[[nodiscard]] core::Vector2 parallaxRenderPosition(core::Vector2 modelPosition,
                                                   core::Vector2 factor,
                                                   const core::Rect& cameraBounds) noexcept;

[[nodiscard]] core::Vector2 parallaxModelPosition(core::Vector2 renderPosition,
                                                  core::Vector2 factor,
                                                  const core::Rect& cameraBounds) noexcept;

[[nodiscard]] core::Vector2 clampPlaneOffset(core::Vector2 offset, const core::Rect& planeBounds,
                                             const core::Rect& cameraBounds) noexcept;

[[nodiscard]] constexpr bool planeParallaxActive(core::CameraFramingMode mode,
                                                 bool levelFlag) noexcept {
    if (!levelFlag) {
        return false;
    }
    return mode != core::CameraFramingMode::WholeLevel;
}

[[nodiscard]] core::Vector2 roundToScreenPixel(core::Vector2 worldPosition,
                                               float pixelsPerWorldUnit) noexcept;
 
}  // namespace hmi