Files
test/source/blender/blenkernel/BKE_vfontdata.hh
Campbell Barton 569ff08de0 Refactor: move VFontData metrics into their own struct
Prepare to support default metrics for placeholder text.
2024-12-14 13:32:19 +11:00

68 lines
1.8 KiB
C++

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup bke
* \brief A structure to represent vector fonts,
* and to load them from PostScript fonts.
*/
#include "DNA_listBase.h"
struct GHash;
struct PackedFile;
struct VFont;
/**
* Font metric values explained:
*
* Baseline: Line where the text "rests", used as the origin vertical position for the glyphs.
* Em height: Space most glyphs should fit within.
* Ascent: the recommended distance above the baseline to fit most characters.
* Descent: the recommended distance below the baseline to fit most characters.
*
* We obtain ascent and descent from the font itself (`FT_Face->ascender / face->height`).
* And in some cases it is even the same value as `FT_Face->bbox.yMax / yMin`.
* (font top and bottom respectively).
*
* The `em_ratio` here is relative to `FT_Face->bbox`.
*/
struct VFontData_Metrics {
float scale;
/* Calculated from the font. */
float em_ratio;
float ascend_ratio;
};
struct VFontData {
GHash *characters;
char name[128];
VFontData_Metrics metrics;
};
struct VChar {
ListBase nurbsbase;
float width;
};
/**
* Default metrics to use when the font wont load.
*/
void BKE_vfontdata_metrics_get_defaults(VFontData_Metrics *metrics);
/**
* Construct a new #VFontData structure from free-type font data in `pf`.
*
* \param pf: The font data.
* \retval A new #VFontData structure, or NULL if unable to load.
*/
VFontData *BKE_vfontdata_from_freetypefont(PackedFile *pf);
VFontData *BKE_vfontdata_copy(const VFontData *vfont_src, int flag);
VChar *BKE_vfontdata_char_from_freetypefont(VFont *vfont, unsigned int character);
VChar *BKE_vfontdata_char_copy(const VChar *vchar_src);