vg_configuration.h

Go to the documentation of this file.

/*
 * C
 *
 * Copyright 2020-2025 MicroEJ Corp. All rights reserved.
 * MicroEJ Corp. PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */
 
#if !defined VG_CONFIGURATION_H
#define VG_CONFIGURATION_H
 
#if defined __cplusplus
extern "C" {
#endif
 
#error \
    "This header must be customized with platform specific configuration. Remove this #error when done. This file is not modified when a new version of the CCO is installed."
 
#define MICROVG_CONFIGURATION_VERSION (4)
 
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
 
#include "ui_configuration.h"
 
// -----------------------------------------------------------------------------
// MicroVG's Path Options
// -----------------------------------------------------------------------------
 
/*
 * @brief Value of "VG_FEATURE_PATH" to use only one array to store the path's
 * commands and the commands' parameters.
 */
#define VG_FEATURE_PATH_SINGLE_ARRAY (1)
 
/*
 * @brief Value of "VG_FEATURE_PATH" to use two arrays to store the path's data:
 * one for the commands and one for the commands' parameters.
 */
#define VG_FEATURE_PATH_DUAL_ARRAY (2)
 
// -----------------------------------------------------------------------------
// MicroVG's LinearGradient Options
// -----------------------------------------------------------------------------
 
/*
 * @brief Value of "VG_FEATURE_GRADIENT" to use a full implementation of the
 * MicroVG's LinearGradient.
 *
 * This implementation holds an array of all colors and positions set by the
 * application.
 */
#define VG_FEATURE_GRADIENT_FULL (1)
 
/*
 * @brief Value of "VG_FEATURE_GRADIENT" to use a reduced implementation of the
 * MicroVG's LinearGradient.
 *
 * This implementation keeps only the first color set by the application when
 * inializing a gradient.
 */
#define VG_FEATURE_GRADIENT_FIRST_COLOR (2)
 
// -----------------------------------------------------------------------------
// MicroVG's VectorFont Options
// -----------------------------------------------------------------------------
 
/*
 * @brief Value of "VG_FEATURE_FONT" to use FreeTYPE as implementation of the
 * MicroVG's VectorFont.
 *
 * This implementation configures FreeTYPE to manipulate the font's glyphs as a
 * succession of vector paths. It requires a "vector" renderer.
 */
#define VG_FEATURE_FONT_FREETYPE_VECTOR (1)
 
/*
 * @brief Value of "VG_FEATURE_FONT" to use FreeTYPE as implementation of the
 * MicroVG' VectorFont.
 *
 * This implementation configures FreeTYPE to manipulate the font's glyphs as
 * bitmaps. No renderer is required
 */
#define VG_FEATURE_FONT_FREETYPE_BITMAP (2)
 
// -----------------------------------------------------------------------------
// MicroVG's Features Implementation
// -----------------------------------------------------------------------------
 
/*
 * @brief Set this define to embed the implementation of the MicroVG's
 * Path (dynamic path creation and path rendering).
 *
 * This implementation holds the path's commands and paramters defined by the
 * application. The define value specifies how this data is stored (one or two arrays).
 *
 * When not set, a stub implementation is used. No error is thrown at runtime when
 * the application uses a path: the dynamic path are not created and the path
 * rendering is not performed.
 */
#ifndef VG_FEATURE_PATH
#define VG_FEATURE_PATH VG_FEATURE_PATH_SINGLE_ARRAY
#endif
 
/*
 * @brief Set this define to specify the implementation of the MicroVG's
 * LinearGradient (dynamic gradient creation and drawings with gradient).
 *
 * @see VG_FEATURE_GRADIENT_FULL
 * @see VG_FEATURE_GRADIENT_FIRST_COLOR
 *
 * When not set, a stub implementation is used. No error is thrown at runtime when
 * the application uses a gradient: the dynamic gradient are not created and the
 * gradient rendering is not performed.
 */
#ifndef VG_FEATURE_GRADIENT
#define VG_FEATURE_GRADIENT VG_FEATURE_GRADIENT_FULL
#endif
 
/*
 * @brief Set this define to specify the implementation of the MicroVG'
 * VectorFont (dynamic font loading and text rendering).
 *
 * @see VG_FEATURE_FONT_FREETYPE_VECTOR
 * @see VG_FEATURE_FONT_FREETYPE_BITMAP
 *
 * When not set, a stub implementation is used. The application cannot load a font
 * (and by consequence cannot draw a text).
 */
#ifndef VG_FEATURE_FONT
#define VG_FEATURE_FONT VG_FEATURE_FONT_FREETYPE_VECTOR
#endif
 
/*
 * @brief Uncomment this define to enable the support of TTF font files.
 *
 */
//#define VG_FEATURE_FREETYPE_TTF
 
/*
 * @brief Uncomment this define to enable the support of OTF font files.
 *
 */
//#define VG_FEATURE_FREETYPE_OTF
 
/*
 * @brief Uncomment this define to enable the support of colored emoji.
 *
 */
//#define VG_FEATURE_FREETYPE_COLORED_EMOJI
 
/*
 * @brief Uncomment this define to enable the support of complex layout.
 *
 * When set, the complex layout feature is disabled by default (the Freetype layout
 * manager is used). See functions MICROVG_HELPER_set_complex_layout() and
 * MICROVG_HELPER_has_complex_layouter().
 *
 * Note: the complex layout feature is managed by the Harfbuzz engine.
 *       Harfbuzz is used beside Freetype, thus the FT_CONFIG_OPTION_USE_HARFBUZZ define
 *       is not needed. This implementation has been chosen to ease the replacement of
 *       harfbuzz by an other complex layouter.
 */
#define VG_FEATURE_FONT_COMPLEX_LAYOUT
//#define VG_FEATURE_FONT_COMPLEX_LAYOUT
 
/*
 * @brief Uncomment this define to allow to load external font files. When a font
 * file is not available in the application classpath, the implementation tries to
 * load it from an external resource system.
 *
 * The Platform must embbed the module "External Resource" and the BSP must implement
 * "LLEXT_RES_impl.h" header file.
 *
 * When not set, only the resources compiled with the application are used.
 */
//#define VG_FEATURE_FONT_EXTERNAL
 
/*
 * @brief Configure this define to set the freetype heap size
 *
 * The freetype heap size depends on the font used by the application
 * @see MICROVG_MONITOR_HEAP in vg_helper.h to monitor the heap usage evolution.
 */
#ifndef VG_FEATURE_FREETYPE_HEAP_SIZE
#define VG_FEATURE_FREETYPE_HEAP_SIZE (80 * 1024)
#endif
 
/*
 * @brief Configure this define to set the complex layouter heap size
 *
 *@see VG_FEATURE_FONT_COMPLEX_LAYOUT
 *
 * The complex layouter heap size depends on the font used by the application
 * @see MICROVG_MONITOR_HEAP in vg_helper.h to monitor the heap usage evolution.
 */
#ifdef VG_FEATURE_FONT_COMPLEX_LAYOUT
#define VG_FEATURE_FONT_COMPLEX_LAYOUT_HEAP_SIZE (80 * 1024)
#endif
 
/*
 * @brief Set this define to enable the support of MicroVG BufferedVectorImage.
 * This feature requires the available number of supported GraphicsContext formats
 * is higher than 1.
 *
 * Comment the define VG_FEATURE_BUFFERED_VECTOR_IMAGE to remove the support of
 * BufferedVectorImage (even if the available number of supported GraphicsContext
 * formats is higher than 1).
 */
#if defined(UI_GC_SUPPORTED_FORMATS) && (UI_GC_SUPPORTED_FORMATS > 1)
 
/*
 * @brief Uncomment the define VG_FEATURE_BUFFERED_VECTOR_IMAGE to enable the support
 * of BufferedVectorImage.
 */
//#define VG_FEATURE_BUFFERED_VECTOR_IMAGE
 
/*
 * @brief The drawing functions to target the BufferedVectorImage have by default the
 * identifier 1.
 */
#ifndef UI_DRAWING_IDENTIFIER_BVI_FORMAT
#define UI_DRAWING_IDENTIFIER_BVI_FORMAT 1
#endif
 
#elif defined(VG_FEATURE_BUFFERED_VECTOR_IMAGE)
#error "The BufferedVectorImage feature requires the support of several Graphics Context formats".
#endif // if defined(UI_GC_SUPPORTED_FORMATS) && (UI_GC_SUPPORTED_FORMATS > 1)
 
// -----------------------------------------------------------------------------
// EOF
// -----------------------------------------------------------------------------
 
#ifdef __cplusplus
}
#endif
 
#endif // !defined VG_CONFIGURATION_H