Blender V4.3
gpu_vertex_format.cc File Reference
#include "GPU_vertex_format.hh"
#include "GPU_capabilities.hh"
#include "gpu_shader_create_info.hh"
#include "gpu_shader_private.hh"
#include "gpu_vertex_format_private.hh"
#include <cstddef>
#include <cstring>
#include "BLI_ghash.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"

Go to the source code of this file.

Macros

#define PACK_DEBUG   0
 

Functions

void GPU_vertformat_clear (GPUVertFormat *format)
 
void GPU_vertformat_copy (GPUVertFormat *dest, const GPUVertFormat &src)
 
static uint comp_size (GPUVertCompType type)
 
static uint attr_size (const GPUVertAttr *a)
 
static uint attr_align (const GPUVertAttr *a, uint minimum_stride)
 
uint vertex_buffer_size (const GPUVertFormat *format, uint vertex_len)
 
static uchar copy_attr_name (GPUVertFormat *format, const char *name)
 
uint GPU_vertformat_attr_add (GPUVertFormat *format, const char *name, GPUVertCompType comp_type, uint comp_len, GPUVertFetchMode fetch_mode)
 
void GPU_vertformat_alias_add (GPUVertFormat *format, const char *alias)
 
void GPU_vertformat_multiload_enable (GPUVertFormat *format, int load_count)
 
int GPU_vertformat_attr_id_get (const GPUVertFormat *format, const char *name)
 
void GPU_vertformat_attr_rename (GPUVertFormat *format, int attr_id, const char *new_name)
 
static void safe_bytes (char out[11], const char data[8])
 
void GPU_vertformat_safe_attr_name (const char *attr_name, char *r_safe_name, uint)
 
void GPU_vertformat_deinterleave (GPUVertFormat *format)
 
uint padding (uint offset, uint alignment)
 
static void VertexFormat_pack_impl (GPUVertFormat *format, uint minimum_stride)
 
void VertexFormat_pack (GPUVertFormat *format)
 
void VertexFormat_texture_buffer_pack (GPUVertFormat *format)
 
static uint component_size_get (const Type gpu_type)
 
static void recommended_fetch_mode_and_comp_type (Type gpu_type, GPUVertCompType *r_comp_type, GPUVertFetchMode *r_fetch_mode)
 
void GPU_vertformat_from_shader (GPUVertFormat *format, const GPUShader *shader)
 

Detailed Description

GPU vertex format

Definition in file gpu_vertex_format.cc.

Macro Definition Documentation

◆ PACK_DEBUG

#define PACK_DEBUG   0

Definition at line 25 of file gpu_vertex_format.cc.

Function Documentation

◆ attr_align()

static uint attr_align ( const GPUVertAttr * a,
uint minimum_stride )
static

Definition at line 74 of file gpu_vertex_format.cc.

References comp_size(), GPU_COMP_I10, and max_ii().

Referenced by VertexFormat_pack_impl().

◆ attr_size()

◆ comp_size()

static uint comp_size ( GPUVertCompType type)
static

Definition at line 57 of file gpu_vertex_format.cc.

References GPU_COMP_F32.

Referenced by attr_align(), and attr_size().

◆ component_size_get()

static uint component_size_get ( const Type gpu_type)
static

Definition at line 376 of file gpu_vertex_format.cc.

Referenced by GPU_vertformat_from_shader().

◆ copy_attr_name()

static uchar copy_attr_name ( GPUVertFormat * format,
const char * name )
static

◆ GPU_vertformat_alias_add()

◆ GPU_vertformat_attr_add()

uint GPU_vertformat_attr_add ( GPUVertFormat * format,
const char * name,
GPUVertCompType comp_type,
uint comp_len,
GPUVertFetchMode fetch_mode )

Definition at line 124 of file gpu_vertex_format.cc.

References attr_id, attr_size(), GPUVertAttr::comp_len, GPUVertAttr::comp_type, copy_attr_name(), ELEM, GPUVertAttr::fetch_mode, GPU_COMP_F32, GPU_COMP_I10, GPU_FETCH_FLOAT, GPU_FETCH_INT_TO_FLOAT_UNIT, GPU_VERT_ATTR_MAX_LEN, GPU_VERT_FORMAT_MAX_NAMES, GPUVertAttr::name_len, GPUVertAttr::names, GPUVertAttr::offset, and GPUVertAttr::size.

Referenced by acf_generic_channel_backdrop(), acf_generic_dataexpand_backdrop(), blender::draw::alloc_final_points_vbo(), ANIM_channel_draw(), ANIM_channel_draw_widgets(), ANIM_draw_action_framerange(), ANIM_draw_cfra(), ANIM_draw_framerange(), ANIM_draw_previewrange(), annotation_draw_eraser(), annotation_draw_stabilizer(), annotation_draw_stroke_2d(), annotation_draw_stroke_3d(), annotation_draw_stroke_buffer(), annotation_draw_stroke_point(), arrow_draw_geom(), batch_screen_edges_get(), blf_batch_draw_init(), brush_drawcursor(), blender::draw::build_poly_other_map_vbo(), button2d_draw_intern(), button2d_geom_draw_backdrop(), cage2d_draw_box_corners(), cage2d_draw_box_interaction(), cage2d_draw_circle_wire(), cage2d_draw_rect_corner_handles(), cage2d_draw_rect_edge_handles(), cage2d_draw_rect_wire(), cage3d_draw_box_corners(), cage3d_draw_box_interaction(), cage3d_draw_circle_handles(), cage3d_draw_circle_wire(), blender::draw::calc_final_indices(), channel_list_draw_keys(), circle_draw_rgb(), clip_draw_dopesheet_channels(), clip_draw_dopesheet_main(), clip_draw_graph(), clip_draw_sfra_efra(), console_textview_draw_cursor(), blender::draw::create_curve_offsets_vbos(), blender::draw::create_points_position_time_vbo(), cursor_box_draw(), blender::draw::curve_create_attribute(), blender::draw::curve_create_curves_pos(), blender::draw::curve_create_edit_curves_nor(), blender::draw::curve_create_edit_data_and_handles(), blender::ed::curves::curve_draw_stroke_3d(), curve_draw_stroke_3d(), dial_geom_draw(), dial_ghostarc_draw(), dial_ghostarc_draw_helpline(), dial_ghostarc_draw_incremental_angle(), BlenderDisplayDriver::draw(), draw_anti_tria(), draw_azone_arrow(), draw_background(), draw_background(), draw_channel_strips(), blender::ed::greasepencil::image_render::draw_circles(), draw_columnheader_background(), draw_columnheader_columns(), blender::ed::greasepencil::draw_control_points(), draw_current_frame(), draw_disk_shaded(), draw_display_buffer(), draw_distortion(), draw_dividers(), blender::ed::greasepencil::image_render::draw_dot(), blender::ed::greasepencil::image_render::draw_dots(), draw_fcurve(), draw_fcurve_handles(), draw_fcurve_modifier_controls_envelope(), draw_fcurve_samples(), draw_fcurve_vertices(), blender::ed::greasepencil::image_render::draw_grease_pencil_stroke(), draw_image_cache(), draw_image_sample_line(), draw_line_bounds(), draw_line_loop(), draw_line_pairs(), blender::ed::greasepencil::image_render::draw_lines(), draw_marker_areas(), draw_marker_line(), draw_markers_background(), draw_movieclip_cache(), draw_movieclip_muted(), draw_nla_main_data(), blender::ed::space_node::draw_nodespace_back_pix(), draw_normalization_borders(), draw_overlap_frame_indicator(), draw_overshoot_triangle(), draw_parallel_lines(), draw_plane_marker_ex(), draw_plane_marker_image(), blender::ed::greasepencil::image_render::draw_polyline(), draw_render_info(), draw_seq_timeline_channels(), draw_single_handle(), draw_spline_points(), blender::ed::spreadsheet::draw_spreadsheet_in_region(), draw_stabilization_border(), blender::draw::draw_subdiv_cache_update_extra_coarse_face_data(), blender::draw::draw_subdiv_get_pos_nor_format(), draw_timeline_sfra_efra(), draw_track_path(), draw_tracking_tracks(), draw_view_axis(), drawConstraint(), drawEdgeSlide(), drawFlyPixel(), drawLine(), drawPropCircle(), drawPropRange(), drawrenderborder(), drawSnapping(), blender::render::hydra::DrawTexture::DrawTexture(), drawVertSlide(), drawviewborder(), drawWalkPixel(), DRW_cache_bone_box_get(), DRW_cache_bone_dof_lines_get(), DRW_cache_bone_dof_sphere_get(), DRW_cache_bone_envelope_outline_get(), DRW_cache_bone_envelope_solid_get(), DRW_cache_bone_octahedral_get(), DRW_cache_bone_point_get(), DRW_cache_bone_point_wire_outline_get(), DRW_cache_bone_stick_get(), DRW_cache_cursor_get(), DRW_cache_empty_capsule_body_get(), DRW_cache_empty_capsule_cap_get(), DRW_cache_fullscreen_quad_get(), DRW_cache_grid_get(), DRW_cache_normal_arrow_get(), drw_cache_procedural_lines_get(), drw_cache_procedural_points_get(), drw_cache_procedural_triangle_strips_get(), drw_cache_procedural_triangles_get(), DRW_cache_speaker_get(), DRW_cache_sphere_get(), blender::draw::drw_curves_ensure_dummy_vbo(), DRW_draw_cursor(), DRW_gpencil_dummy_buffer_get(), drw_hair_ensure_vbo(), blender::draw::DRW_pointcloud_init(), DRW_shgroup_call_buffer(), DRW_shgroup_call_buffer_instance(), DRW_shgroup_instance_format_array(), blender::draw::DRW_vertbuf_create_wiredata(), blender::draw::drw_volume_selection_surface_cb(), blender::draw::drw_volume_wireframe_cb(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_edit_draw(), ED_image_draw_cursor(), ED_image_draw_info(), ED_imbuf_sample_draw(), ED_mask_draw_frames(), ED_region_cache_draw_background(), ED_region_cache_draw_cached_segments(), ED_region_cache_draw_curfra_label(), ED_region_do_draw(), ED_region_draw_mouse_line_cb(), ED_region_grid_draw(), ED_region_image_metadata_draw(), ED_region_info_draw_multiline(), ED_time_scrub_channel_search_draw(), ED_view3d_cursor_snap_draw_util(), EDBM_preselect_edgering_draw(), EDBM_preselect_elem_draw(), blender::draw::edit_points_vert_format_get(), blender::draw::edituv_data_format(), blender::draw::ensure_final_attribute(), extra_vert_format(), blender::draw::extract_attr_viewer(), blender::draw::extract_edge_factor(), blender::draw::extract_edituv_stretch_angle(), blender::draw::extract_edituv_stretch_area(), blender::draw::extract_edituv_stretch_area_subdiv(), blender::draw::extract_face_dot_normals(), blender::draw::extract_face_dots_edituv_data(), blender::draw::extract_face_dots_uv(), blender::draw::extract_lines_loose_geom_subdiv(), blender::draw::extract_mesh_analysis(), blender::draw::extract_normals(), blender::draw::extract_orco(), blender::draw::extract_positions(), blender::draw::extract_positions_subdiv(), blender::draw::extract_sculpt_data_subdiv(), blender::draw::extract_skin_roots(), blender::draw::extract_tan_init_common(), blender::draw::extract_vert_normals(), blender::draw::extract_weights(), blender::draw::extract_weights_subdiv(), blender::draw::pbvh::face_set_format(), file_draw_preview(), blender::draw::get_blender_patch_coords_format(), blender::draw::get_coarse_tan_format(), blender::draw::get_custom_normals_format(), blender::gpu::MTLContext::get_dummy_texture(), blender::draw::get_edit_data_format(), blender::draw::get_edituv_stretch_angle_format_subdiv(), blender::draw::get_fdots_nor_format_subdiv(), blender::draw::get_fdots_pos_format(), blender::draw::get_normals_format(), blender::draw::get_origindex_format(), blender::draw::get_patch_array_format(), blender::draw::get_patch_handle_format(), blender::draw::get_patch_index_format(), blender::draw::get_patch_param_format(), blender::draw::get_quadtree_format(), blender::draw::get_sculpt_data_format(), blender::draw::get_subdiv_edge_fac_format(), blender::draw::get_subdiv_lnor_format(), blender::draw::get_subdiv_vertex_format(), blender::draw::get_uvs_format(), gizmo_axis_draw(), gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_primitive_draw_geom(), gizmo_ruler_draw(), GPU_batch_tris_from_poly_2d_encoded(), GPU_batch_wire_from_poly_2d_encoded(), blender::gpu::tests::gpu_shader_lib_test(), GPU_vertformat_from_shader(), gpu_viewport_batch_format(), GPU_viewport_stereo_composite(), blender::ed::sculpt_paint::image::ops::paint::gradient_draw_line(), graph_draw_driver_debug(), graph_draw_ghost_curves(), graph_main_region_draw(), blender::draw::grease_pencil_color_format(), blender::draw::grease_pencil_edit_batch_ensure(), blender::draw::grease_pencil_stroke_format(), blender::draw::grease_pencil_weight_batch_ensure(), imm_draw_box_checker_2d_ex(), immDrawPixelsTexSetupAttributes(), blender::draw::init_format_for_attribute(), blender::draw::init_vbo_data(), knifetool_draw(), knifetool_draw_angle(), knifetool_draw_angle_snapping(), knifetool_draw_orientation_locking(), knifetool_draw_visible_distances(), blender::draw::lattice_batch_cache_create_overlay_batches(), blender::draw::lattice_batch_cache_get_pos(), mask_draw_curve_type(), blender::draw::pbvh::mask_format(), blender::draw::mesh_extract_uv_format_init(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_draw(), move_geom_draw(), mpath_vbo_get(), nla_action_draw_keyframes(), nla_actionclip_draw_markers(), nla_draw_strip(), nla_draw_use_dashed_outlines(), blender::ed::space_node::node_composit_backdrop_boxmask(), blender::ed::space_node::node_composit_backdrop_ellipsemask(), blender::ed::space_node::node_draw_hidden(), blender::ed::space_node::node_draw_preview_background(), blender::ed::space_node::node_draw_sockets(), blender::ed::space_node::node_draw_zones_and_frames(), blender::ed::space_node::node_socket_draw(), blender::ed::space_node::nodelink_batch_init(), blender::draw::pbvh::normal_format(), blender::ed::outliner::outliner_back(), blender::ed::outliner::outliner_draw_hierarchy_lines(), blender::ed::outliner::outliner_draw_highlights(), blender::ed::outliner::outliner_draw_separator(), blender::ed::outliner::outliner_draw_struct_marks(), blender::ed::sculpt_paint::paint_cursor_setup_2D_drawing(), blender::ed::sculpt_paint::paint_cursor_setup_3D_drawing(), blender::ed::sculpt_paint::paint_draw_cursor_overlay(), blender::ed::sculpt_paint::paint_draw_curve_cursor(), blender::ed::sculpt_paint::paint_draw_line_cursor(), blender::ed::sculpt_paint::paint_draw_smooth_cursor(), blender::ed::sculpt_paint::paint_draw_tex_overlay(), blender::draw::particle_batch_cache_ensure_pos(), blender::draw::particle_batch_cache_ensure_pos_and_seg(), blender::draw::particle_batch_cache_ensure_procedural_final_points(), blender::draw::particle_batch_cache_ensure_procedural_indices(), blender::draw::particle_batch_cache_ensure_procedural_pos(), blender::draw::particle_batch_cache_ensure_procedural_strand_data(), playanim_toscreen_ex(), blender::draw::pointcloud_extract_attribute(), blender::draw::pointcloud_extract_position_and_radius(), blender::draw::pbvh::position_format(), preset_2d_format(), preset_3d_format(), pygpu_vertformat_attr_add(), radial_control_paint_cursor(), radial_control_paint_tex(), region_draw_emboss(), rounded_corners(), seq_draw_image_origin_and_outline(), SeqQuadsBatch::SeqQuadsBatch(), sequencer_draw_borders_overlay(), sequencer_draw_display_buffer(), sequencer_draw_scopes(), sequencer_retiming_keys_draw(), blender::draw::single_attr_vbo_format(), stitch_draw(), blender::gpu::tests::TEST(), blender::gpu::tests::TEST(), blender::gpu::tests::TEST(), blender::gpu::tests::TEST(), blender::gpu::tests::test_buffer_texture(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_subpass_input(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::test_shader_compute_vbo(), blender::gpu::tests::test_storage_buffer_copy_from_vertex_buffer(), textview_draw_sel(), textview_draw_string(), timeline_draw_cache(), transform_draw_cursor_draw(), ui_draw_but_COLORBAND(), ui_draw_but_CURVE(), ui_draw_but_CURVEPROFILE(), ui_draw_but_HISTOGRAM(), ui_draw_but_HSVCIRCLE(), ui_draw_but_HSVCUBE(), ui_draw_but_TAB_outline(), ui_draw_but_TRACKPREVIEW(), ui_draw_but_UNITVEC(), ui_draw_but_VECTORSCOPE(), ui_draw_but_WAVEFORM(), ui_draw_button_sections_alignment_separator(), ui_draw_gradient(), ui_draw_pie_center(), ui_draw_popover_back_impl(), ui_draw_rounded_corners_inverted(), ui_draw_separator(), UI_draw_text_underline(), ui_hsv_cursor(), UI_panel_category_draw_all(), ui_tooltip_region_draw_cb(), UI_view2d_dot_grid_draw(), UI_view2d_multi_grid_draw(), v3d_cursor_plane_draw_grid(), blender::gpu::tests::ShaderSpecializationConst::validate(), blender::draw::overlay::vbo_from_vector(), blender::draw::overlay::vbo_from_vector(), blender::draw::overlay::vbo_from_vector(), blender::gpu::tests::vertex_buffer_fetch_mode(), vflag_format(), vicon_colorset_draw(), vicon_gplayer_color_draw(), vicon_keytype_draw_wrapper(), blender::ed::object::voxel_size_edit_draw(), waveform_draw_one(), waveform_draw_rgb(), widget_draw_extra_mask(), widget_draw_text(), widget_progress_type_ring(), widget_swatch(), wm_gesture_draw_circle(), wm_gesture_draw_cross(), wm_gesture_draw_lasso(), wm_gesture_draw_line(), wm_gesture_draw_line_active_side(), wm_gesture_draw_polyline(), wm_gesture_draw_rect(), wm_gizmo_geometryinfo_draw(), wm_software_cursor_draw_bitmap(), wm_software_cursor_draw_crosshair(), wm_stereo3d_draw_sidebyside(), wm_stereo3d_draw_topbottom(), wm_xr_controller_aim_draw(), wm_xr_controller_model_batch_create(), and wm_xr_raycast_draw().

◆ GPU_vertformat_attr_id_get()

int GPU_vertformat_attr_id_get ( const GPUVertFormat * format,
const char * name )

◆ GPU_vertformat_attr_rename()

void GPU_vertformat_attr_rename ( GPUVertFormat * format,
int attr,
const char * new_name )
Warning
Can only rename using a string with same character count.
This removes all other aliases of this attribute.

Definition at line 229 of file gpu_vertex_format.cc.

References attr_id, BLI_assert, GPU_vertformat_attr_name_get(), and GPUVertAttr::name_len.

◆ GPU_vertformat_clear()

◆ GPU_vertformat_copy()

void GPU_vertformat_copy ( GPUVertFormat * dest,
const GPUVertFormat & src )

Definition at line 51 of file gpu_vertex_format.cc.

Referenced by blender::gpu::VertBuf::init().

◆ GPU_vertformat_deinterleave()

void GPU_vertformat_deinterleave ( GPUVertFormat * format)

Make attribute layout non-interleaved. Warning! This does not change data layout! Use direct buffer access to fill the data. This is for advanced usage.

De-interleaved data means all attribute data for each attribute is stored continuously like this: 000011112222 instead of: 012012012012

Note
This is per attribute de-interleaving, NOT per component.

Definition at line 288 of file gpu_vertex_format.cc.

Referenced by blender::draw::extract_tan_init_common(), blender::draw::init_vbo_for_attribute(), and blender::draw::mesh_extract_uv_format_init().

◆ GPU_vertformat_from_shader()

◆ GPU_vertformat_multiload_enable()

void GPU_vertformat_multiload_enable ( GPUVertFormat * format,
int load_count )

Makes vertex attribute from the next vertices to be accessible in the vertex shader. For an attribute named "attr" you can access the next nth vertex using "attr{number}". Use this function after specifying all the attributes in the format.

NOTE: This does NOT work when using indexed rendering. NOTE: Only works for first attribute name. (this limitation can be changed if needed)

WARNING: this function creates a lot of aliases/attributes, make sure to keep the attribute name short to avoid overflowing the name-buffer.

Definition at line 185 of file gpu_vertex_format.cc.

References BLI_assert, copy_attr_name(), GPU_VERT_ATTR_MAX_LEN, GPU_VERT_ATTR_NAMES_BUF_LEN, GPU_VERT_FORMAT_MAX_NAMES, GPU_vertformat_attr_name_get(), GPUVertAttr::name_len, GPUVertAttr::names, GPUVertAttr::offset, SNPRINTF, and VertexFormat_pack().

◆ GPU_vertformat_safe_attr_name()

void GPU_vertformat_safe_attr_name ( const char * attr_name,
char * r_safe_name,
uint max_len )

◆ padding()

◆ recommended_fetch_mode_and_comp_type()

static void recommended_fetch_mode_and_comp_type ( Type gpu_type,
GPUVertCompType * r_comp_type,
GPUVertFetchMode * r_fetch_mode )
static

◆ safe_bytes()

static void safe_bytes ( char out[11],
const char data[8] )
static

Definition at line 244 of file gpu_vertex_format.cc.

Referenced by GPU_vertformat_safe_attr_name().

◆ vertex_buffer_size()

◆ VertexFormat_pack()

◆ VertexFormat_pack_impl()

static void VertexFormat_pack_impl ( GPUVertFormat * format,
uint minimum_stride )
static

◆ VertexFormat_texture_buffer_pack()

void VertexFormat_texture_buffer_pack ( GPUVertFormat * format)

Definition at line 356 of file gpu_vertex_format.cc.

References BLI_assert_msg, and VertexFormat_pack_impl().

Referenced by blender::gpu::VertBuf::init().