gl_types.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
 
#ifndef _GL_TYPES_H_
#define _GL_TYPES_H_
 
#include "gl_colors.h"
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
typedef enum
{
    GL_BRUSH_STYLE_NONE = 0,                      
    GL_BRUSH_STYLE_FILL,                              
    GL_BRUSH_STYLE_GRADIENT_TOP_DOWN,   
    GL_BRUSH_STYLE_GRADIENT_LEFT_RIGHT   
    // GL_BRUSH_STYLE_IMAGE_PATTERN         //TODO: Implement in drawing function.
    // GL_BRUSH_STYLE_GRADIENT_LINEAR       //TODO: Implement in drawing function.
} gl_brush_style_t;
 
 
typedef enum
{
    GL_IMAGE_FORMAT_BITMAP_1BPP  = 0x01,    
    GL_IMAGE_FORMAT_BITMAP_4BPP = 0x04,     
    GL_IMAGE_FORMAT_BITMAP_8BPP  = 0x08,    
    GL_IMAGE_FORMAT_BITMAP_16BPP = 0x10,   
    GL_IMAGE_FORMAT_JPEG = 0x20                  
} gl_image_format_t;
 
typedef enum
{
    GL_FONT_HORIZONTAL = 0,    
    GL_FONT_VERTICAL,               
    GL_FONT_VERTICAL_COLUMN   
} gl_font_orientation_t;
 
typedef int16_t  gl_int_t;    
typedef uint16_t gl_uint_t;  
typedef int32_t  gl_long_int_t;    
typedef uint32_t gl_long_uint_t;  
typedef uint16_t gl_angle_t; 
typedef int16_t gl_coord_t; 
typedef struct
{
    gl_int_t x;   
    gl_int_t y;   
} gl_point_t;
 
typedef struct
{
    gl_uint_t width;    
    gl_uint_t height;   
} gl_size_t;
 
typedef struct
{
    gl_point_t  top_left;  
    uint16_t  width;    
    uint16_t height;    
} gl_rectangle_t;
 
 
typedef void (*gl_fill_t)(gl_rectangle_t *rect, gl_color_t color);  
typedef void (*gl_begin_frame_t)(gl_rectangle_t *rect); 
typedef void (*gl_frame_data_t)(gl_color_t color); 
typedef void (*gl_end_frame_t)(); 
typedef struct
{
    uint16_t  display_width;             
    uint16_t display_height;             
    gl_fill_t         fill_f;                       
    gl_begin_frame_t  begin_frame_f;  
    gl_frame_data_t   frame_data_f;   
    gl_end_frame_t    end_frame_f;    
} gl_driver_t;
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // _GL_TYPES_H_
// ------------------------------------------------------------------------- END