GPU_immediate_util.hh File Reference

#include "BLI_sys_types.h"

Go to the source code of this file.

Functions
void	immRectf (uint pos, float x1, float y1, float x2, float y2)
void	immRecti (uint pos, int x1, int y1, int x2, int y2)
void	immRectf_with_texco (uint pos, uint tex_coord, const rctf &p, const rctf &uv)
void	immRectf_fast (uint pos, float x1, float y1, float x2, float y2)
void	immRectf_fast_with_color (uint pos, uint col, float x1, float y1, float x2, float y2, const float color[4])
void	immRecti_fast_with_color (uint pos, uint col, int x1, int y1, int x2, int y2, const float color[4])
void	imm_cpack (uint x)
void	imm_draw_circle_wire_2d (uint shdr_pos, float x, float y, float radius, int nsegments)
void	imm_draw_circle_fill_2d (uint shdr_pos, float x, float y, float radius, int nsegments)
void	imm_draw_circle_wire_aspect_2d (uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments)
void	imm_draw_circle_fill_aspect_2d (uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments)
void	imm_draw_circle_wire_3d (uint pos, float x, float y, float radius, int nsegments)
void	imm_draw_circle_wire_aspect_3d (uint pos, float x, float y, float radius_x, float radius_y, int nsegments)
void	imm_draw_circle_dashed_3d (uint pos, float x, float y, float radius, int nsegments)
void	imm_draw_circle_fill_3d (uint pos, float x, float y, float radius, int nsegments)
void	imm_draw_circle_fill_aspect_3d (uint pos, float x, float y, float radius_x, float radius_y, int nsegments)
void	imm_draw_circle_partial_wire_2d (uint pos, float x, float y, float radius, int nsegments, float start, float sweep)
void	imm_draw_circle_partial_wire_3d (uint pos, float x, float y, float z, float radius, int nsegments, float start, float sweep)
void	imm_draw_disk_partial_fill_2d (uint pos, float x, float y, float rad_inner, float rad_outer, int nsegments, float start, float sweep)
void	imm_draw_disk_partial_fill_3d (uint pos, float x, float y, float z, float rad_inner, float rad_outer, int nsegments, float start, float sweep)
void	imm_draw_box_wire_2d (uint pos, float x1, float y1, float x2, float y2)
void	imm_draw_box_wire_3d (uint pos, float x1, float y1, float x2, float y2)
void	imm_draw_box_checker_2d_ex (float x1, float y1, float x2, float y2, const float color_primary[4], const float color_secondary[4], int checker_size)
void	imm_draw_box_checker_2d (float x1, float y1, float x2, float y2, bool clear_alpha=false)
void	imm_draw_cube_fill_3d (uint pos, const float center[3], const float aspect[3])
void	imm_draw_cube_wire_3d (uint pos, const float center[3], const float aspect[3])
void	imm_draw_cube_corners_3d (uint pos, const float center[3], const float aspect[3], float factor)
void	imm_draw_cylinder_fill_normal_3d (uint pos, uint nor, float base, float top, float height, int slices, int stacks)
void	imm_draw_cylinder_wire_3d (uint pos, float base, float top, float height, int slices, int stacks)
void	imm_draw_cylinder_fill_3d (uint pos, float base, float top, float height, int slices, int stacks)
void	imm_drawcircball (const float cent[3], float radius, const float tmat[4][4], uint pos)

Detailed Description

Utility drawing functions (rough equivalent to OpenGL's GLU)

Definition in file GPU_immediate_util.hh.

Function Documentation

imm_cpack()

void imm_cpack

(

uint

x

)

Pack color into 3 bytes

This define converts a numerical value to the equivalent 24-bit color, while not being endian-sensitive. On little-endian, this is the same as doing a 'naive' indexing, on big-endian, it is not!

Note

BGR format (i.e. 0xBBGGRR)...

Parameters

x

color.

Definition at line 153 of file gpu_immediate_util.cc.

References immUniformColor3ub(), and x.

Referenced by blender::ed::curves::curve_draw_stroke_3d(), and curve_draw_stroke_3d().

imm_draw_box_checker_2d()

void imm_draw_box_checker_2d	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		bool	clear_alpha = false )

Definition at line 487 of file gpu_immediate_util.cc.

References imm_draw_box_checker_2d_ex(), TH_TRANSPARENT_CHECKER_PRIMARY, TH_TRANSPARENT_CHECKER_SECONDARY, TH_TRANSPARENT_CHECKER_SIZE, U, UI_GetThemeColor4fv(), and UI_GetThemeValue().

Referenced by draw_movieclip_buffer(), file_draw_preview(), blender::ed::vse::sequencer_preview_draw_overlays(), and ui_tooltip_region_draw_cb().

imm_draw_box_checker_2d_ex()

void imm_draw_box_checker_2d_ex	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		const float	color_primary[4],
		const float	color_secondary[4],
		int	checker_size )

Draw a standard checkerboard to indicate transparent backgrounds.

Definition at line 466 of file gpu_immediate_util.cc.

References GPU_SHADER_2D_CHECKER, GPU_vertformat_attr_add(), immBindBuiltinProgram(), immRectf(), immUnbindProgram(), immUniform1i(), immUniform4fv(), immVertexFormat(), and pos.

Referenced by imm_draw_box_checker_2d(), playanim_toscreen_ex(), and ui_tooltip_region_draw_cb().

imm_draw_box_wire_2d()

void imm_draw_box_wire_2d	(	uint	pos,
		float	x1,
		float	y1,
		float	x2,
		float	y2 )

Draw a lined box.

Parameters

pos	The vertex attribute number for position.
x1	left.
y1	bottom.
x2	right.
y2	top.

Definition at line 429 of file gpu_immediate_util.cc.

References GPU_PRIM_LINES, immBegin(), immEnd(), immVertex2f(), and pos.

Referenced by draw_image_uv_custom_region(), draw_marker_areas(), draw_marker_outline(), blender::ed::sculpt_paint::draw_rect_point(), draw_stabilization_border(), drawrenderborder(), drawviewborder(), ED_image_draw_info(), ED_imbuf_sample_draw(), ED_region_do_draw(), ED_region_image_render_region_draw(), file_draw_preview(), nla_draw_strip(), blender::ed::vse::sequencer_draw_borders_overlay(), ui_draw_but_CURVE(), ui_draw_but_CURVEPROFILE(), ui_draw_but_HSVCUBE(), UI_draw_safe_areas(), ui_tooltip_region_draw_cb(), and wm_gesture_draw_rect().

imm_draw_box_wire_3d()

void imm_draw_box_wire_3d	(	uint	pos,
		float	x1,
		float	y1,
		float	x2,
		float	y2 )

Definition at line 447 of file gpu_immediate_util.cc.

References GPU_PRIM_LINES, immBegin(), immEnd(), immVertex3f(), and pos.

Referenced by blender::ed::transform::drawPropRange().

imm_draw_circle_dashed_3d()

void imm_draw_circle_dashed_3d	(	uint	pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments )

Definition at line 413 of file gpu_immediate_util.cc.

References GPU_PRIM_LINES, imm_draw_circle_3D(), pos, x, and y.

Referenced by blender::ed::sculpt_paint::cloth::simulation_limits_draw().

imm_draw_circle_fill_2d()

void imm_draw_circle_fill_2d	(	uint	shdr_pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments )

Draw a filled circle with the given radius. The circle is centered at x, y and drawn in the XY plane.

Parameters

shdr_pos	The vertex attribute number for position.
x	Horizontal center.
y	Vertical center.
radius	The circle's radius.
nsegments	The number of segments to use in drawing (more = smoother).

Definition at line 194 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, imm_draw_circle(), x, and y.

Referenced by annotation_draw_eraser(), blender::ed::sculpt_paint::grease_pencil_eraser_draw(), radial_control_paint_cursor(), radial_control_paint_tex(), and wm_gesture_draw_circle().

imm_draw_circle_fill_3d()

void imm_draw_circle_fill_3d	(	uint	pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments )

Definition at line 418 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, imm_draw_circle_3D(), pos, x, and y.

Referenced by arrow_draw_geom(), button2d_geom_draw_backdrop(), blender::ed::sculpt_paint::cursor_draw_point_screen_space(), dial_geom_draw(), gizmo_primitive_draw_geom(), and move_geom_draw().

imm_draw_circle_fill_aspect_2d()

void imm_draw_circle_fill_aspect_2d	(	uint	shdr_pos,
		float	x,
		float	y,
		float	radius_x,
		float	radius_y,
		int	nsegments )

Definition at line 205 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, imm_draw_circle(), x, and y.

Referenced by cage2d_draw_rect_rotate_handle().

imm_draw_circle_fill_aspect_3d()

void imm_draw_circle_fill_aspect_3d	(	uint	pos,
		float	x,
		float	y,
		float	radius_x,
		float	radius_y,
		int	nsegments )

Definition at line 423 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, imm_draw_circle_3D(), pos, x, and y.

imm_draw_circle_partial_wire_2d()

void imm_draw_circle_partial_wire_2d	(	uint	pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments,
		float	start,
		float	sweep )

Same as 'imm_draw_disk_partial_fill_2d', except it draws a wire arc.

Definition at line 258 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_STRIP, imm_draw_circle_partial(), pos, x, and y.

imm_draw_circle_partial_wire_3d()

void imm_draw_circle_partial_wire_3d	(	uint	pos,
		float	x,
		float	y,
		float	z,
		float	radius,
		int	nsegments,
		float	start,
		float	sweep )

Definition at line 264 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_STRIP, imm_draw_circle_partial_3d(), pos, x, y, and z().

Referenced by dial_geom_draw().

imm_draw_circle_wire_2d()

void imm_draw_circle_wire_2d	(	uint	shdr_pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments )

Draw a circle outline with the given radius. The circle is centered at x, y and drawn in the XY plane.

Parameters

shdr_pos	The vertex attribute number for position.
x	Horizontal center.
y	Vertical center.
radius	The circle's radius.
nsegments	The number of segments to use in drawing (more = smoother).

Definition at line 189 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_LOOP, imm_draw_circle(), x, and y.

Referenced by annotation_draw_eraser(), annotation_draw_stabilizer(), brush_drawcursor(), draw_lasso_smooth_stroke_indicator(), draw_start_vertex_circle(), blender::ed::transform::drawSnapping(), blender::ed::sculpt_paint::grease_pencil_brush_cursor_draw(), blender::ed::sculpt_paint::grease_pencil_eraser_draw(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_draw(), blender::ed::sculpt_paint::paint_draw_2D_view_brush_cursor_default(), radial_control_paint_cursor(), tracking_segment_knot_cb(), ui_draw_but_HSVCIRCLE(), ui_draw_but_UNITVEC(), ui_draw_pie_center(), and wm_gesture_draw_circle().

imm_draw_circle_wire_3d()

void imm_draw_circle_wire_3d	(	uint	pos,
		float	x,
		float	y,
		float	radius,
		int	nsegments )

Use this version when GPUVertFormat has a vec3 position.

Definition at line 402 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_LOOP, imm_draw_circle_3D(), pos, x, and y.

Referenced by button2d_geom_draw_backdrop(), cursor_point_draw(), dial_geom_draw(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_edit_draw(), gizmo_primitive_draw_geom(), move_geom_draw(), blender::ed::sculpt_paint::paint_cursor_draw_main_inactive_cursor(), blender::ed::sculpt_paint::paint_draw_3D_view_inactive_brush_cursor(), blender::ed::sculpt_paint::paint_draw_legacy_3D_view_brush_cursor(), blender::ed::sculpt_paint::SCULPT_layer_brush_height_preview_draw(), and blender::ed::sculpt_paint::cloth::simulation_limits_draw().

imm_draw_circle_wire_aspect_2d()

void imm_draw_circle_wire_aspect_2d	(	uint	shdr_pos,
		float	x,
		float	y,
		float	radius_x,
		float	radius_y,
		int	nsegments )

Definition at line 199 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_LOOP, imm_draw_circle(), x, and y.

Referenced by cage2d_draw_rect_rotate_handle().

imm_draw_circle_wire_aspect_3d()

void imm_draw_circle_wire_aspect_3d	(	uint	pos,
		float	x,
		float	y,
		float	radius_x,
		float	radius_y,
		int	nsegments )

Definition at line 407 of file gpu_immediate_util.cc.

References GPU_PRIM_LINE_LOOP, imm_draw_circle_3D(), pos, x, and y.

Referenced by cage2d_draw_circle_wire().

imm_draw_cube_corners_3d()

void imm_draw_cube_corners_3d	(	uint	pos,
		const float	center[3],
		const float	aspect[3],
		float	factor )

Definition at line 536 of file gpu_immediate_util.cc.

References add_v3_v3(), ARRAY_SIZE, copy_v3_v3(), cube_coords, cube_line_index, GPU_PRIM_LINES, i, immBegin(), immEnd(), immVertex3fv(), madd_v3_v3v3v3(), mul_v3_fl(), pos, sub_v3_v3(), and sub_v3_v3v3().

Referenced by cursor_box_draw().

imm_draw_cube_fill_3d()

void imm_draw_cube_fill_3d	(	uint	pos,
		const float	center[3],
		const float	aspect[3] )

Definition at line 499 of file gpu_immediate_util.cc.

References ARRAY_SIZE, cube_coords, cube_quad_index, GPU_PRIM_TRIS, i, immBegin(), immEnd(), immVertex3fv(), madd_v3_v3v3v3(), and pos.

Referenced by cage3d_draw_box_interaction(), and imm_draw_point_aspect_3d().

imm_draw_cube_wire_3d()

void imm_draw_cube_wire_3d	(	uint	pos,
		const float	center[3],
		const float	aspect[3] )

Definition at line 520 of file gpu_immediate_util.cc.

References ARRAY_SIZE, cube_coords, cube_line_index, GPU_PRIM_LINES, i, immBegin(), immEnd(), immVertex3fv(), madd_v3_v3v3v3(), and pos.

Referenced by cage3d_draw_box_corners(), cage3d_draw_circle_wire(), and imm_draw_point_aspect_3d().

imm_draw_cylinder_fill_3d()

void imm_draw_cylinder_fill_3d	(	uint	pos,
		float	base,
		float	top,
		float	height,
		int	slices,
		int	stacks )

Definition at line 660 of file gpu_immediate_util.cc.

References cosf, float, GPU_PRIM_TRIS, i, immBegin(), immEnd(), immVertex3fv(), M_PI, pos, sinf, top, and v2.

Referenced by arrow_draw_geom().

imm_draw_cylinder_fill_normal_3d()

void imm_draw_cylinder_fill_normal_3d	(	uint	pos,
		uint	nor,
		float	base,
		float	top,
		float	height,
		int	slices,
		int	stacks )

Draw a cylinder. Replacement for #gluCylinder.

Warning

Slow, better use it only if you no other choices.

Parameters

pos	The vertex attribute number for position.
nor	The vertex attribute number for normal.
base	Specifies the radius of the cylinder at z = 0.
top	Specifies the radius of the cylinder at z = height.
height	Specifies the height of the cylinder.
slices	Specifies the number of subdivisions around the z axis.
stacks	Specifies the number of subdivisions along the z axis.

Definition at line 566 of file gpu_immediate_util.cc.

References cosf, float, GPU_PRIM_TRIS, i, immAttr3fv(), immBegin(), immEnd(), immVertex3fv(), M_PI, nor, normalize_v3(), pos, sinf, sub_v3_v3v3(), top, and v2.

imm_draw_cylinder_wire_3d()

void imm_draw_cylinder_wire_3d	(	uint	pos,
		float	base,
		float	top,
		float	height,
		int	slices,
		int	stacks )

Definition at line 622 of file gpu_immediate_util.cc.

References cosf, float, GPU_PRIM_LINES, i, immBegin(), immEnd(), immVertex3fv(), M_PI, pos, sinf, top, and v2.

imm_draw_disk_partial_fill_2d()

void imm_draw_disk_partial_fill_2d	(	uint	pos,
		float	x,
		float	y,
		float	rad_inner,
		float	rad_outer,
		int	nsegments,
		float	start,
		float	sweep )

Draw a filled arc with the given inner and outer radius. The circle is centered at x, y and drawn in the XY plane.

Note

Arguments are gluPartialDisk compatible.

Parameters

pos	The vertex attribute number for position.
x	Horizontal center.
y	Vertical center.
rad_inner	The inner circle's radius.
rad_outer	The outer circle's radius (can be zero).
nsegments	The number of segments to use in drawing (more = smoother).
start	Specifies the starting angle, in degrees, of the disk portion.
sweep	Specifies the sweep angle, in degrees, of the disk portion.

Definition at line 329 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_STRIP, imm_draw_disk_partial(), pos, x, and y.

Referenced by dial_ghostarc_draw(), and widget_progress_type_ring().

imm_draw_disk_partial_fill_3d()

void imm_draw_disk_partial_fill_3d	(	uint	pos,
		float	x,
		float	y,
		float	z,
		float	rad_inner,
		float	rad_outer,
		int	nsegments,
		float	start,
		float	sweep )

Definition at line 341 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_STRIP, imm_draw_disk_partial_3d(), pos, x, y, and z().

Referenced by dial_geom_draw(), and gizmo_primitive_draw_geom().

imm_drawcircball()

void imm_drawcircball	(	const float	cent[3],
		float	radius,
		const float	tmat[4][4],
		uint	pos )

Definition at line 738 of file gpu_immediate_util.cc.

References circball_array_fill(), CIRCLE_RESOL, GPU_PRIM_LINE_LOOP, i, immBegin(), immEnd(), immVertex3fv(), pos, and verts.

Referenced by blender::ed::transform::drawPropCircle(), and blender::ed::transform::drawSnapping().

immRectf()

void immRectf	(	uint	pos,
		float	x1,
		float	y1,
		float	x2,
		float	y2 )

Definition at line 57 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, immBegin(), immEnd(), immVertex2f(), and pos.

Referenced by acf_generic_channel_backdrop(), acf_generic_dataexpand_backdrop(), ANIM_channel_draw(), ANIM_channel_draw_widgets(), ANIM_draw_action_framerange(), ANIM_draw_framerange(), ANIM_draw_previewrange(), ANIM_draw_scene_strip_range(), clip_draw_dopesheet_background(), clip_draw_dopesheet_channels(), clip_draw_dopesheet_main(), console_textview_draw_cursor(), blender::ed::spreadsheet::draw_alternating_row_overlay(), draw_backdrops(), draw_background(), draw_background(), blender::ed::spreadsheet::draw_column_reorder_source(), draw_columnheader_background(), draw_image_cache(), blender::ed::spreadsheet::draw_index_column_background(), draw_keyframe(), draw_marker_slide_square(), draw_markers_background(), draw_movieclip_cache(), draw_movieclip_muted(), draw_nla_main_data(), draw_normalization_borders(), blender::ed::vse::draw_seq_timeline_channels(), draw_suggestion_list(), draw_text_decoration(), draw_text_main(), draw_textscroll(), blender::ed::vse::draw_timeline_sfra_efra(), blender::ed::spreadsheet::draw_top_row_background(), blender::ed::transform::drawSnapping(), drawviewborder(), ED_image_draw_info(), ED_region_cache_draw_background(), ED_region_cache_draw_cached_segments(), ED_region_do_draw(), ED_region_grid_draw(), ED_region_image_metadata_draw(), ED_region_image_render_region_draw(), ED_region_info_draw_multiline(), ED_time_scrub_channel_search_draw(), gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_ruler_draw(), imm_draw_box_checker_2d_ex(), knifetool_draw_angle(), knifetool_draw_visible_distances(), nla_action_draw_keyframes(), nla_draw_strip(), blender::ed::space_node::node_draw_preview_background(), blender::ed::outliner::outliner_draw_struct_marks(), blender::ed::vse::sequencer_draw_scopes(), blender::ed::vse::sequencer_preview_draw_overlays(), textview_draw_sel(), textview_draw_string(), timeline_cache_draw_single(), ui_draw_but_COLORBAND(), ui_draw_but_CURVE(), ui_draw_but_CURVEPROFILE(), ui_draw_button_sections_alignment_separator(), UI_draw_text_underline(), UI_panel_category_draw_all(), vicon_colorset_draw(), vicon_gplayer_color_draw(), widget_draw_text(), wm_gesture_draw_rect(), and wm_software_cursor_draw_crosshair().

immRectf_fast()

void immRectf_fast	(	uint	pos,
		float	x1,
		float	y1,
		float	x2,
		float	y2 )

Same as immRectf / immRecti but does not call immBegin / immEnd. To use with GPU_PRIM_TRIS.

Definition at line 77 of file gpu_immediate_util.cc.

References immVertex2f(), and pos.

Referenced by timeline_cache_draw_cached_segments(), and timeline_cache_draw_geometry_nodes().

immRectf_fast_with_color()

void immRectf_fast_with_color	(	uint	pos,
		uint	col,
		float	x1,
		float	y1,
		float	x2,
		float	y2,
		const float	color[4] )

Definition at line 88 of file gpu_immediate_util.cc.

References col, immAttr4fv(), immVertex2f(), and pos.

immRectf_with_texco()

void immRectf_with_texco	(	uint	pos,
		uint	tex_coord,
		const rctf &	p,
		const rctf &	uv )

Definition at line 124 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, immAttr2f(), immBegin(), immEnd(), immVertex2f(), pos, tex_coord, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by blender::ed::vse::preview_draw_texture_simple(), blender::ed::vse::preview_draw_texture_to_linear(), blender::ed::vse::sequencer_draw_scopes(), and blender::ed::vse::update_gpu_scopes().

immRecti()

void immRecti	(	uint	pos,
		int	x1,
		int	y1,
		int	x2,
		int	y2 )

Definition at line 67 of file gpu_immediate_util.cc.

References GPU_PRIM_TRI_FAN, immBegin(), immEnd(), immVertex2i(), and pos.

immRecti_fast_with_color()

void immRecti_fast_with_color	(	uint	pos,
		uint	col,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		const float	color[4] )

Definition at line 106 of file gpu_immediate_util.cc.

References col, immAttr4fv(), immVertex2i(), and pos.