Files
test/source/blender/editors/include/UI_interface_icons.hh
Hans Goudey fa34992def Cleanup: Remove unnecessary includes from C++ data structure headers
The hash tables and vector blenlib headers were pulling many more
headers than they actually need, including the C base math header,
our C string API header, and the StringRef header. All of this
potentially slows down compilation and polutes autocomplete
with unrelated information.

Also remove the `ListBase` constructor for `Vector`. It wasn't used
much, and making it easy to use `ListBase` isn't worth it for the
same reasons mentioned above.

It turns out a lot of files depended on indirect includes of
`BLI_string.h` and `BLI_listbase.h`, so those are fixed here.

Pull Request: https://projects.blender.org/blender/blender/pulls/111801
2023-09-01 21:37:11 +02:00

134 lines
3.4 KiB
C++

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup editorui
*/
#pragma once
#include "BLI_sys_types.h"
/* Required for #eIconSizes. */
#include "DNA_ID_enums.h"
struct Collection;
struct ID;
struct ImBuf;
struct ListBase;
struct PointerRNA;
struct PreviewImage;
struct Scene;
struct bContext;
struct IconFile {
IconFile *next, *prev;
char filename[256]; /* FILE_MAXFILE size */
int index;
};
struct IconTextOverlay {
char text[5];
};
#define UI_NO_ICON_OVERLAY_TEXT NULL
#define ICON_DEFAULT_HEIGHT 16
#define ICON_DEFAULT_WIDTH 16
#define ICON_DEFAULT_HEIGHT_TOOLBAR 32
#define ICON_DEFAULT_HEIGHT_SCALE ((int)(UI_UNIT_Y * 0.8f))
#define ICON_DEFAULT_WIDTH_SCALE ((int)(UI_UNIT_X * 0.8f))
#define PREVIEW_DEFAULT_HEIGHT 128
enum eAlertIcon {
ALERT_ICON_WARNING = 0,
ALERT_ICON_QUESTION = 1,
ALERT_ICON_ERROR = 2,
ALERT_ICON_INFO = 3,
ALERT_ICON_BLENDER = 4,
ALERT_ICON_MAX,
};
ImBuf *UI_icon_alert_imbuf_get(eAlertIcon icon);
/**
* Resizable Icons for Blender
*/
void UI_icons_init();
/**
* Reload the textures for internal icons.
* This function will release the previous textures.
*/
void UI_icons_reload_internal_textures();
/**
* NOTE: returns unscaled by DPI.
*/
int UI_icon_get_width(int icon_id);
int UI_icon_get_height(int icon_id);
bool UI_icon_get_theme_color(int icon_id, unsigned char color[4]);
/**
* Render a #PreviewImage for the data block.
*
* Note that if an ID doesn't support jobs for preview creation, \a use_job will be ignored.
*/
void UI_icon_render_id(
const bContext *C, Scene *scene, ID *id, enum eIconSizes size, bool use_job);
/**
* Render the data block into the provided #PreviewImage.
*/
void UI_icon_render_id_ex(const bContext *C,
Scene *scene,
ID *id_to_render,
const enum eIconSizes size,
const bool use_job,
PreviewImage *r_preview_image);
/**
* Render size for preview images and icons
*/
int UI_icon_preview_to_render_size(enum eIconSizes size);
/**
* Draws icon with DPI scale factor.
*/
void UI_icon_draw(float x, float y, int icon_id);
void UI_icon_draw_alpha(float x, float y, int icon_id, float alpha);
void UI_icon_draw_preview(float x, float y, int icon_id, float aspect, float alpha, int size);
void UI_icon_draw_ex(float x,
float y,
int icon_id,
float aspect,
float alpha,
float desaturate,
const uchar mono_color[4],
bool mono_border,
const IconTextOverlay *text_overlay);
void UI_icons_free();
void UI_icons_free_drawinfo(void *drawinfo);
void UI_icon_draw_cache_begin();
void UI_icon_draw_cache_end();
ListBase *UI_iconfile_list();
int UI_iconfile_get_index(const char *filename);
PreviewImage *UI_icon_to_preview(int icon_id);
int UI_icon_from_rnaptr(const bContext *C, PointerRNA *ptr, int rnaicon, bool big);
int UI_icon_from_idcode(int idcode);
int UI_icon_from_library(const ID *id);
int UI_icon_from_object_mode(int mode);
int UI_icon_color_from_collection(const Collection *collection);
void UI_icon_text_overlay_init_from_count(IconTextOverlay *text_overlay,
const int icon_indicator_number);