Blender V5.3
blender::BlendWriter Struct Reference

#include <BLO_read_write.hh>

Public Member Functions

template<typename T>
void write_struct (const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_cast (const void *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_at_address (const void *address, const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_at_address_cast (const void *address, const void *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_array (const int64_t array_size, const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_array_cast (const int64_t array_size, const void *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_array_at_address (const int64_t array_size, const void *address, const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_struct_list (const ListBaseT< T > *list, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_id_struct (const void *id_address, const T *id, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_embedded_id_struct (const void *id_address, const T *id, BlendStructWriterTypedFn< T > fn=nullptr)
template<typename T>
void write_id_struct (const int filecode, const void *id_address, const T *id, BlendStructWriterTypedFn< T > fn=nullptr)
File Writing (Public)
bool is_undo () const
StringRefNull filepath () const
void write_struct_by_name (const char *struct_name, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_by_id (int struct_id, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_at_address_by_id (int struct_id, const void *address, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_at_address_by_id_with_filecode (int filecode, int struct_id, const void *address, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_array_by_name (const char *struct_name, int64_t array_size, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_array_by_id (int struct_id, int64_t array_size, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_array_at_address_by_id (int struct_id, int64_t array_size, const void *address, const void *data, BlendStructWriterFn fn=nullptr)
void write_struct_list_by_name (const char *struct_name, ListBase *list, BlendStructWriterFn fn=nullptr)
void write_struct_list_by_id (int struct_id, const ListBase *list, BlendStructWriterFn fn=nullptr)
void write_raw (size_t size_in_bytes, const void *data)
void write_char_array (int64_t num, const char *data)
void write_int8_array (int64_t num, const int8_t *data)
void write_int16_array (int64_t num, const int16_t *data)
void write_uint8_array (int64_t num, const uint8_t *data)
void write_int32_array (int64_t num, const int32_t *data)
void write_uint32_array (int64_t num, const uint32_t *data)
void write_float_array (int64_t num, const float *data)
void write_double_array (int64_t num, const double *data)
void write_float3_array (int64_t num, const float *data)
void write_pointer_array (int64_t num, const void *data)
void write_string (const char *data)
void write_shared (const void *data, size_t approximate_size_in_bytes, const ImplicitSharingInfo *sharing_info, FunctionRef< void()> write_fn)
int struct_id_by_name (const char *struct_name) const
void generated_pointer_tag (const void *data)

Public Attributes

WriteData * wd = nullptr

Detailed Description

Definition at line 132 of file BLO_read_write.hh.

Member Function Documentation

◆ filepath()

StringRefNull blender::BlendWriter::filepath ( ) const
Note
Should not be strictly needed outside of handling external Multires .btx files.

Definition at line 2382 of file writefile.cc.

Referenced by blender::CustomData_blend_write().

◆ generated_pointer_tag()

void blender::BlendWriter::generated_pointer_tag ( const void * data)

Needs to be called for all pointers that need to be 'stabilized' when writing undo steps, before any of these pointers are actually written (so typically at the very start of a write function)..

Typically required for data dynamically generated as part of the write process, see e.g. AttributeStorage::dna_attributes.

Definition at line 2367 of file writefile.cc.

References blender::BLI_assert(), blender::data, blender::get_address_id_for_undo(), and is_undo().

Referenced by blender::bke::attribute_storage_blend_write_prepare(), blender::bke::CurvesGeometry::blend_write_prepare(), blender::grease_pencil_blend_write(), blender::mesh_blend_write(), and blender::pointcloud_blend_write().

◆ is_undo()

◆ struct_id_by_name()

int blender::BlendWriter::struct_id_by_name ( const char * struct_name) const

◆ write_char_array()

void blender::BlendWriter::write_char_array ( int64_t num,
const char * data )

Write typed arrays.

Definition at line 2302 of file writefile.cc.

References blender::data, blender::num, and write_raw().

Referenced by blender::console_space_blend_write(), blender::IDP_WriteString(), and blender::object_blend_write().

◆ write_double_array()

void blender::BlendWriter::write_double_array ( int64_t num,
const double * data )

Definition at line 2337 of file writefile.cc.

References blender::data, blender::num, and write_raw().

Referenced by blender::IDP_WriteArray(), and blender::write_ui_data().

◆ write_embedded_id_struct()

template<typename T>
void blender::BlendWriter::write_embedded_id_struct ( const void * id_address,
const T * id,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_float3_array()

void blender::BlendWriter::write_float3_array ( int64_t num,
const float * data )

◆ write_float_array()

◆ write_id_struct() [1/2]

◆ write_id_struct() [2/2]

template<typename T>
void blender::BlendWriter::write_id_struct ( const void * id_address,
const T * id,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_int16_array()

void blender::BlendWriter::write_int16_array ( int64_t num,
const int16_t * data )

Definition at line 2312 of file writefile.cc.

References blender::data, blender::num, and write_raw().

Referenced by blender::bke::write_array_data().

◆ write_int32_array()

void blender::BlendWriter::write_int32_array ( int64_t num,
const int32_t * data )

◆ write_int8_array()

void blender::BlendWriter::write_int8_array ( int64_t num,
const int8_t * data )

◆ write_pointer_array()

◆ write_raw()

void blender::BlendWriter::write_raw ( size_t size_in_bytes,
const void * data )

Write raw data.

Warning
Avoid using this method if possible. There are only a very few cases in current code where it is actually needed (e.g. the ShapeKey's data, since its items size varies depending on the type of geometry owning it, see #shapekey_blend_write).
Data written with this call have no type information attached to them in the blend-file. The main consequence is that there will be no handling of endianness conversion for them in readfile code. Basic typed array methods (like write_int8_array etc.) also use this internally, but if their matching read function is used to load the data (like BLO_read_array), the read function will take care of endianness conversion.

Definition at line 2297 of file writefile.cc.

References blender::BLO_CODE_DATA, blender::data, and blender::writedata().

Referenced by blender::shapekey_blend_write(), write_char_array(), write_double_array(), write_float3_array(), write_float_array(), write_int16_array(), write_int32_array(), write_int8_array(), write_string(), write_uint32_array(), and write_uint8_array().

◆ write_shared()

void blender::BlendWriter::write_shared ( const void * data,
size_t approximate_size_in_bytes,
const ImplicitSharingInfo * sharing_info,
FunctionRef< void()> write_fn )

Check if the data can be written more efficiently by making use of implicit-sharing. If yes, the user count of the sharing-info is increased making the data immutable. The provided callback should serialize the potentially shared data. It is only called when necessary.

Parameters
approximate_size_in_bytesUsed to be able to approximate how large the undo step is in total.
write_fnUse the #BlendWrite to serialize the potentially shared data.

Definition at line 2387 of file writefile.cc.

References blender::ImplicitSharingInfo::add_user(), blender::data, blender::get_address_id_int(), is_undo(), blender::MemFile::shared_storage, blender::MemFileSharedStorage::sharing_info_by_address_id, blender::MemFile::size, and blender::ImplicitSharingInfo::strong_users().

Referenced by blender::BKE_packedfile_blend_write(), blender::bke::CurvesGeometry::blend_write(), blender::blend_write(), blender::CustomData_blend_write(), blender::mesh_blend_write(), and blender::bke::write_shared_array().

◆ write_string()

void blender::BlendWriter::write_string ( const char * data)

Write a null terminated string.

Definition at line 2360 of file writefile.cc.

References blender::data, and write_raw().

Referenced by blender::BKE_animdata_blend_write(), blender::BKE_asset_catalog_path_list_blend_write(), blender::BKE_asset_metadata_write(), blender::BKE_asset_weak_reference_write(), blender::BKE_collection_blend_write_nolib(), blender::BKE_constraint_blend_write(), blender::BKE_fcurve_blend_write_data(), blender::BKE_id_blend_write(), blender::BKE_keyingsets_blend_write(), blender::BKE_paint_blend_write(), blender::BKE_preferences_asset_library_write_data(), blender::BKE_preferences_extension_repo_write_data(), blender::BKE_viewer_path_blend_write(), blender::bke::AttributeStorage::blend_write(), blender::blend_write(), blender::nodes::BakeItemsAccessor::blend_write_item(), blender::nodes::CaptureAttributeItemsAccessor::blend_write_item(), blender::nodes::ClosureInputItemsAccessor::blend_write_item(), blender::nodes::ClosureOutputItemsAccessor::blend_write_item(), blender::nodes::ClosureToListItemsAccessor::blend_write_item(), blender::nodes::CombineBundleItemsAccessor::blend_write_item(), blender::nodes::EvaluateClosureInputItemsAccessor::blend_write_item(), blender::nodes::EvaluateClosureOutputItemsAccessor::blend_write_item(), blender::nodes::FieldToGridItemsAccessor::blend_write_item(), blender::nodes::FieldToListItemsAccessor::blend_write_item(), blender::nodes::FileOutputItemsAccessor::blend_write_item(), blender::nodes::ForeachGeometryElementGenerationItemsAccessor::blend_write_item(), blender::nodes::ForeachGeometryElementInputItemsAccessor::blend_write_item(), blender::nodes::ForeachGeometryElementMainItemsAccessor::blend_write_item(), blender::nodes::FormatStringItemsAccessor::blend_write_item(), blender::nodes::GeoViewerItemsAccessor::blend_write_item(), blender::nodes::MenuSwitchItemsAccessor::blend_write_item(), blender::nodes::RasterizePointsItemsAccessor::blend_write_item(), blender::nodes::RaycastSampleAttributeItemsAccessor::blend_write_item(), blender::nodes::RepeatItemsAccessor::blend_write_item(), blender::nodes::SeparateBundleItemsAccessor::blend_write_item(), blender::nodes::SimulationItemsAccessor::blend_write_item(), blender::camera_blend_write(), blender::curve_blend_write(), blender::curves_blend_write(), blender::bke::node_interface::item_types::item_write_data(), blender::mesh_blend_write(), blender::nodes::node_composite_file_output_cc::node_blend_write(), blender::nodes::node_fn_input_string_cc::node_blend_write(), blender::bke::node_blend_write_storage(), blender::node_comment_blend_write(), blender::bke::node_tree_blend_write(), blender::ed::asset::shelf::settings_blend_write(), blender::ed::spreadsheet::spreadsheet_blend_write(), blender::ed::spreadsheet::spreadsheet_column_blend_write(), blender::ed::spreadsheet::spreadsheet_column_id_blend_write(), blender::seq::strip_write_data_cb(), blender::text_blend_write(), blender::write_area(), blender::ed::spreadsheet::write_bundle_path(), blender::write_layer(), blender::write_layer_tree_group(), blender::write_panel_list(), and blender::write_ui_data().

◆ write_struct()

template<typename T>
void blender::BlendWriter::write_struct ( const T * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

Definition at line 236 of file BLO_read_write.hh.

References blo_blend_struct_writer_fn_typed, blender::data, blender::dna::sdna_struct_id_get(), T, and write_struct_by_id().

Referenced by blender::bke::action_blend_write(), blender::BKE_animdata_blend_write(), blender::BKE_asset_catalog_path_list_blend_write(), blender::BKE_asset_metadata_write(), blender::BKE_asset_weak_reference_write(), blender::BKE_collection_blend_write_nolib(), blender::BKE_constraint_blend_write(), blender::BKE_curvemapping_blend_write(), blender::BKE_curveprofile_blend_write(), blender::BKE_defbase_blend_write(), blender::BKE_fcurve_blend_write_data(), blender::BKE_id_blend_write(), blender::BKE_keyingsets_blend_write(), blender::BKE_lightprobe_cache_blend_write(), blender::BKE_modifier_blend_write(), blender::BKE_nla_blend_write(), blender::BKE_packedfile_blend_write(), blender::BKE_paint_blend_write(), blender::BKE_particle_system_blend_write(), blender::BKE_pose_blend_write(), blender::BKE_previewimg_blend_write(), blender::BKE_ptcache_blend_write(), blender::BKE_screen_area_map_blend_write(), blender::BKE_time_markers_blend_write(), blender::BKE_view_layer_blend_write(), blender::BKE_viewer_path_blend_write(), blender::bke::AttributeStorage::blend_write(), blender::bke::motionpath::blend_write(), blender::blend_write(), blender::blend_write(), blender::brush_blend_write(), blender::cache_file_blend_write(), blender::camera_blend_write(), blender::console_space_blend_write(), blender::curve_blend_write(), blender::CustomData_blend_write(), blender::file_space_blend_write(), blender::graph_space_blend_write(), blender::greasepencil_blend_write(), blender::idp_blend_write_recurse(), blender::image_blend_write(), blender::linestyle_blend_write(), blender::mask_blend_write(), blender::material_blend_write(), blender::metaball_blend_write(), blender::seq::modifier_blend_write(), blender::movieclip_blend_write(), blender::nla_space_blend_write(), blender::bke::node_blend_write_storage(), blender::ed::space_node::node_space_blend_write(), blender::bke::node_tree_blend_write(), blender::object_blend_write(), blender::particle_settings_blend_write(), blender::ed::asset::shelf::regiondata_blend_write(), blender::scene_blend_write(), blender::ed::asset::shelf::settings_blend_write(), blender::shapekey_blend_write(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::bke::node_interface::socket_types::socket_data_write_impl(), blender::ed::spreadsheet::spreadsheet_blend_write(), blender::ed::spreadsheet::spreadsheet_column_blend_write(), blender::ed::spreadsheet::spreadsheet_column_id_blend_write(), blender::ed::spreadsheet::spreadsheet_table_blend_write(), blender::ed::spreadsheet::spreadsheet_table_id_blend_write(), blender::seq::strip_write_data_cb(), blender::text_blend_write(), blender::texture_blend_write(), blender::view3d_space_blend_write(), blender::window_manager_blend_write(), blender::world_blend_write(), blender::write_area(), blender::write_boid_state(), blender::write_bone(), blender::write_bone_collection(), blender::bke::write_channelbag(), blender::write_drawing_array(), blender::write_keymapitem(), blender::write_layer(), blender::write_layer_collections(), blender::write_layer_tree_group(), blender::write_linestyle_color_modifiers(), blender::write_moviePlaneTracks(), blender::write_movieTracks(), blender::bke::write_node_socket(), blender::write_panel_list(), blender::write_region(), blender::write_uilist(), and blender::write_userdef().

◆ write_struct_array()

◆ write_struct_array_at_address()

template<typename T>
void blender::BlendWriter::write_struct_array_at_address ( const int64_t array_size,
const void * address,
const T * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_struct_array_at_address_by_id()

void blender::BlendWriter::write_struct_array_at_address_by_id ( int struct_id,
int64_t array_size,
const void * address,
const void * data,
BlendStructWriterFn fn = nullptr )

◆ write_struct_array_by_id()

void blender::BlendWriter::write_struct_array_by_id ( int struct_id,
int64_t array_size,
const void * data,
BlendStructWriterFn fn = nullptr )

◆ write_struct_array_by_name()

void blender::BlendWriter::write_struct_array_by_name ( const char * struct_name,
int64_t array_size,
const void * data,
BlendStructWriterFn fn = nullptr )

◆ write_struct_array_cast()

template<typename T>
void blender::BlendWriter::write_struct_array_cast ( const int64_t array_size,
const void * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_struct_at_address()

template<typename T>
void blender::BlendWriter::write_struct_at_address ( const void * address,
const T * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_struct_at_address_by_id()

void blender::BlendWriter::write_struct_at_address_by_id ( int struct_id,
const void * address,
const void * data,
BlendStructWriterFn fn = nullptr )

◆ write_struct_at_address_by_id_with_filecode()

void blender::BlendWriter::write_struct_at_address_by_id_with_filecode ( int filecode,
int struct_id,
const void * address,
const void * data,
BlendStructWriterFn fn = nullptr )

◆ write_struct_at_address_cast()

template<typename T>
void blender::BlendWriter::write_struct_at_address_cast ( const void * address,
const void * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_struct_by_id()

◆ write_struct_by_name()

◆ write_struct_cast()

template<typename T>
void blender::BlendWriter::write_struct_cast ( const void * data,
BlendStructWriterTypedFn< T > fn = nullptr )
inline

◆ write_struct_list()

◆ write_struct_list_by_id()

void blender::BlendWriter::write_struct_list_by_id ( int struct_id,
const ListBase * list,
BlendStructWriterFn fn = nullptr )

Definition at line 2272 of file writefile.cc.

References blender::BLO_CODE_DATA, and blender::writelist_nr().

Referenced by write_struct_list(), and write_struct_list_by_name().

◆ write_struct_list_by_name()

void blender::BlendWriter::write_struct_list_by_name ( const char * struct_name,
ListBase * list,
BlendStructWriterFn fn = nullptr )

◆ write_uint32_array()

void blender::BlendWriter::write_uint32_array ( int64_t num,
const uint32_t * data )

◆ write_uint8_array()

void blender::BlendWriter::write_uint8_array ( int64_t num,
const uint8_t * data )

Member Data Documentation

◆ wd

WriteData* blender::BlendWriter::wd = nullptr

Definition at line 133 of file BLO_read_write.hh.

Referenced by blender::write_userdef().


The documentation for this struct was generated from the following files: