Ansel 0.0
A darktable fork - bloat + design vision
Loading...
Searching...
No Matches
masks_group.h
Go to the documentation of this file.
1/*
2 This file is part of Ansel,
3 Copyright (C) 2026 Aurélien PIERRE.
4
5 Ansel is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 Ansel is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with Ansel. If not, see <http://www.gnu.org/licenses/>.
17*/
18
48#ifndef DT_DEVELOP_MASKS_MASKS_GROUP_H
49#define DT_DEVELOP_MASKS_MASKS_GROUP_H
50
51#include "develop/masks_types.h"
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57struct dt_develop_t;
58struct dt_masks_form_t;
59struct dt_iop_module_t;
60
72
94 dt_masks_member_t *out, guint out_max);
95
113
137
152dt_masks_result_t dt_masks_group_get_member(struct dt_develop_t *dev, int group_id, int formid,
154
165dt_masks_result_t dt_masks_group_contains(struct dt_develop_t *dev, int container_id, int needle_id);
166
180dt_masks_result_t dt_masks_group_covers_shapes(struct dt_develop_t *dev, int group_id, int target_id,
181 gboolean *has_shapes);
182
197dt_masks_result_t dt_masks_group_first_use(struct dt_develop_t *dev, int root_id, int formid,
198 int *holder_id, guint *index,
199 char *holder_name, size_t holder_name_size);
200
212int dt_masks_group_find_holder(struct dt_develop_t *dev, int formid);
213
229guint dt_masks_group_list(struct dt_develop_t *dev, dt_masks_form_info_t *out, guint out_max);
230
252 float opacity, dt_masks_member_t *out);
253
269
283 struct dt_iop_module_t *module);
284
285#ifdef __cplusplus
286}
287#endif
288
289#endif // DT_DEVELOP_MASKS_MASKS_GROUP_H
290
291// clang-format off
292// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
293// vim: shiftwidth=2 expandtab tabstop=2 cindent
294// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
295// clang-format on
const dt_colormatrix_t dt_aligned_pixel_t out
_lib_location_type_t type
Definition location.c:1
dt_masks_result_t dt_masks_group_contains(struct dt_develop_t *dev, int container_id, int needle_id)
Whether container_id holds needle_id, at any depth (and trivially when they are the same id).
Definition masks.c:1942
const char * dt_masks_type_name(dt_masks_type_t type)
The stable, untranslated token for a shape kind: circle, ellipse, polygon, brush, gradient,...
Definition masks.c:1767
guint dt_masks_group_copy_members(const struct dt_masks_form_t *group, dt_masks_member_t *out, guint out_max)
Copy a group's membership rows, in order, into caller storage.
dt_masks_result_t dt_masks_group_set_member_operation(struct dt_develop_t *dev, int group_id, int formid, dt_masks_state_t operation, dt_masks_member_t *out)
Set a group member's combination operator, or toggle its inversion.
Definition masks.c:1785
gboolean dt_masks_form_get_info(const struct dt_masks_form_t *form, dt_masks_form_info_t *out)
Describe a form: identity, kind, and – for a group – how many members it holds.
gchar * dt_masks_group_name_for_module(const struct dt_iop_module_t *module)
The name a module's own mask group carries: "Group <module>", after the module's multi-instance name ...
dt_masks_result_t dt_masks_group_first_use(struct dt_develop_t *dev, int root_id, int formid, int *holder_id, guint *index, char *holder_name, size_t holder_name_size)
Where the mask rooted at root_id FIRST applies formid.
Definition masks.c:2013
dt_masks_result_t dt_masks_group_covers_shapes(struct dt_develop_t *dev, int group_id, int target_id, gboolean *has_shapes)
Whether every shape group_id ultimately holds is also held by target_id.
Definition masks.c:1973
dt_masks_result_t dt_masks_group_set_name_from_module(struct dt_develop_t *dev, int group_id, struct dt_iop_module_t *module)
Name a group after the module that renders it, by id.
Definition masks.c:1808
dt_masks_result_t dt_masks_group_set_member_opacity(struct dt_develop_t *dev, int group_id, int formid, float opacity, dt_masks_member_t *out)
Set a group member's opacity.
Definition masks.c:2029
guint dt_masks_group_list(struct dt_develop_t *dev, dt_masks_form_info_t *out, guint out_max)
Describe every group of the live list, in dev->forms order, into caller storage.
Definition masks.c:1887
dt_masks_result_t dt_masks_group_get_member(struct dt_develop_t *dev, int group_id, int formid, dt_masks_member_t *out)
Read one group member by identity.
Definition masks.c:1909
int dt_masks_group_find_holder(struct dt_develop_t *dev, int formid)
Which group references formid, searching every group in dev->forms depth-first.
Definition masks.c:1878
The masks vocabulary: the enumerations a caller needs to NAME a shape or an operation,...
dt_masks_state_t
Definition masks_types.h:87
dt_masks_type_t
Definition masks_types.h:62
dt_masks_result_t
What a request that may change the masks model did.
struct dt_develop_t * dev
Definition imageop.h:311
What a form IS, BY VALUE: identity, kind, and – for a group – how many members.
One shape's membership of one group, BY VALUE.