color_picker_proxy.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2018-2020 Pascal Obry.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2019 Ulrich Pegelow.
    Copyright (C) 2020 Diederik Ter Rahe.
    Copyright (C) 2020 Harold le Clément de Saint-Marcq.
    Copyright (C) 2021 Dan Torop.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Philipp Lutz.
    Copyright (C) 2026 Aurélien PIERRE.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    darktable is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
 
/*
  This API encapsulates color-picker state ownership, cache sampling, and
  `DT_SIGNAL_CONTROL_PICKERDATA_READY` publication for darkroom.
 
  Module GUIs instantiate picker widgets here, then consume ready samples from
  the data-ready signal by querying the current picker state with
  `dt_iop_color_picker_get_ready_data()`.
*/
 
#include <gtk/gtk.h>
#include "develop/imageop.h"
#include "develop/develop.h"
 
typedef enum _iop_color_picker_kind_t
{
  DT_COLOR_PICKER_POINT = 0,
  // FIXME: s/AREA/BOX/
  DT_COLOR_PICKER_AREA,
  DT_COLOR_PICKER_POINT_AREA // allow the user to select between point and area
} dt_iop_color_picker_kind_t;
 
typedef struct dt_iop_color_picker_t
{
  // iop which contains this picker, or NULL if primary colorpicker
  dt_iop_module_t *module;
  dt_iop_color_picker_kind_t kind;
  dt_iop_colorspace_type_t picker_cst;
  GtkWidget *colorpick;
  // positions are associated with the current picker widget: will set
  // the picker request for the primary picker when this picker is
  // activated, and will remember the most recent picker position
  float pick_pos[2];
  dt_boundingbox_t pick_box;
  gboolean update_pending;
} dt_iop_color_picker_t;
 
 
gboolean dt_iop_color_picker_is_visible(const dt_develop_t *dev);
 
gboolean dt_iop_color_picker_is_active_module(const dt_iop_module_t *module);
 
/* reset current color picker unless keep is TRUE */
void dt_iop_color_picker_reset(dt_iop_module_t *module, gboolean keep);
 
/* sets the picker colorspace */
void dt_iop_color_picker_set_cst(dt_iop_module_t *module, const dt_iop_colorspace_type_t picker_cst);
 
/* returns the active picker colorspace (if any) */
dt_iop_colorspace_type_t dt_iop_color_picker_get_active_cst(dt_iop_module_t *module);
 
/* mark that the active picker geometry or selection changed and resample from cache if possible */
void dt_iop_color_picker_request_update(void);
 
int dt_iop_color_picker_get_ready_data(const dt_iop_module_t *module, GtkWidget **picker,
                                       struct dt_dev_pixelpipe_t **pipe,
                                       const struct dt_dev_pixelpipe_iop_t **piece);
 
gboolean dt_iop_color_picker_force_cache(const struct dt_dev_pixelpipe_t *pipe,
                                         const dt_iop_module_t *module);
 
/* global init: link signal */
void dt_iop_color_picker_init();
 
/* global cleanup */
void dt_iop_color_picker_cleanup();
 
/* link color picker to widget */
GtkWidget *dt_color_picker_new(dt_iop_module_t *module, dt_iop_color_picker_kind_t kind, GtkWidget *w);
 
/* link color picker to widget and initialize color picker color space with given value */
GtkWidget *dt_color_picker_new_with_cst(dt_iop_module_t *module, dt_iop_color_picker_kind_t kind, GtkWidget *w,
                                        const dt_iop_colorspace_type_t cst);
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on