Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / include / ED_image.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup editors
21  */
22
23 #ifndef __ED_IMAGE_H__
24 #define __ED_IMAGE_H__
25
26 struct ARegion;
27 struct ImBuf;
28 struct Image;
29 struct ImageUser;
30 struct Scene;
31 struct SpaceImage;
32 struct ToolSettings;
33 struct ViewLayer;
34 struct bContext;
35 struct wmWindowManager;
36
37 /* image_edit.c, exported for transform */
38 struct Image *ED_space_image(struct SpaceImage *sima);
39 void          ED_space_image_set(struct Main *bmain, struct SpaceImage *sima, struct Scene *scene, struct Object *obedit, struct Image *ima);
40 struct Mask  *ED_space_image_get_mask(struct SpaceImage *sima);
41 void          ED_space_image_set_mask(struct bContext *C, struct SpaceImage *sima, struct Mask *mask);
42
43 bool ED_space_image_color_sample(struct SpaceImage *sima, struct ARegion *ar, int mval[2], float r_col[3]);
44 struct ImBuf *ED_space_image_acquire_buffer(struct SpaceImage *sima, void **r_lock);
45 void ED_space_image_release_buffer(struct SpaceImage *sima, struct ImBuf *ibuf, void *lock);
46 bool ED_space_image_has_buffer(struct SpaceImage *sima);
47
48 void ED_space_image_get_size(struct SpaceImage *sima, int *width, int *height);
49 void ED_space_image_get_size_fl(struct SpaceImage *sima, float size[2]);
50 void ED_space_image_get_aspect(struct SpaceImage *sima, float *aspx, float *aspy);
51 void ED_space_image_get_zoom(struct SpaceImage *sima, struct ARegion *ar, float *zoomx, float *zoomy);
52 void ED_space_image_get_uv_aspect(struct SpaceImage *sima, float *aspx, float *aspy);
53
54 void ED_space_image_scopes_update(const struct bContext *C, struct SpaceImage *sima, struct ImBuf *ibuf, bool use_view_settings);
55
56 void ED_space_image_paint_update(struct Main *bmain, struct wmWindowManager *wm, struct Scene *scene);
57 void ED_space_image_uv_sculpt_update(struct Main *bmain, struct wmWindowManager *wm, struct Scene *scene);
58
59 void ED_image_get_uv_aspect(struct Image *ima, struct ImageUser *iuser, float *aspx, float *aspy);
60 void ED_image_mouse_pos(struct SpaceImage *sima, struct ARegion *ar, const int mval[2], float co[2]);
61 void ED_image_point_pos(struct SpaceImage *sima, struct ARegion *ar, float x, float y, float *xr, float *yr);
62 void ED_image_point_pos__reverse(struct SpaceImage *sima, struct ARegion *ar, const float co[2], float r_co[2]);
63 bool ED_image_slot_cycle(struct Image *image, int direction);
64
65 bool ED_space_image_show_render(struct SpaceImage *sima);
66 bool ED_space_image_show_paint(struct SpaceImage *sima);
67 bool ED_space_image_show_uvedit(struct SpaceImage *sima, struct Object *obedit);
68
69 bool ED_space_image_paint_curve(const struct bContext *C);
70
71 bool ED_space_image_check_show_maskedit(struct SpaceImage *sima, struct ViewLayer *view_layer);
72 bool ED_space_image_maskedit_poll(struct bContext *C);
73 bool ED_space_image_maskedit_mask_poll(struct bContext *C);
74
75 void ED_image_draw_info(struct Scene *scene, struct ARegion *ar, bool color_manage, bool use_default_view, int channels, int x, int y,
76                         const unsigned char cp[4], const float fp[4], const float linearcol[4], int *zp, float *zpf);
77
78 bool ED_space_image_show_cache(struct SpaceImage *sima);
79
80 #endif /* __ED_IMAGE_H__ */