Classes
struct	BoxPack

struct	FixedSizeBoxPack

Typedefs
typedef struct BoxPack	BoxPack

typedef struct FixedSizeBoxPack	FixedSizeBoxPack

Functions
void	BLI_box_pack_2d (BoxPack boxarray, unsigned int len, bool sort_boxes, float r_tot_x, float *r_tot_y)

void	BLI_box_pack_2d_fixedarea (struct ListBase boxes, int width, int height, struct ListBase packed)

Typedef Documentation

◆ BoxPack

typedef struct BoxPack BoxPack

◆ FixedSizeBoxPack

typedef struct FixedSizeBoxPack FixedSizeBoxPack

Function Documentation

◆ BLI_box_pack_2d()

void BLI_box_pack_2d	(	BoxPack *	boxarray,
		unsigned int	len,
		bool	sort_boxes,
		float *	r_tot_x,
		float *	r_tot_y )

Main box-packing function accessed from other functions This sets boxes x,y to positive values, sorting from 0,0 outwards. There is no limit to the space boxes may take, only that they will be packed tightly into the lower left hand corner (0,0)

Parameters

box_array	a pre-allocated array of boxes. only the 'box->x' and 'box->y' are set, 'box->w' and 'box->h' are used, 'box->index' is not used at all, the only reason its there is that the box array is sorted by area and programs need to be able to have some way of writing the boxes back to the original data.
len	the number of boxes in the array.
sort_boxes	Sort `box_array` before packing.
r_tot_x,r_tot_y	set so you can normalize the data.

Definition at line 271 of file boxpack_2d.c.

References A, B, BL, BoxVert::blb, BLF, BLI_assert, box_areasort(), VertSortContext::box_height, box_isect(), VertSortContext::box_width, box_xmax_get(), box_xmax_set(), box_xmin_get(), box_xmin_set(), box_ymax_get(), box_ymax_set(), box_ymin_get(), box_ymin_set(), BR, BoxVert::brb, BRF, CORNERFLAGS, ELEM, EPSILON_MERGE, fabsf, BoxVert::free, BoxPack::h, BoxVert::index, BoxVert::isect_cache, len, max_ff(), MEM_freeN(), MEM_mallocN, NULL, qsort_r, quad_flag(), TL, BoxVert::tlb, TLF, TR, BoxVert::trb, TRF, UNLIKELY, BoxVert::used, BoxPack::v, vert_bias_update(), VertSortContext::vertarray, vertex_sort(), BoxPack::w, BoxVert::x, and BoxVert::y.

Referenced by M_Geometry_box_pack_2d(), and blender::geometry::pack_island_box_pack_2d().

◆ BLI_box_pack_2d_fixedarea()

void BLI_box_pack_2d_fixedarea	(	struct ListBase *	boxes,
		int	width,
		int	height,
		struct ListBase *	packed )

Packs boxes into a fixed area.

Boxes and packed are linked lists containing structs that can be cast to FixedSizeBoxPack (i.e. contains a FixedSizeBoxPack as its first element). Boxes that were packed successfully are placed into *packed and removed from *boxes.

The algorithm is a simplified version of https://github.com/TeamHypersomnia/rectpack2D. Better ones could be used, but for the current use case (packing Image tiles into GPU textures) this is fine.

Note that packing efficiency depends on the order of the input boxes. Generally speaking, larger boxes should come first, though how exactly size is best defined (e.g. area, perimeter) depends on the particular application.

Definition at line 663 of file boxpack_2d.c.

References BLI_addhead(), BLI_addtail(), BLI_freelistN(), BLI_remlink(), FixedSizeBoxPack::h, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, MEM_callocN, MEM_freeN(), NULL, FixedSizeBoxPack::w, FixedSizeBoxPack::x, and FixedSizeBoxPack::y.

Referenced by gpu_texture_create_tile_array().

Classes