An array implementation for storing rectangles for the Legato user interface library. More...

#include "gfx/legato/common/legato_common.h"

Include dependency graph for legato_rectarray.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	leRectArray
	This struct represents a rectange array. More...

Typedefs
typedef struct leRectArray	leRectArray
	This struct represents a rectange array.

Functions
leResult	leRectArray_Create (leRectArray *arr)
	Creates a new rectangle. More...

leResult	leRectArray_Resize (leRectArray *arr, uint32_t sz)
	Resizes the capacity of the array. More...

leResult	leRectArray_PushFront (leRectArray arr, const leRect rect)
	Pushes a new rectangle onto the front of the array. More...

leResult	leRectArray_PopFront (leRectArray *arr)
	Removes the first value from the array. More...

leResult	leRectArray_PushBack (leRectArray arr, const leRect rect)
	Push value on back. More...

leResult	leRectArray_PopBack (leRectArray *arr)
	Removes the last rectangle from the array. More...

leResult	leRectArray_InsertAt (leRectArray arr, uint32_t idx, const leRect rect)
	Inserts a rectangle into an array at a given index. More...

leResult	leRectArray_RemoveAt (leRectArray *arr, uint32_t idx)
	Removes a rectangle from the array at an index. More...

leResult	leRectArray_Copy (leRectArray src, leRectArray dest)
	Copy array. More...

leResult	leRectArray_Clear (leRectArray *arr)
	Removes all values from a given array. More...

leResult	leRectArray_Destroy (leRectArray *arr)
	Destroy array. More...

leResult	leRectArray_RemoveDuplicates (leRectArray *arr)
	Removes any duplicate rectangles from an array. More...

leResult	leRectArray_SortBySize (leRectArray *arr)
	Sorts a given array. More...

leResult	leRectArray_SortByX (leRectArray *arr)
	Sort array by X coordinate. More...

leResult	leRectArray_SortByY (leRectArray *arr)
	Sort array by Y coordinate. More...

leResult	leRectArray_MergeSimilar (leRectArray *arr)
	Merge rectangles. More...

leResult	leRectArray_RemoveOverlapping (leRectArray *arr)
	Remove overlappping rectangles. More...

leResult	leRectArray_CropToArea (leRectArray *arr, uint32_t width, uint32_t height)
	Crops rectange by width and height. More...

leResult	leRectArray_CropToSizeY (leRectArray *arr, uint32_t size)
	Slices an array of rectangles to a given pixel count. More...

leResult	leRectArray_CropToSizeX (leRectArray *arr, uint32_t size)
	Slices an array of rectangles to a given pixel count. More...

Detailed Description

An array implementation for storing rectangles for the Legato user interface library.

This is an array implementation that is used internally by the Legato user interface library.

Function Documentation

◆ leRectArray_Clear()

leResult leRectArray_Clear ( leRectArray * arr )

Removes all values from a given array.

Removes all values from arr. Array capacity remains the same.

leRectArray* arr;

leResult res = leRectArray_Clear(arr)

Parameters

arr	is the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_Copy()

leResult leRectArray_Copy	(	leRectArray *	src,
		leRectArray *	dest
	)

Copy array.

Copys the contents of src to the array pointed to by dest.

leRectArray* src;
leRectArray* dest;
leResult res = leRectArray_Copy(arr, dest)

Parameters

src	is the source array.
dest	is the destination array.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_Create()

leResult leRectArray_Create ( leRectArray * arr )

Creates a new rectangle.

Creates a new rectangle arr.

leArray* arr;

leResult res = leRectArray_Create(arr)

Parameters

arr	is array to initialize.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_CropToArea()

leResult leRectArray_CropToArea	(	leRectArray *	arr,
		uint32_t	width,
		uint32_t	height
	)

Crops rectange by width and height.

Crops arr to given width and height. Any remainder will be moved into a new rectangle and will be cropped again if needed.

leRectArray* arr;
uint32_t width;
uint32_t height;
leResult res = leRectArray_CropToArea(arr, width, height);

Parameters

arr	the array to modify.
width	the crop width.
height	arr the crop height.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the call graph for this function:

◆ leRectArray_CropToSizeX()

leResult leRectArray_CropToSizeX	(	leRectArray *	arr,
		uint32_t	size
	)

Slices an array of rectangles to a given pixel count.

Crops arr to given width and size. This method attempts to keep the rectangle slices as tall as possible.

leRectArray* arr;
uint32_t size;
leResult res = leRectArray_CropToSizeX(arr, size);

Parameters

arr	the array to modify.
size	the number of pixels to crop to.

Returns: LE_SUCCESS , otherwise LE_FAILURE.

◆ leRectArray_CropToSizeY()

leResult leRectArray_CropToSizeY	(	leRectArray *	arr,
		uint32_t	size
	)

Slices an array of rectangles to a given pixel count.

Crops arr to given width and size. This method attempts to keep the rectangle slices as wide as possible.

leRectArray* arr;
uint32_t size;
leResult res = leRectArray_CropToSizeY(arr, size);

Parameters

arr	the array to modify.
size	the number of pixels to crop to.

Returns: LE_SUCCESS , otherwise LE_FAILURE.

◆ leRectArray_Destroy()

leResult leRectArray_Destroy ( leRectArray * arr )

Destroy array.

Removes all values from arr. Array capacity is set to 0. leRectArray* arr; leResult res = leRectArray_Destroy(arr)

Parameters

arr	the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_InsertAt()

leResult leRectArray_InsertAt	(	leRectArray *	arr,
		uint32_t	idx,
		const leRect *	rect
	)

Inserts a rectangle into an array at a given index.

Inserts rect into the arr at the specified idx. All existing values from index are shifted right one place.

leRectArray* arr;
uint32_t idx;
leRect* val;
leResult res = leRectArray_InsertAt(arr idx, val)

Parameters

arr	is the array to modify.
idx	is the location at which to insert value.
val	is value to insert.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_MergeSimilar()

leResult leRectArray_MergeSimilar ( leRectArray * arr )

Merge rectangles.

Merges similar rectangles in arr.

leRectArray* arr;

leResult res = leRectArray_MergeSimilar(arr)

Parameters

arr	the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the call graph for this function:

◆ leRectArray_PopBack()

leResult leRectArray_PopBack ( leRectArray * arr )

Removes the last rectangle from the array.

Removes the last value from the back of arr.

leRectArray* arr;

leResult res = leRectArray_PopBack(arr)

Parameters

arr	is the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_PopFront()

leResult leRectArray_PopFront ( leRectArray * arr )

Removes the first value from the array.

Removes the first value from the front of arr. This function shuffles all other values forward one index.

leRectArray* arr;

leRectArray_PopFront(arr)

Parameters

arr	The pointer to the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_PushBack()

leResult leRectArray_PushBack	(	leRectArray *	arr,
		const leRect *	rect
	)

Push value on back.

Pushes val onto the back of arr.

leArray* arr;
leRect* val;
leResult res = leRectArray_PushBack(arr, val)

Parameters

arr	is the array to modify.
val	is the value to push.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the caller graph for this function:

◆ leRectArray_PushFront()

leResult leRectArray_PushFront	(	leRectArray *	arr,
		const leRect *	rect
	)

Pushes a new rectangle onto the front of the array.

Pushes val onto the front of arr. This function shuffles all other values backward one index.

leRectArray* arr;
leRect* val;
leResult res = leRectArray_PushFront(arr, val)

Parameters

arr	is the array to modify.
val	is the value to push.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_RemoveAt()

leResult leRectArray_RemoveAt	(	leRectArray *	arr,
		uint32_t	idx
	)

Removes a rectangle from the array at an index.

Removes the rectangle at idx from arr.

leRectArray* arr;
uint32_t idx;
leResult res = leRectArray_RemoveAt(arr idx)

Parameters

arr	is the array to modify.
idx	is the location at which to insert value.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the caller graph for this function:

◆ leRectArray_RemoveDuplicates()

leResult leRectArray_RemoveDuplicates ( leRectArray * arr )

Removes any duplicate rectangles from an array.

Removes all duplicates from arr.

leRectArray* arr;

leResult res = leRectArray_RemoveDuplicates(arr)

Parameters

arr	the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_RemoveOverlapping()

leResult leRectArray_RemoveOverlapping ( leRectArray * arr )

Remove overlappping rectangles.

Removes overlapping rectangles in arr. The function first sorts the array by size then removes any rectangles that are completely overlapped by another larger rectangle.

leRectArray* arr;

leResult res = leRectArray_RemoveOverlapping(arr)

Parameters

arr	the array to modify.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the call graph for this function:

◆ leRectArray_Resize()

leResult leRectArray_Resize	(	leRectArray *	arr,
		uint32_t	sz
	)

Resizes the capacity of the array.

Expands (or shrinks) an array arr to the specified sz.

If the array shrinks, any nodes beyond the new capacity will be discarded.

leArray* arr;
uint32_t sz;
leResult res = leArray_Resize(arr, sz)

Parameters

arr	The pointer to the array to resize.
sz	The desired capacity.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_SortBySize()

leResult leRectArray_SortBySize ( leRectArray * arr )

Sorts a given array.

Sorts values in arr from largest to smallest.

leRectArray* arr;

leResult res = leRectArray_SortBySize(arr)

Parameters

arr	is the array to sort.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the caller graph for this function:

◆ leRectArray_SortByX()

leResult leRectArray_SortByX ( leRectArray * arr )

Sort array by X coordinate.

Sorts the values in arr in order of the X coordinate.

leRectArray* arr;

leResult res = leRectArray_SortByX(arr)

Parameters

arr	the array to sort.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leRectArray_SortByY()

leResult leRectArray_SortByY ( leRectArray * arr )

Sort array by Y coordinate.

Sorts the values in arr in order of the Y coordinate.

leRectArray* arr;

leResult res = leRectArray_SortByY(arr)

Parameters

arr	the array to analyze.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Data Structures

Typedefs

Functions

Detailed Description

Function Documentation

◆ leRectArray_Clear()

◆ leRectArray_Copy()

◆ leRectArray_Create()

◆ leRectArray_CropToArea()

◆ leRectArray_CropToSizeX()

◆ leRectArray_CropToSizeY()

◆ leRectArray_Destroy()

◆ leRectArray_InsertAt()

◆ leRectArray_MergeSimilar()

◆ leRectArray_PopBack()

◆ leRectArray_PopFront()

◆ leRectArray_PushBack()

◆ leRectArray_PushFront()

◆ leRectArray_RemoveAt()

◆ leRectArray_RemoveDuplicates()

◆ leRectArray_RemoveOverlapping()

◆ leRectArray_Resize()

◆ leRectArray_SortBySize()

◆ leRectArray_SortByX()

◆ leRectArray_SortByY()