dev_viewport.h

Go to the documentation of this file.

/*
    This file is part of Ansel.
    Copyright (C) 2026 Aurélien Pierre.
 
    Ansel is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    Ansel 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DEVELOP_DEV_VIEWPORT_H
#define DT_DEVELOP_DEV_VIEWPORT_H
 
#include <glib.h>
#include <stdint.h>
 
#include "system/atomic.h"
 
struct dt_develop_t;
 
typedef struct dt_dev_viewport_state_t
{
  int32_t widget_width, widget_height;
 
  int32_t border_size;
 
  int32_t box_width, box_height;
 
  float scaling;
 
  float center_x, center_y;
 
  gboolean configured;
} dt_dev_viewport_state_t;
 
typedef struct dt_dev_viewport_t
{
  dt_atomic_uint64 generation;
  dt_dev_viewport_state_t state;
} dt_dev_viewport_t;
 
dt_dev_viewport_t *dt_dev_viewport_new(void);
void dt_dev_viewport_free(dt_dev_viewport_t *viewport);
 
dt_dev_viewport_state_t dt_dev_viewport_get(const struct dt_develop_t *dev);
 
dt_dev_viewport_state_t dt_dev_viewport_neutral(void);
 
gboolean dt_dev_viewport_exists(const struct dt_develop_t *dev);
 
/* Single-field readers, one line each, for the sites that want one number. */
float dt_dev_viewport_scaling(const struct dt_develop_t *dev);
float dt_dev_viewport_center_x(const struct dt_develop_t *dev);
float dt_dev_viewport_center_y(const struct dt_develop_t *dev);
int32_t dt_dev_viewport_box_width(const struct dt_develop_t *dev);
int32_t dt_dev_viewport_box_height(const struct dt_develop_t *dev);
int32_t dt_dev_viewport_widget_width(const struct dt_develop_t *dev);
int32_t dt_dev_viewport_widget_height(const struct dt_develop_t *dev);
int32_t dt_dev_viewport_border_size(const struct dt_develop_t *dev);
gboolean dt_dev_viewport_configured(const struct dt_develop_t *dev);
 
/* ---- mutators ----
 *
 * GUI thread only. Each returns TRUE when the published state actually changed, so a caller
 * can decide whether to trigger a recompute without comparing fields itself. Each publishes
 * once, as a whole state, so no reader can observe a half-applied change; and each applies its
 * own clamps BEFORE publishing, so no value the clamp would take back is ever visible.
 *
 * A dev with no viewport accepts every call and does nothing.
 */
 
gboolean dt_dev_viewport_set_widget_size(struct dt_develop_t *dev, int32_t widget_width,
                                         int32_t widget_height);
 
gboolean dt_dev_viewport_set_border(struct dt_develop_t *dev, int32_t border_size);
 
gboolean dt_dev_viewport_set_box(struct dt_develop_t *dev, int32_t box_width, int32_t box_height);
 
gboolean dt_dev_viewport_set_center(struct dt_develop_t *dev, float center_x, float center_y);
 
gboolean dt_dev_viewport_set_scaling(struct dt_develop_t *dev, float scaling);
 
void dt_dev_viewport_reset(struct dt_develop_t *dev);
 
#endif // DT_DEVELOP_DEV_VIEWPORT_H
 
// 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