quantumbloom.h

Go to the documentation of this file.

/**
 * @file quantumbloom.h
 * @brief Declares the quantumbloom visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumbloom.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
/**
 * @brief Data record containing Quantum Bloom Sample.
 *
 * The structure carries computed data without coupling the numerical component to the GUI or renderer.
 */
struct QuantumBloomSample
{
    float r = 0.0f;
    float g = 0.0f;
    float b = 0.0f;
};
 
// Small CPU reference for the GPU bloom composition used by QuantumGLView.
// The quantum state is never modified: this combines display-space HDR colors only.
/**
 * @brief Implements the Quantum Bloom component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class QuantumBloom
{
public:
    /**
     * @brief Performs clamp strength.
     * @param strength The strength value used by the operation.
     */
    static float clampStrength(float strength);
 
    /**
     * @brief Performs combine.
     * @param scene The scene value used by the operation.
     * @param blurredHighlights The blurred highlights value used by the operation.
     * @param strength The strength value used by the operation.
     */
    static QuantumBloomSample combine(const QuantumBloomSample &scene,
                                      const QuantumBloomSample &blurredHighlights,
                                      float strength);
};
 
} // namespace qpe