quantumgraphicspreset.h

Go to the documentation of this file.

/**
 * @file quantumgraphicspreset.h
 * @brief Declares the quantumgraphicspreset visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumgraphicspreset.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 Enumerates the supported Quantum Graphics Preset Kind values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class QuantumGraphicsPresetKind
{
    Scientific = 0,
    Presentation = 1,
    Cinematic = 2
};
 
/**
 * @brief Data structure used by the Quantum Graphics Preset Values component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct QuantumGraphicsPresetValues
{
    int paletteIndex = 0;
    int displayScaleIndex = 0;
    double exposureEv = 0.0;
    double gamma = 1.0;
    int postPreviewIndex = 0;
    double brightThreshold = 0.72;
    double brightSoftKnee = 0.08;
    double blurSpread = 2.0;
    double bloomStrength = 0.0;
    int toneMapIndex = 0;
};
 
/**
 * @brief Implements the Quantum Graphics Preset component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class QuantumGraphicsPreset
{
public:
    /**
     * @brief Returns values.
     * @param kind The kind value used by the operation.
     */
    static QuantumGraphicsPresetValues values(QuantumGraphicsPresetKind kind);
    /**
     * @brief Returns name.
     * @param kind The kind value used by the operation.
     */
    static const char *name(QuantumGraphicsPresetKind kind);
};
 
} // namespace qpe