Blender V5.3
BKE_customdata.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2006 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
9
10#pragma once
11
12#include <optional>
13
17#include "BLI_span.hh"
18#include "BLI_string_ref.hh"
19#include "BLI_sys_types.hh"
20#include "BLI_vector.hh"
21
22#include "BKE_volume_enums.hh"
23
25
26namespace blender {
27
28struct BlendDataReader;
29struct BlendWriter;
30struct BMesh;
32struct CustomData;
34struct ID;
35struct MeshPairRemap;
36
37namespace bke {
38enum class AttrDomain : int8_t;
39}
40
49#define UV_PINNED_NAME "pn"
50
57 int uv;
58 int pin;
59};
60
62#define BMUVOFFSETS_NONE {-1, -1}
63
66 unsigned char data[64];
67};
68
75
77#define ORIGINDEX_NONE -1
78
79/* Initializes a CustomData object with the same layer setup as source and
80 * memory space for totelem elements. mask must be an array of length
81 * CD_NUMTYPES elements, that indicate if a layer can be copied. */
82
93
98
99void customData_mask_layers__print(const CustomData_MeshMasks *mask);
100
101using cd_interp = void (*)(const void **sources, const float *weights, int count, void *dest);
102using cd_copy = void (*)(const void *source, void *dest, int count);
103using cd_set_default_value = void (*)(void *data, int count);
104using cd_free = void (*)(void *data, int count);
105using cd_validate = bool (*)(void *item, uint totitems, bool do_fixes);
106
111 const CustomData_MeshMasks *mask_src);
116 const CustomData_MeshMasks *mask_required);
117
122bool CustomData_layer_has_math(const CustomData *data, int layer_n);
123bool CustomData_layer_has_interp(const CustomData *data, int layer_n);
124
134
140void CustomData_data_copy_value(eCustomDataType type, const void *source, void *dest);
142
148 eCustomDataType type, const void *source, void *dest, int mixmode, float mixfactor);
149
155bool CustomData_data_equals(eCustomDataType type, const void *data1, const void *data2);
156void CustomData_data_initminmax(eCustomDataType type, void *min, void *max);
157void CustomData_data_dominmax(eCustomDataType type, const void *data, void *min, void *max);
158void CustomData_data_multiply(eCustomDataType type, void *data, float fac);
159void CustomData_data_add(eCustomDataType type, void *data1, const void *data2);
160
169void CustomData_init_from(const CustomData *source,
170 CustomData *dest,
172 int totelem);
180void CustomData_init_layout_from(const CustomData *source,
181 CustomData *dest,
183 eCDAllocType alloctype,
184 int totelem);
185
190
194bool CustomData_merge(const CustomData *source,
195 CustomData *dest,
197 int totelem);
202bool CustomData_merge_layout(const CustomData *source,
203 CustomData *dest,
205 eCDAllocType alloctype,
206 int totelem);
207
214 int old_size,
215 int new_size,
216 eCDAllocType alloctype = CD_CONSTRUCT);
217
224 CustomData *dest,
226 eCDAllocType alloctype,
227 BMesh *bm,
228 char htype);
229
236
241
248 eCustomDataType type,
249 eCDAllocType alloctype,
250 int totelem);
251
257 const void *data,
258 int totelem);
259
265 eCustomDataType type,
266 void *layer_data,
267 int totelem,
268 const ImplicitSharingInfo *sharing_info);
269
274 CustomData *data, eCustomDataType type, eCDAllocType alloctype, int totelem, StringRef name);
275
277 eCustomDataType type,
278 void *layer_data,
279 int totelem,
280 StringRef name,
281 const ImplicitSharingInfo *sharing_info);
282
291
299
305
311
318
324
338 const CustomData *source, CustomData *dest, int source_index, int dest_index, int count);
339void CustomData_copy_data_layer(const CustomData *source,
340 CustomData *dest,
341 int src_layer_index,
342 int dst_layer_index,
343 int src_index,
344 int dst_index,
345 int count);
347 const void *src_data,
348 void *dst_data,
349 int count);
350
355void CustomData_bmesh_copy_block(CustomData &data, void *src_block, void **dst_block);
356
387
390 const CustomData &dst,
391 eCustomDataMask mask_exclude = 0);
392
398 const BMCustomDataCopyMap &map,
399 const void *src_block,
400 void **dst_block);
401
406 CustomData *destination,
407 eCustomDataType type,
408 int source_index,
409 int destination_index,
410 int count);
411
416void CustomData_free_elem(CustomData *data, int index, int count);
417
428void CustomData_interp(const CustomData *source,
429 CustomData *dest,
430 const int *src_indices,
431 const float *weights,
432 int count,
433 int dest_index);
439 const void **src_blocks,
440 const float *weights,
441 int count,
442 void *dst_block_ofs,
443 int n);
445 CustomData *data, const void **src_blocks, const float *weights, int count, void *dst_block);
446
454void CustomData_swap_corners(CustomData *data, int index, const int *corner_indices);
455
462
467void *CustomData_get_for_write(CustomData *data, int index, eCustomDataType type, int totelem);
473 CustomData *data, eCustomDataType type, int index, int n, int totelem);
474
475/* BMesh Custom Data Functions.
476 * Should replace edit-mesh ones with these as well, due to more efficient memory alloc. */
477
478void *CustomData_bmesh_get(const CustomData *data, void *block, eCustomDataType type);
479void *CustomData_bmesh_get_n(const CustomData *data, void *block, eCustomDataType type, int n);
480
485void *CustomData_bmesh_get_layer_n(const CustomData *data, void *block, int n);
486
488const char *CustomData_get_layer_name(const CustomData *data, eCustomDataType type, int n);
489
494const void *CustomData_get_layer(const CustomData *data, eCustomDataType type);
496
501const void *CustomData_get_layer_n(const CustomData *data, eCustomDataType type, int n);
502void *CustomData_get_layer_n_for_write(CustomData *data, eCustomDataType type, int n, int totelem);
503
509 eCustomDataType type,
510 StringRef name);
512 eCustomDataType type,
513 StringRef name,
514 int totelem);
515
519
529
535
541
543 CustomData *data, void *block, eCustomDataType type, int n, const void *source);
544
550
557
562
563void CustomData_bmesh_set_default(CustomData *data, void **block);
564void CustomData_bmesh_free_block(CustomData *data, void **block);
565void CustomData_bmesh_alloc_block(CustomData *data, void **block);
566
571
573
592
595
600
606
607/* BMesh specific custom-data stuff. */
608
609void CustomData_bmesh_init_pool(CustomData *data, int totelem, char htype);
610
611/* External file storage */
612
614 CustomData *data, ID *id, eCustomDataType type, int totelem, const char *filepath);
615void CustomData_external_remove(CustomData *data, ID *id, eCustomDataType type, int totelem);
617
619 CustomData *data, StringRefNull basepath, ID *id, eCustomDataMask mask, int totelem, int free);
621 CustomData *data, StringRefNull basepath, ID *id, eCustomDataMask mask, int totelem);
623
624/* Mesh-to-mesh transfer data. */
625
627 void *dest,
628 const void **sources,
629 const float *weights,
630 int count,
631 float mix_factor);
632
633enum {
634 ME_VERT = 1 << 0,
635 ME_EDGE = 1 << 1,
636 ME_POLY = 1 << 2,
637 ME_LOOP = 1 << 3,
638};
639
641 int data_type = 0;
642 int mix_mode = 0;
643 float mix_factor = 0.0f;
645 const float *mix_weights = nullptr;
646
648 std::variant<const void *, GVArray> data_src;
650 std::variant<void *, GMutableVArraySpan> data_dst = nullptr;
652 std::function<void()> tag_modified_fn;
654 int data_src_n = 0;
656 int data_dst_n = 0;
658 size_t elem_size = 0;
659
661 size_t data_size = 0;
663 size_t data_offset = 0;
664
666 void *interp_data = nullptr;
667
669};
670
675
676/* .blend file I/O */
677
689 Vector<CustomDataLayer, 16> &layers_to_write);
690
696 Span<CustomDataLayer> layers_to_write,
697 int count,
698 eCustomDataMask cddata_mask,
699 ID *id);
700
701void CustomData_blend_read(BlendDataReader *reader, CustomData *data, int count);
702
704
705void CustomData_count_memory(const CustomData &data, int totelem, MemoryCounter &memory);
706
707#ifndef NDEBUG
708struct DynStr;
710void CustomData_debug_info_from_layers(const CustomData *data, const char *indent, DynStr *dynstr);
711#endif /* !NDEBUG */
712
713namespace bke {
714std::optional<VolumeGridType> custom_data_type_to_volume_grid_type(eCustomDataType type);
715std::optional<eCustomDataType> volume_grid_type_to_custom_data_type(VolumeGridType type);
716} // namespace bke
717} // namespace blender
btScalar max
#define layer
ccl_device_inline float2 mask(const MaskType mask, const float2 a)
void free(Subdiv *subdiv)
Definition subdiv.cc:192
std::optional< VolumeGridType > custom_data_type_to_volume_grid_type(eCustomDataType type)
std::optional< eCustomDataType > volume_grid_type_to_custom_data_type(VolumeGridType type)
BMesh Iterators.
void CustomData_MeshMasks_update(CustomData_MeshMasks *mask_dst, const CustomData_MeshMasks *mask_src)
Definition customdata.cc:89
bool CustomData_external_test(CustomData *data, eCustomDataType type)
int CustomData_get_offset(const CustomData *data, eCustomDataType type)
bool CustomData_layer_has_interp(const CustomData *data, int layer_n)
int CustomData_layertype_layers_max(eCustomDataType type)
bool CustomData_merge_layout(const CustomData *source, CustomData *dest, eCustomDataMask mask, eCDAllocType alloctype, int totelem)
void * CustomData_bmesh_get(const CustomData *data, void *block, eCustomDataType type)
void(*)(void *data, int count) cd_free
void CustomData_bmesh_alloc_block(CustomData *data, void **block)
const CustomData_MeshMasks CD_MASK_BAREMESH
void CustomData_bmesh_set_n(CustomData *data, void *block, eCustomDataType type, int n, const void *source)
bool CustomData_free_layer_active(CustomData *data, eCustomDataType type)
int CustomData_number_of_layers(const CustomData *data, eCustomDataType type)
void CustomData_swap_corners(CustomData *data, int index, const int *corner_indices)
void CustomData_copy_elements(eCustomDataType type, const void *src_data, void *dst_data, int count)
void CustomData_data_mix_value(eCustomDataType type, const void *source, void *dest, int mixmode, float mixfactor)
unsigned int uint
Definition BKE_text.h:55
void * CustomData_get_layer_n_for_write(CustomData *data, eCustomDataType type, int n, int totelem)
bool CustomData_free_layers(CustomData *data, eCustomDataType type)
void CustomData_realloc(CustomData *data, int old_size, int new_size, eCDAllocType alloctype=CD_CONSTRUCT)
void CustomData_free_elem(CustomData *data, int index, int count)
const void * CustomData_add_layer_named_with_data(CustomData *data, eCustomDataType type, void *layer_data, int totelem, StringRef name, const ImplicitSharingInfo *sharing_info)
bool CustomData_has_layer(const CustomData *data, eCustomDataType type)
void(*)(const void *source, void *dest, int count) cd_copy
void CustomData_external_add(CustomData *data, ID *id, eCustomDataType type, int totelem, const char *filepath)
BMCustomDataCopyMap CustomData_bmesh_copy_map_calc(const CustomData &src, const CustomData &dst, eCustomDataMask mask_exclude=0)
bool CustomData_has_interp(const CustomData *data)
void CustomData_bmesh_interp(CustomData *data, const void **src_blocks, const float *weights, int count, void *dst_block)
bool CustomData_MeshMasks_are_matching(const CustomData_MeshMasks *mask_ref, const CustomData_MeshMasks *mask_required)
Definition customdata.cc:99
int CustomData_get_n_offset(const CustomData *data, eCustomDataType type, int n)
const ImplicitSharingInfo * CustomData_make_layer_sharing_info(eCustomDataType type, const void *data, int totelem)
size_t CustomData_get_elem_size(const CustomDataLayer *layer)
bool CustomData_bmesh_merge_layout(const CustomData *source, CustomData *dest, eCustomDataMask mask, eCDAllocType alloctype, BMesh *bm, char htype)
bool CustomData_data_equals(eCustomDataType type, const void *data1, const void *data2)
int CustomData_get_layer_index(const CustomData *data, eCustomDataType type)
int CustomData_sizeof(eCustomDataType type)
bool CustomData_free_layer_named(CustomData *data, StringRef name)
void CustomData_bmesh_copy_block(CustomData &data, void *src_block, void **dst_block)
void(*)(const void **sources, const float *weights, int count, void *dest) cd_interp
void CustomData_copy_data(const CustomData *source, CustomData *dest, int source_index, int dest_index, int count)
int CustomData_get_active_layer_index(const CustomData *data, eCustomDataType type)
void CustomData_external_reload(CustomData *data, ID *id, eCustomDataMask mask, int totelem)
const void * CustomData_get_layer_named(const CustomData *data, eCustomDataType type, StringRef name)
uint64_t eCustomDataMask
const char * CustomData_get_render_layer_name(const CustomData *data, eCustomDataType type)
void * CustomData_get_n_for_write(CustomData *data, eCustomDataType type, int index, int n, int totelem)
void CustomData_interp(const CustomData *source, CustomData *dest, const int *src_indices, const float *weights, int count, int dest_index)
int CustomData_get_render_layer(const CustomData *data, eCustomDataType type)
void CustomData_set_layer_render_index(CustomData *data, eCustomDataType type, int n)
const void * CustomData_add_layer_with_data(CustomData *data, eCustomDataType type, void *layer_data, int totelem, const ImplicitSharingInfo *sharing_info)
void CustomData_bmesh_free_block(CustomData *data, void **block)
void(*)(void *data, int count) cd_set_default_value
void CustomData_bmesh_set_default(CustomData *data, void **block)
bool CustomData_layertype_is_singleton(eCustomDataType type)
void CustomData_init_layout_from(const CustomData *source, CustomData *dest, eCustomDataMask mask, eCDAllocType alloctype, int totelem)
void CustomData_data_set_default_value(eCustomDataType type, void *elem)
void CustomData_bmesh_interp_n(CustomData *data, const void **src_blocks, const float *weights, int count, void *dst_block_ofs, int n)
void CustomData_reset(CustomData *data)
void CustomData_blend_write(BlendWriter *writer, CustomData *data, Span< CustomDataLayer > layers_to_write, int count, eCustomDataMask cddata_mask, ID *id)
BMesh const char void * data
bool CustomData_bmesh_has_free(const CustomData *data)
void CustomData_data_copy_value(eCustomDataType type, const void *source, void *dest)
void CustomData_set_layer_flag(CustomData *data, eCustomDataType type, eCustomDataLayer_Flag flag)
void * CustomData_add_layer_named(CustomData *data, eCustomDataType type, eCDAllocType alloctype, int totelem, StringRef name)
int CustomData_get_offset_named(const CustomData *data, eCustomDataType type, StringRef name)
const CustomData_MeshMasks CD_MASK_BMESH
void CustomData_data_multiply(eCustomDataType type, void *data, float fac)
void CustomData_blend_write_prepare(CustomData &data, Vector< CustomDataLayer, 16 > &layers_to_write)
void CustomData_ensure_data_is_mutable(CustomDataLayer *layer, int totelem)
bool CustomData_free_layer(CustomData *data, eCustomDataType type, int index)
eCustomDataMask CD_TYPE_AS_MASK(eCustomDataType type)
const void * CustomData_get_layer(const CustomData *data, eCustomDataType type)
const char * CustomData_get_active_layer_name(const CustomData *data, eCustomDataType type)
int CustomData_number_of_anonymous_layers(const CustomData *data, eCustomDataType type)
bool CustomData_verify_versions(CustomData *data, int index)
bool CustomData_merge(const CustomData *source, CustomData *dest, eCustomDataMask mask, int totelem)
void CustomData_external_remove(CustomData *data, ID *id, eCustomDataType type, int totelem)
int CustomData_get_named_layer_index(const CustomData *data, eCustomDataType type, StringRef name)
void CustomData_set_layer_render(CustomData *data, eCustomDataType type, int n)
const void * CustomData_get_layer_n(const CustomData *data, eCustomDataType type, int n)
const CustomData_MeshMasks CD_MASK_DERIVEDMESH
void customData_mask_layers__print(const CustomData_MeshMasks *mask)
void CustomData_count_memory(const CustomData &data, int totelem, MemoryCounter &memory)
int CustomData_get_layer_index_n(const CustomData *data, eCustomDataType type, int n)
int CustomData_name_maxncpy_calc(StringRef name)
const CustomData_MeshMasks CD_MASK_MESH
void CustomData_free(CustomData *data)
const char * CustomData_layertype_name(eCustomDataType type)
void CustomData_update_typemap(CustomData *data)
const char * CustomData_get_layer_name(const CustomData *data, eCustomDataType type, int n)
int CustomData_get_render_layer_index(const CustomData *data, eCustomDataType type)
void * CustomData_get_layer_named_for_write(CustomData *data, eCustomDataType type, StringRef name, int totelem)
void * CustomData_bmesh_get_layer_n(const CustomData *data, void *block, int n)
void CustomData_bmesh_init_pool(CustomData *data, int totelem, char htype)
void CustomData_set_layer_active(CustomData *data, eCustomDataType type, int n)
void CustomData_set_layer_unique_name(CustomData *data, int index)
void CustomData_bmesh_free_block_data(CustomData *data, void *block)
int CustomData_get_active_layer(const CustomData *data, eCustomDataType type)
void(*)(const CustomDataTransferLayerMap *laymap, void *dest, const void **sources, const float *weights, int count, float mix_factor) cd_datatransfer_interp
void CustomData_copy_layer_type_data(const CustomData *source, CustomData *destination, eCustomDataType type, int source_index, int destination_index, int count)
void CustomData_debug_info_from_layers(const CustomData *data, const char *indent, DynStr *dynstr)
void CustomData_set_layer_active_index(CustomData *data, eCustomDataType type, int n)
bool(*)(void *item, uint totitems, bool do_fixes) cd_validate
void * CustomData_get_layer_for_write(CustomData *data, eCustomDataType type, int totelem)
void * CustomData_get_for_write(CustomData *data, int index, eCustomDataType type, int totelem)
bool CustomData_has_math(const CustomData *data)
void CustomData_ensure_layers_are_mutable(CustomData *data, int totelem)
int CustomData_get_named_layer_index_notype(const CustomData *data, StringRef name)
const CustomData_MeshMasks CD_MASK_EVERYTHING
void CustomData_copy_data_layer(const CustomData *source, CustomData *dest, int src_layer_index, int dst_layer_index, int src_index, int dst_index, int count)
bool CustomData_has_layer_named(const CustomData *data, eCustomDataType type, StringRef name)
void CustomData_external_read(CustomData *data, StringRefNull basepath, ID *id, eCustomDataMask mask, int totelem)
bool CustomData_set_layer_name(CustomData *data, eCustomDataType type, int n, StringRef name)
int CustomData_get_named_layer(const CustomData *data, eCustomDataType type, StringRef name)
const CustomData_MeshMasks CD_MASK_BAREMESH_ORIGINDEX
void CustomData_init_from(const CustomData *source, CustomData *dest, eCustomDataMask mask, int totelem)
void CustomData_data_initminmax(eCustomDataType type, void *min, void *max)
int CustomData_number_of_layers_typemask(const CustomData *data, eCustomDataMask mask)
void CustomData_set_only_copy(const CustomData *data, eCustomDataMask mask)
void CustomData_data_add(eCustomDataType type, void *data1, const void *data2)
bool CustomData_layer_has_math(const CustomData *data, int layer_n)
void CustomData_data_transfer(const MeshPairRemap *me_remap, CustomDataTransferLayerMap *laymap)
signed char int8_t
Definition BKE_text.h:76
void CustomData_data_dominmax(eCustomDataType type, const void *data, void *min, void *max)
bool CustomData_layertype_is_dynamic(eCustomDataType type)
void CustomData_external_write(CustomData *data, StringRefNull basepath, ID *id, eCustomDataMask mask, int totelem, int free)
void * CustomData_add_layer(CustomData *data, eCustomDataType type, eCDAllocType alloctype, int totelem)
void * CustomData_bmesh_get_n(const CustomData *data, void *block, eCustomDataType type, int n)
void CustomData_blend_read(BlendDataReader *reader, CustomData *data, int count)
#define min(a, b)
Definition sort.cc:38
Vector< TrivialDefault > trivial_defaults
Vector< TrivialCopy > trivial_copies
unsigned char data[64]
std::function< void()> tag_modified_fn
std::variant< const void *, GVArray > data_src
std::variant< void *, GMutableVArraySpan > data_dst