vg_helper.h

Go to the documentation of this file.

/*
 * C
 *
 * Copyright 2020-2026 MicroEJ Corp. All rights reserved.
 * MicroEJ Corp. PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */
 
#if !defined VG_HELPER_H
#define VG_HELPER_H
 
#if defined __cplusplus
extern "C" {
#endif
 
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
 
// cppcheck-suppress [misra-c2012-21.6] required to use "printf"
#include <stdio.h>
 
#include <sni.h>
 
#include "mej_log.h"
 
// -----------------------------------------------------------------------------
// Macros and Defines
// -----------------------------------------------------------------------------
 
#if defined MEJ_LOG_INFO_LEVEL && defined MEJ_LOG_MICROVG
#define MEJ_LOG_INFO_MICROVG(fmt, ...) MEJ_LOG(INFO, MICROVG, fmt, ## __VA_ARGS__)
#else
#define MEJ_LOG_INFO_MICROVG(fmt, ...)
#endif
 
// Errors should always be printed
#define MEJ_LOG_ERROR_MICROVG(fmt, ...) MEJ_LOG(ERROR, MICROVG, fmt, ## __VA_ARGS__)
 
//#define MICROVG_MONITOR_HEAP
 
#define VG_HELPER_NULL_GRADIENT 0
 
#define FT_FACE_FLAG_COMPLEX_LAYOUT  (((uint32_t)1) << 31)
 
#ifndef M_PI
#define M_PI 3.1415926535
#endif
 
#define RAD_TO_DEG(r) ((r) * (180.0f / M_PI))
#define DEG_TO_RAD(d) (((d) * M_PI) / 180.0f)
 
#define JFLOAT_TO_UINT32_t(f) (*(uint32_t *)&(f))
#define UINT32_t_TO_JFLOAT(i) (*(float *)&(i))
 
#define REGISTERDESC(desc, buf, buf_len) if ((buf_len) >= sizeof(desc)) { (void)memcpy((buf), (desc), sizeof(desc)); }
 
// --------------------------------------------------------------------------------
// UI Pack > 14.5.1 function
// --------------------------------------------------------------------------------
 
void LLUI_DISPLAY_waitAsynchronousDrawingEnd(void);
 
// -----------------------------------------------------------------------------
// API
// -----------------------------------------------------------------------------
 
int VG_HELPER_get_utf(const unsigned short *text, int length, int *offset);
 
/*
 * @brief Configures the font layouter with a font and a text
 *
 * @param[in] faceHandle: handle on font face.
 * @param[in] text: text buffer encoded in UTF16 where to read UTF character.
 * @param[in] length: text buffer length.
 *
 */
void VG_HELPER_layout_configure(int faceHandle, const unsigned short *text, int length);
 
/*
 * @brief Loads the next layouted glyph and gets index and positions.
 *
 * @param[out] glyph_idx: next glyph index.
 * @param[out] x_advance: the horizontal advance to add to the cursor position after drawing the glyph.
 * @param[out] y_advance: the vertical advance to add to thecursor after drawing the glyph.
 * @param[out] x_offset: the hozizontal offset of the glyph, does not affect the cursor position.
 * @param[out] y_offset: the vertical offset of the glyph, does not affect the cursor position.
 *
 * @return true if a glyph is available otherwise false.
 */
bool VG_HELPER_layout_load_glyph(uint32_t *glyph_idx, int *x_advance, int *y_advance, int *x_offset, int *y_offset);
 
/*
 * @brief Checks if the matrix is null. In that case, returns an identity matrix.
 * This allows to prevent to make some checks on the matrix in the algorithms.
 *
 * The identity matrix can be used several times by the same algorithm. The caller
 * must not modify it (read-only matrix).
 *
 * @param[in] the matrix to check
 *
 * @return the matrix or an identity matrix
 */
const jfloat * VG_HELPER_check_matrix(const jfloat *matrix);
 
/*
 * @brief Applies the global opacity on given color.
 *
 * @param[in] color: the 32-bit color.
 * @param[in] alpha: the opacity.
 *
 * @return the new color.
 */
uint32_t VG_HELPER_apply_alpha(uint32_t color, uint32_t alpha);
 
/*
 * @brief Converts a MicroVG matrix in another MicroVG matrix applying a translation.
 *
 * @param[out] dest the MicroVG matrix to set
 * @param[in] x the X translation to apply
 * @param[in] y the Y translation to apply
 * @param[in] matrix the MicroVG transformation to apply (can be null)
 */
void VG_HELPER_prepare_matrix(jfloat *dest, jfloat x, jfloat y, const jfloat *matrix);
 
// -----------------------------------------------------------------------------
// EOF
// -----------------------------------------------------------------------------
 
#ifdef __cplusplus
}
#endif
 
#endif // !defined VG_HELPER_H