legato_rectarray.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/
 
/*******************************************************************************
 Module for Microchip Graphics Library - Legato User Interface Library
 
  Company:
    Microchip Technology Inc.
 
  File Name:
    legato_rectarray.h
 
  Summary:
    An array implementation for storing rectangles for the
    Legato user interface library
 
  Description:
    This is an array implementation that is used internally by the 
    Legato user interface library.  
*******************************************************************************/
 
#ifndef LEGATO_RECTARRAY_H
#define LEGATO_RECTARRAY_H
 
#include "gfx/legato/common/legato_common.h"
 
// *****************************************************************************
/* Structure:
    leRectArray
 
  Summary:
    Rectangle array definition
 
  Remarks:
    None.
*/
 
typedef struct leRectArray
{
    leRect* rects;  
    uint32_t size;  
    uint32_t capacity;  
} leRectArray;
 
// *****************************************************************************
 
LIB_EXPORT leResult leRectArray_Create(leRectArray* arr);
 
 
// *****************************************************************************
 
LIB_EXPORT leResult leRectArray_Resize(leRectArray* arr, uint32_t sz);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_PushFront(leRectArray* arr,
                                          const leRect* rect);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_PopFront(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_PushBack(leRectArray* arr, const leRect* rect);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_PopBack(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_InsertAt(leRectArray* arr,
                                         uint32_t idx,
                                         const leRect* rect);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_RemoveAt(leRectArray* arr, uint32_t idx);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_Copy(leRectArray* src, leRectArray* dest);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_Clear(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_Destroy(leRectArray* arr);
 
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_RemoveDuplicates(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_SortBySize(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_SortByX(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_SortByY(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_MergeSimilar(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_RemoveOverlapping(leRectArray* arr);
 
// *****************************************************************************
LIB_EXPORT leResult leRectArray_CropToArea(leRectArray* arr,
                                           uint32_t width,
                                           uint32_t height);
 
 
// *****************************************************************************
leResult leRectArray_CropToSizeY(leRectArray* arr, uint32_t size);
 
// *****************************************************************************
leResult leRectArray_CropToSizeX(leRectArray* arr, uint32_t size);
 
#endif /* LEGATO_RECTARRAY_H */