setColorProfile() [2/3]

bool fl::ChannelOptions::setColorProfile ( const EmitterProfile & profile, SourceProfile source, bool global_source, GamutPolicy gamut = GamutPolicy::ChromaCompress )

inline

Definition at line 124 of file options.h.

                                                                                                         {
#if !FL_COLOR_PROFILE_RUNTIME
        FL_UNUSED(profile); FL_UNUSED(source); FL_UNUSED(global_source); FL_UNUSED(gamut);
        return false;
#else
        // Captured before mStaticProfile is cleared below, so the warning
        // condition still sees whether a profile was bound on entry.
        const bool had_profile = hasColorProfile();
        mColorProfile.mStaticProfile = nullptr;
        if (profile.native_code_depth == 0 || profile.native_code_depth > 16 ||
            !validChromaticity(profile.xy_r) || !validChromaticity(profile.xy_g) ||
            !validChromaticity(profile.xy_b) || !validPrimaries(source.primaries) ||
            !finitePositive(profile.lum_r) || !finitePositive(profile.lum_g) || !finitePositive(profile.lum_b) ||
            (profile.topology != colorimetric_response::EmitterTopology::RGB &&
             profile.topology != colorimetric_response::EmitterTopology::RGBW &&
             profile.topology != colorimetric_response::EmitterTopology::RGBWW) ||
            (profile.topology != colorimetric_response::EmitterTopology::RGB &&
             (!validChromaticity(profile.xy_white1) ||
              !finitePositive(profile.lum_white1) ||
              (profile.response_lut_size != 0 &&
               profile.response_lut_white1 == nullptr))) ||
            (profile.topology == colorimetric_response::EmitterTopology::RGBWW &&
             (!validChromaticity(profile.xy_white2) ||
              !finitePositive(profile.lum_white2) ||
              (profile.response_lut_size != 0 &&
               profile.response_lut_white2 == nullptr))) ||
            (profile.response_lut_size != 0 &&
             (profile.response_lut_r == nullptr || profile.response_lut_g == nullptr || profile.response_lut_b == nullptr))) {
            clearColorProfile();
            return false;
        }
        if (!validResponseLut(profile.response_lut_r, profile.response_lut_size) ||
            !validResponseLut(profile.response_lut_g, profile.response_lut_size) ||
            !validResponseLut(profile.response_lut_b, profile.response_lut_size)) {
            clearColorProfile();
            return false;
        }
        if (profile.topology != colorimetric_response::EmitterTopology::RGB &&
            !validResponseLut(profile.response_lut_white1,
                              profile.response_lut_size)) {
            clearColorProfile();
            return false;
        }
        if (profile.topology == colorimetric_response::EmitterTopology::RGBWW &&
            !validResponseLut(profile.response_lut_white2,
                              profile.response_lut_size)) {
            clearColorProfile();
            return false;
        }
        // Warn only once validation has passed. Warning earlier consumed
        // mWarnedLegacyCleared on a profile that was then rejected, and
        // clearColorProfile() leaves mCorrection/mTemperature alone -- so the
        // next *valid* profile cleared the caller's legacy settings silently.
        // Every field cleared below whose loss is detectable has to be
        // represented here, or the caller loses it in silence. This used to
        // name mCorrection and mTemperature only, while the clear also resets
        // mGamma -- so a caller who set just a gamma had it discarded with no
        // warning, which is exactly what the note above is about (#4331).
        //
        // mDitherMode is deliberately absent, and cannot be added by
        // comparison. Its default is BINARY_DITHER and the clear sets
        // DISABLE_DITHER, so `mDitherMode != BINARY_DITHER` is true precisely
        // when the caller already chose DISABLE_DITHER and nothing is being
        // taken away, and false in the case that loses dithering. Detecting
        // that needs a "the caller set this" flag, which mGamma gets for free
        // by being an optional. Until then, binding a profile turns dithering
        // off quietly (#4331).
        const bool clearing_legacy =
            mCorrection != UncorrectedColor ||
            mTemperature != UncorrectedTemperature ||
            mGamma.has_value();
        if (!had_profile && clearing_legacy && !mWarnedLegacyCleared) {
            FL_WARN("Color profile clears legacy correction/temperature/gamma");
            ChannelEvents::instance().onColorProfileWarning(
                ColorProfileEvent{-1, {}, ColorProfileWarning::LegacyClearedByProfile});
            mWarnedLegacyCleared = true;
        }
        // The one call that makes the colour pipeline reachable. Everything
        // downstream goes through function pointers these install, so a
        // program that never gets here never references the pipeline and the
        // linker drops it -- about 3.5 KB of flash for sketches that do not
        // ask for colour management.
        installColorPipelineHooks();
        mColorProfile.mStorage = fl::make_shared<ColorProfileStorage>(profile);
        mColorProfile.mSource = source;
        mColorProfile.mGamut = gamut;
        mColorProfile.mRequested = true;
        mColorProfile.mUseGlobalSourceDefault = global_source;
        mCorrection = UncorrectedColor;
        mTemperature = UncorrectedTemperature;
        mGamma.reset();
        mDitherMode = DISABLE_DITHER;
        return true;
#endif
    }

References fl::ChromaCompress, clearColorProfile(), DISABLE_DITHER, finitePositive(), fl::FL_NO_EXCEPT, FL_UNUSED, FL_WARN, hasColorProfile(), fl::installColorPipelineHooks(), fl::ChannelEvents::instance(), fl::LegacyClearedByProfile, fl::adl_barrier::make_shared(), mCorrection, mDitherMode, mGamma, fl::ColorProfileBinding::mGamut, fl::ColorProfileBinding::mRequested, fl::ColorProfileBinding::mSource, fl::ColorProfileBinding::mStaticProfile, fl::ColorProfileBinding::mStorage, mTemperature, fl::ColorProfileBinding::mUseGlobalSourceDefault, fl::ChannelEvents::onColorProfileWarning, fl::colorimetric_response::RGB, fl::colorimetric_response::RGBW, fl::colorimetric_response::RGBWW, UncorrectedColor, UncorrectedTemperature, validChromaticity(), validPrimaries(), and validResponseLut().

Here is the call graph for this function: