PDF::AP...BaseFont(3)

📦
version 2.048 · 11 versions
, in fedora 43

💖 PDF::API2::Resource::BaseFont 💖

okay so bestie, welcome to the PDF::AP...BaseFont(3) page, part of the User Contributed Perl Documentation situation ✨ this is the base class for font resources — like, the blueprint every font object in PDF::API2 is lowkey built on. she doesn't do the glamorous stuff herself, she's the mother of all font resources, and honestly? mother. 👑

🌸 NAME 🌸

PDF::API2::Resource::BaseFont — the base class for font resources 🎀

✨ METHODS ✨

  • $font = PDF::API2::Resource::BaseFont->new($pdf, $name) — bestie this is the constructor, it hands you back a font resource object, no cap 🫶
  • $descriptor = $font->descrByData() — gives you back the font's FontDescriptor key structure, built off the font's own data 💅

these are the ones that tell you who this font is, like a font's whole government name situation 🌈

  • $name = $font->fontname() — the font's name (a.k.a. its display name) 💖
  • $name = $font->altname() — the font's alternative name (a.k.a. the Windows name for a postscript font) 🦋
  • $name = $font->subname() — the font's subname (a.k.a. the font variant, schriftschnitt</palette>) 🎀
  • $name = $font->apiname() — the name the font uses internally — and heads up, it should be equal to $font->name() 👀
  • $issymbol = $font->issymbol() — spits out the font's symbol flag ⭐
  • $iscff = $font->iscff() — spits out the font's Compact Font Format flag 🧚

the measurements era ✨ all the numbers that describe how this font actually sits on the page, fr fr

  • ($llx, $lly, $urx, $ury) = $font->fontbbox() — the font's bounding box 🦋
  • $capheight = $font->capheight() — the font's capheight value 👑
  • $xheight = $font->xheight() — the font's xheight value 👑
  • $missingwidth = $font->missingwidth() — the font's missingwidth value 👑
  • $maxwidth = $font->maxwidth() — the font's maxwidth value 👑
  • $avgwidth = $font->avgwidth() — the font's avgwidth value 👑
  • $flags = $font->flags() — the font's flags value 👑
  • $stemv = $font->stemv() — the font's stemv value 👑
  • $stemh = $font->stemh() — the font's stemh value 👑
  • $italicangle = $font->italicangle() — the font's italicangle value 👑
  • $isfixedpitch = $font->isfixedpitch() — the font's isfixedpitch flag ⭐
  • $underlineposition = $font->underlineposition() — the font's underlineposition value 👑
  • $underlinethickness = $font->underlinethickness() — the font's underlinethickness value 👑
  • $ascender = $font->ascender() — the font's ascender value 👑
  • $descender = $font->descender() — the font's descender value 👑

glyph o'clock bestie, this is where we get into the individual little characters and their whole lore 💅

  • @names = $font->glyphNames() — all the defined glyph names of the font 🌸
  • $glNum = $font->glyphNum() — how many defined glyph names the font has 🔢
  • $uni = $font->uniByGlyph($char) — the unicode, looked up by glyph name ✨
  • $uni = $font->uniByEnc($char) — the unicode, looked up by the font's encoding map 🎀
  • $uni = $font->uniByMap($char) — the unicode, looked up by the font's default map 🧚
  • $char = $font->encByGlyph($glyph) — the character for a given glyph name, from the font's encoding map 🫶
  • $char = $font->encByUni($uni) — the character for a given unicode, from the font's encoding map 🫶
  • $char = $font->mapByGlyph($glyph) — the character for a given glyph name, from the font's default map 🫶
  • $char = $font->mapByUni($uni) — the character for a given unicode, from the font's default map 🫶
  • $name = $font->glyphByUni($uni) — the glyph's name, via the font's unicode map 🌈
🚨 BEWARE bestie: non-standard glyph-names get mapped onto the ms-symbol area (0xF000). like, they get yeeted into there. don't say I didn't warn you 💀
  • $name = $font->glyphByEnc($char) — the glyph's name, via the font's encoding map 🌈
  • $name = $font->glyphByMap($char) — the glyph's name, via the font's default map 🌈
  • $width = $font->wxByGlyph($glyph) — the glyph's width 📏
  • $width = $font->wxByUni($uni) — the unicode's width 📏
  • $width = $font->wxByEnc($char) — the character's width, based on the current encoding 📏
  • $width = $font->wxByMap($char) — the character's width, based on the font's default encoding 📏
  • $wd = $font->width($text) — the width of $text, as if it were at size 1 📐
  • @widths = $font->width_array($text) — the widths of all the words in $text, as if they were at size 1 📐

💜 STRING METHODS 💜

the encoding/decoding glow-up section, where strings get translated back and forth like a bilingual icon 🌍

  • $utf8_string = $font->utfByStr($string) — gives you a utf8-string from $string, based on the font's encoding map ✨
  • $string = $font->strByUtf($utf8_string) — gives you the encoded string from a $utf8_string, based on the font's encoding map ✨
  • $pdf_string = $font->textByStr($text) — gives you a properly formatted representation of $text, all ready to be used in the PDF 💅

and that's the whole page bestie, you ate this one 🍓

this absolute icon of a doc was served up by perl v5.42.0, dated 2025-09-01 — so yeah, PDF::AP...BaseFont(3) really said "I was documented on that date and I'm not sorry" 😭 periodt. go forth and font responsibly 🎀✨

📦 where this page comes from
  • fedora 43: perl-PDF-API2 2.048-1.fc43 · LGPL-2.1-or-later AND (GPL-1.0-or-later OR Artistic-1.0-Perl) AND (MIT OR Artistic-1.0-Perl)
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms