🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1443 lines
34 KiB

  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="API Reference Documentation for FreeType-2.11.0">
  7. <meta name="author" content="FreeType Contributors">
  8. <link rel="icon" href="images/favico.ico">
  9. <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9">
  10. <title>BDF and PCF Files - FreeType-2.11.0 API Reference</title>
  11. <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css">
  12. <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css">
  13. <meta name="theme-color" content="#4cae4f">
  14. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  15. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
  16. <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style>
  17. <link rel="stylesheet" href="stylesheets/extra.css">
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green">
  20. <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#bdf-and-pcf-files" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <header class="md-header" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
  34. <img src="images/favico.ico" alt="logo">
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. FreeType-2.11.0 API Reference
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. BDF and PCF Files
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <label class="md-header__button md-icon" for="__search">
  54. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  55. </label>
  56. <div class="md-search" data-md-component="search" role="dialog">
  57. <label class="md-search__overlay" for="__search"></label>
  58. <div class="md-search__inner" role="search">
  59. <form class="md-search__form" name="search">
  60. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  61. <label class="md-search__icon md-icon" for="__search">
  62. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  64. </label>
  65. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  66. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  67. </button>
  68. </form>
  69. <div class="md-search__output">
  70. <div class="md-search__scrollwrap" data-md-scrollfix>
  71. <div class="md-search-result" data-md-component="search-result">
  72. <div class="md-search-result__meta">
  73. Initializing search
  74. </div>
  75. <ol class="md-search-result__list"></ol>
  76. </div>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. </nav>
  82. </header>
  83. <div class="md-container" data-md-component="container">
  84. <main class="md-main" data-md-component="main">
  85. <div class="md-main__inner md-grid">
  86. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  87. <div class="md-sidebar__scrollwrap">
  88. <div class="md-sidebar__inner">
  89. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  90. <label class="md-nav__title" for="__drawer">
  91. <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
  92. <img src="images/favico.ico" alt="logo">
  93. </a>
  94. FreeType-2.11.0 API Reference
  95. </label>
  96. <ul class="md-nav__list" data-md-scrollfix>
  97. <li class="md-nav__item">
  98. <a href="index.html" class="md-nav__link">
  99. TOC
  100. </a>
  101. </li>
  102. <li class="md-nav__item">
  103. <a href="ft2-index.html" class="md-nav__link">
  104. Index
  105. </a>
  106. </li>
  107. <li class="md-nav__item md-nav__item--nested">
  108. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  109. <label class="md-nav__link" for="__nav_3">
  110. General Remarks
  111. <span class="md-nav__icon md-icon"></span>
  112. </label>
  113. <nav class="md-nav" aria-label="General Remarks" data-md-level="1">
  114. <label class="md-nav__title" for="__nav_3">
  115. <span class="md-nav__icon md-icon"></span>
  116. General Remarks
  117. </label>
  118. <ul class="md-nav__list" data-md-scrollfix>
  119. <li class="md-nav__item">
  120. <a href="ft2-preamble.html" class="md-nav__link">
  121. Preamble
  122. </a>
  123. </li>
  124. <li class="md-nav__item">
  125. <a href="ft2-header_inclusion.html" class="md-nav__link">
  126. FreeType's header inclusion scheme
  127. </a>
  128. </li>
  129. <li class="md-nav__item">
  130. <a href="ft2-user_allocation.html" class="md-nav__link">
  131. User allocation
  132. </a>
  133. </li>
  134. </ul>
  135. </nav>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  139. <label class="md-nav__link" for="__nav_4">
  140. Core API
  141. <span class="md-nav__icon md-icon"></span>
  142. </label>
  143. <nav class="md-nav" aria-label="Core API" data-md-level="1">
  144. <label class="md-nav__title" for="__nav_4">
  145. <span class="md-nav__icon md-icon"></span>
  146. Core API
  147. </label>
  148. <ul class="md-nav__list" data-md-scrollfix>
  149. <li class="md-nav__item">
  150. <a href="ft2-version.html" class="md-nav__link">
  151. FreeType Version
  152. </a>
  153. </li>
  154. <li class="md-nav__item">
  155. <a href="ft2-basic_types.html" class="md-nav__link">
  156. Basic Data Types
  157. </a>
  158. </li>
  159. <li class="md-nav__item">
  160. <a href="ft2-base_interface.html" class="md-nav__link">
  161. Base Interface
  162. </a>
  163. </li>
  164. <li class="md-nav__item">
  165. <a href="ft2-glyph_variants.html" class="md-nav__link">
  166. Unicode Variation Sequences
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="ft2-color_management.html" class="md-nav__link">
  171. Glyph Color Management
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="ft2-layer_management.html" class="md-nav__link">
  176. Glyph Layer Management
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="ft2-glyph_management.html" class="md-nav__link">
  181. Glyph Management
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="ft2-mac_specific.html" class="md-nav__link">
  186. Mac Specific Interface
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="ft2-sizes_management.html" class="md-nav__link">
  191. Size Management
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="ft2-header_file_macros.html" class="md-nav__link">
  196. Header File Macros
  197. </a>
  198. </li>
  199. </ul>
  200. </nav>
  201. </li>
  202. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
  204. <label class="md-nav__link" for="__nav_5">
  205. Format-Specific API
  206. <span class="md-nav__icon md-icon"></span>
  207. </label>
  208. <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
  209. <label class="md-nav__title" for="__nav_5">
  210. <span class="md-nav__icon md-icon"></span>
  211. Format-Specific API
  212. </label>
  213. <ul class="md-nav__list" data-md-scrollfix>
  214. <li class="md-nav__item">
  215. <a href="ft2-multiple_masters.html" class="md-nav__link">
  216. Multiple Masters
  217. </a>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="ft2-truetype_tables.html" class="md-nav__link">
  221. TrueType Tables
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="ft2-type1_tables.html" class="md-nav__link">
  226. Type 1 Tables
  227. </a>
  228. </li>
  229. <li class="md-nav__item">
  230. <a href="ft2-sfnt_names.html" class="md-nav__link">
  231. SFNT Names
  232. </a>
  233. </li>
  234. <li class="md-nav__item md-nav__item--active">
  235. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  236. <label class="md-nav__link md-nav__link--active" for="__toc">
  237. BDF and PCF Files
  238. <span class="md-nav__icon md-icon"></span>
  239. </label>
  240. <a href="ft2-bdf_fonts.html" class="md-nav__link md-nav__link--active">
  241. BDF and PCF Files
  242. </a>
  243. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  244. <label class="md-nav__title" for="__toc">
  245. <span class="md-nav__icon md-icon"></span>
  246. Table of contents
  247. </label>
  248. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  249. <li class="md-nav__item">
  250. <a href="#synopsis" class="md-nav__link">
  251. Synopsis
  252. </a>
  253. </li>
  254. <li class="md-nav__item">
  255. <a href="#bdf_propertytype" class="md-nav__link">
  256. BDF_PropertyType
  257. </a>
  258. </li>
  259. <li class="md-nav__item">
  260. <a href="#bdf_property" class="md-nav__link">
  261. BDF_Property
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="#bdf_propertyrec" class="md-nav__link">
  266. BDF_PropertyRec
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="#ft_get_bdf_charset_id" class="md-nav__link">
  271. FT_Get_BDF_Charset_ID
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="#ft_get_bdf_property" class="md-nav__link">
  276. FT_Get_BDF_Property
  277. </a>
  278. </li>
  279. </ul>
  280. </nav>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="ft2-cid_fonts.html" class="md-nav__link">
  284. CID Fonts
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="ft2-pfr_fonts.html" class="md-nav__link">
  289. PFR Fonts
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="ft2-winfnt_fonts.html" class="md-nav__link">
  294. Window FNT Files
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="ft2-font_formats.html" class="md-nav__link">
  299. Font Formats
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="ft2-gasp_table.html" class="md-nav__link">
  304. Gasp Table
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  312. <label class="md-nav__link" for="__nav_6">
  313. Controlling FreeType Modules
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
  317. <label class="md-nav__title" for="__nav_6">
  318. <span class="md-nav__icon md-icon"></span>
  319. Controlling FreeType Modules
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="ft2-auto_hinter.html" class="md-nav__link">
  324. The auto-hinter
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="ft2-cff_driver.html" class="md-nav__link">
  329. The CFF driver
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="ft2-t1_cid_driver.html" class="md-nav__link">
  334. The Type 1 and CID drivers
  335. </a>
  336. </li>
  337. <li class="md-nav__item">
  338. <a href="ft2-tt_driver.html" class="md-nav__link">
  339. The TrueType driver
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="ft2-pcf_driver.html" class="md-nav__link">
  344. The PCF driver
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="ft2-properties.html" class="md-nav__link">
  349. Driver properties
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="ft2-parameter_tags.html" class="md-nav__link">
  354. Parameter Tags
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="ft2-lcd_rendering.html" class="md-nav__link">
  359. Subpixel Rendering
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item md-nav__item--nested">
  366. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  367. <label class="md-nav__link" for="__nav_7">
  368. Cache Sub-System
  369. <span class="md-nav__icon md-icon"></span>
  370. </label>
  371. <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
  372. <label class="md-nav__title" for="__nav_7">
  373. <span class="md-nav__icon md-icon"></span>
  374. Cache Sub-System
  375. </label>
  376. <ul class="md-nav__list" data-md-scrollfix>
  377. <li class="md-nav__item">
  378. <a href="ft2-cache_subsystem.html" class="md-nav__link">
  379. Cache Sub-System
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item md-nav__item--nested">
  386. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  387. <label class="md-nav__link" for="__nav_8">
  388. Support API
  389. <span class="md-nav__icon md-icon"></span>
  390. </label>
  391. <nav class="md-nav" aria-label="Support API" data-md-level="1">
  392. <label class="md-nav__title" for="__nav_8">
  393. <span class="md-nav__icon md-icon"></span>
  394. Support API
  395. </label>
  396. <ul class="md-nav__list" data-md-scrollfix>
  397. <li class="md-nav__item">
  398. <a href="ft2-computations.html" class="md-nav__link">
  399. Computations
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="ft2-list_processing.html" class="md-nav__link">
  404. List Processing
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="ft2-outline_processing.html" class="md-nav__link">
  409. Outline Processing
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="ft2-quick_advance.html" class="md-nav__link">
  414. Quick retrieval of advance values
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="ft2-bitmap_handling.html" class="md-nav__link">
  419. Bitmap Handling
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="ft2-raster.html" class="md-nav__link">
  424. Scanline Converter
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="ft2-glyph_stroker.html" class="md-nav__link">
  429. Glyph Stroker
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="ft2-system_interface.html" class="md-nav__link">
  434. System Interface
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="ft2-module_management.html" class="md-nav__link">
  439. Module Management
  440. </a>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="ft2-gzip.html" class="md-nav__link">
  444. GZIP Streams
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="ft2-lzw.html" class="md-nav__link">
  449. LZW Streams
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="ft2-bzip2.html" class="md-nav__link">
  454. BZIP2 Streams
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="ft2-debugging_apis.html" class="md-nav__link">
  459. External Debugging APIs
  460. </a>
  461. </li>
  462. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item md-nav__item--nested">
  466. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  467. <label class="md-nav__link" for="__nav_9">
  468. Error Codes
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
  472. <label class="md-nav__title" for="__nav_9">
  473. <span class="md-nav__icon md-icon"></span>
  474. Error Codes
  475. </label>
  476. <ul class="md-nav__list" data-md-scrollfix>
  477. <li class="md-nav__item">
  478. <a href="ft2-error_enumerations.html" class="md-nav__link">
  479. Error Enumerations
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="ft2-error_code_values.html" class="md-nav__link">
  484. Error Code Values
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </li>
  490. <li class="md-nav__item md-nav__item--nested">
  491. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
  492. <label class="md-nav__link" for="__nav_10">
  493. Miscellaneous
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
  497. <label class="md-nav__title" for="__nav_10">
  498. <span class="md-nav__icon md-icon"></span>
  499. Miscellaneous
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="ft2-gx_validation.html" class="md-nav__link">
  504. TrueTypeGX/AAT Validation
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="ft2-incremental.html" class="md-nav__link">
  509. Incremental Loading
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="ft2-truetype_engine.html" class="md-nav__link">
  514. The TrueType Engine
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="ft2-ot_validation.html" class="md-nav__link">
  519. OpenType Validation
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </li>
  525. </ul>
  526. </nav>
  527. </div>
  528. </div>
  529. </div>
  530. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  531. <div class="md-sidebar__scrollwrap">
  532. <div class="md-sidebar__inner">
  533. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  534. <label class="md-nav__title" for="__toc">
  535. <span class="md-nav__icon md-icon"></span>
  536. Table of contents
  537. </label>
  538. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  539. <li class="md-nav__item">
  540. <a href="#synopsis" class="md-nav__link">
  541. Synopsis
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="#bdf_propertytype" class="md-nav__link">
  546. BDF_PropertyType
  547. </a>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="#bdf_property" class="md-nav__link">
  551. BDF_Property
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="#bdf_propertyrec" class="md-nav__link">
  556. BDF_PropertyRec
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="#ft_get_bdf_charset_id" class="md-nav__link">
  561. FT_Get_BDF_Charset_ID
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="#ft_get_bdf_property" class="md-nav__link">
  566. FT_Get_BDF_Property
  567. </a>
  568. </li>
  569. </ul>
  570. </nav>
  571. </div>
  572. </div>
  573. </div>
  574. <div class="md-content" data-md-component="content">
  575. <article class="md-content__inner md-typeset">
  576. <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#format-specific-api">Format-Specific API</a> &raquo; BDF and PCF Files</p>
  577. <hr />
  578. <h1 id="bdf-and-pcf-files">BDF and PCF Files<a class="headerlink" href="#bdf-and-pcf-files" title="Permanent link">&para;</a></h1>
  579. <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
  580. <p>This section contains the declaration of functions specific to BDF and PCF fonts.</p>
  581. <h2 id="bdf_propertytype">BDF_PropertyType<a class="headerlink" href="#bdf_propertytype" title="Permanent link">&para;</a></h2>
  582. <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
  583. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">enum</span> BDF_PropertyType_
  584. {
  585. <a href="ft2-bdf_fonts.html#bdf_property_type_none">BDF_PROPERTY_TYPE_NONE</a> = 0,
  586. <a href="ft2-bdf_fonts.html#bdf_property_type_atom">BDF_PROPERTY_TYPE_ATOM</a> = 1,
  587. <a href="ft2-bdf_fonts.html#bdf_property_type_integer">BDF_PROPERTY_TYPE_INTEGER</a> = 2,
  588. <a href="ft2-bdf_fonts.html#bdf_property_type_cardinal">BDF_PROPERTY_TYPE_CARDINAL</a> = 3
  589. } <b>BDF_PropertyType</b>;
  590. </code></pre></div>
  591. <p>A list of BDF property types.</p>
  592. <h4>values</h4>
  593. <table class="fields long">
  594. <tr><td class="val" id="bdf_property_type_none">BDF_PROPERTY_TYPE_NONE</td><td class="desc">
  595. <p>Value&nbsp;0 is used to indicate a missing property.</p>
  596. </td></tr>
  597. <tr><td class="val" id="bdf_property_type_atom">BDF_PROPERTY_TYPE_ATOM</td><td class="desc">
  598. <p>Property is a string atom.</p>
  599. </td></tr>
  600. <tr><td class="val" id="bdf_property_type_integer">BDF_PROPERTY_TYPE_INTEGER</td><td class="desc">
  601. <p>Property is a 32-bit signed integer.</p>
  602. </td></tr>
  603. <tr><td class="val" id="bdf_property_type_cardinal">BDF_PROPERTY_TYPE_CARDINAL</td><td class="desc">
  604. <p>Property is a 32-bit unsigned integer.</p>
  605. </td></tr>
  606. </table>
  607. <hr>
  608. <h2 id="bdf_property">BDF_Property<a class="headerlink" href="#bdf_property" title="Permanent link">&para;</a></h2>
  609. <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
  610. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> BDF_PropertyRec_* <b>BDF_Property</b>;
  611. </code></pre></div>
  612. <p>A handle to a <code><a href="ft2-bdf_fonts.html#bdf_propertyrec">BDF_PropertyRec</a></code> structure to model a given BDF/PCF property.</p>
  613. <hr>
  614. <h2 id="bdf_propertyrec">BDF_PropertyRec<a class="headerlink" href="#bdf_propertyrec" title="Permanent link">&para;</a></h2>
  615. <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
  616. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> BDF_PropertyRec_
  617. {
  618. <a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PropertyType</a> type;
  619. <span class="keyword">union</span> {
  620. <span class="keyword">const</span> <span class="keyword">char</span>* atom;
  621. <a href="ft2-basic_types.html#ft_int32">FT_Int32</a> integer;
  622. <a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a> cardinal;
  623. } u;
  624. } <b>BDF_PropertyRec</b>;
  625. </code></pre></div>
  626. <p>This structure models a given BDF/PCF property.</p>
  627. <h4>fields</h4>
  628. <table class="fields">
  629. <tr><td class="val" id="type">type</td><td class="desc">
  630. <p>The property type.</p>
  631. </td></tr>
  632. <tr><td class="val" id="u.atom">u.atom</td><td class="desc">
  633. <p>The atom string, if type is <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_ATOM</a></code>. May be <code>NULL</code>, indicating an empty string.</p>
  634. </td></tr>
  635. <tr><td class="val" id="u.integer">u.integer</td><td class="desc">
  636. <p>A signed integer, if type is <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_INTEGER</a></code>.</p>
  637. </td></tr>
  638. <tr><td class="val" id="u.cardinal">u.cardinal</td><td class="desc">
  639. <p>An unsigned integer, if type is <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_CARDINAL</a></code>.</p>
  640. </td></tr>
  641. </table>
  642. <hr>
  643. <h2 id="ft_get_bdf_charset_id">FT_Get_BDF_Charset_ID<a class="headerlink" href="#ft_get_bdf_charset_id" title="Permanent link">&para;</a></h2>
  644. <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
  645. <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
  646. <b>FT_Get_BDF_Charset_ID</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
  647. <span class="keyword">const</span> <span class="keyword">char</span>* *acharset_encoding,
  648. <span class="keyword">const</span> <span class="keyword">char</span>* *acharset_registry );
  649. </code></pre></div>
  650. <p>Retrieve a BDF font character set identity, according to the BDF specification.</p>
  651. <h4>input</h4>
  652. <table class="fields">
  653. <tr><td class="val" id="face">face</td><td class="desc">
  654. <p>A handle to the input face.</p>
  655. </td></tr>
  656. </table>
  657. <h4>output</h4>
  658. <table class="fields">
  659. <tr><td class="val" id="acharset_encoding">acharset_encoding</td><td class="desc">
  660. <p>Charset encoding, as a C&nbsp;string, owned by the face.</p>
  661. </td></tr>
  662. <tr><td class="val" id="acharset_registry">acharset_registry</td><td class="desc">
  663. <p>Charset registry, as a C&nbsp;string, owned by the face.</p>
  664. </td></tr>
  665. </table>
  666. <h4>return</h4>
  667. <p>FreeType error code. 0&nbsp;means success.</p>
  668. <h4>note</h4>
  669. <p>This function only works with BDF faces, returning an error otherwise.</p>
  670. <hr>
  671. <h2 id="ft_get_bdf_property">FT_Get_BDF_Property<a class="headerlink" href="#ft_get_bdf_property" title="Permanent link">&para;</a></h2>
  672. <p>Defined in FT_BDF_H (freetype/ftbdf.h).</p>
  673. <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
  674. <b>FT_Get_BDF_Property</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
  675. <span class="keyword">const</span> <span class="keyword">char</span>* prop_name,
  676. <a href="ft2-bdf_fonts.html#bdf_propertyrec">BDF_PropertyRec</a> *aproperty );
  677. </code></pre></div>
  678. <p>Retrieve a BDF property from a BDF or PCF font file.</p>
  679. <h4>input</h4>
  680. <table class="fields">
  681. <tr><td class="val" id="face">face</td><td class="desc">
  682. <p>A handle to the input face.</p>
  683. </td></tr>
  684. <tr><td class="val" id="name">name</td><td class="desc">
  685. <p>The property name.</p>
  686. </td></tr>
  687. </table>
  688. <h4>output</h4>
  689. <table class="fields">
  690. <tr><td class="val" id="aproperty">aproperty</td><td class="desc">
  691. <p>The property.</p>
  692. </td></tr>
  693. </table>
  694. <h4>return</h4>
  695. <p>FreeType error code. 0&nbsp;means success.</p>
  696. <h4>note</h4>
  697. <p>This function works with BDF <em>and</em> PCF fonts. It returns an error otherwise. It also returns an error if the property is not in the font.</p>
  698. <p>A &lsquo;property&rsquo; is a either key-value pair within the STARTPROPERTIES &hellip; ENDPROPERTIES block of a BDF font or a key-value pair from the <code>info-&gt;props</code> array within a <code>FontRec</code> structure of a PCF font.</p>
  699. <p>Integer properties are always stored as &lsquo;signed&rsquo; within PCF fonts; consequently, <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_CARDINAL</a></code> is a possible return value for BDF fonts only.</p>
  700. <p>In case of error, <code>aproperty-&gt;type</code> is always set to <code><a href="ft2-bdf_fonts.html#bdf_propertytype">BDF_PROPERTY_TYPE_NONE</a></code>.</p>
  701. <hr>
  702. </article>
  703. </div>
  704. </div>
  705. </main>
  706. <footer class="md-footer">
  707. <nav class="md-footer__inner md-grid" aria-label="Footer">
  708. <a href="ft2-sfnt_names.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: SFNT Names" rel="prev">
  709. <div class="md-footer__button md-icon">
  710. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  711. </div>
  712. <div class="md-footer__title">
  713. <div class="md-ellipsis">
  714. <span class="md-footer__direction">
  715. Previous
  716. </span>
  717. SFNT Names
  718. </div>
  719. </div>
  720. </a>
  721. <a href="ft2-cid_fonts.html" class="md-footer__link md-footer__link--next" aria-label="Next: CID Fonts" rel="next">
  722. <div class="md-footer__title">
  723. <div class="md-ellipsis">
  724. <span class="md-footer__direction">
  725. Next
  726. </span>
  727. CID Fonts
  728. </div>
  729. </div>
  730. <div class="md-footer__button md-icon">
  731. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  732. </div>
  733. </a>
  734. </nav>
  735. <div class="md-footer-meta md-typeset">
  736. <div class="md-footer-meta__inner md-grid">
  737. <div class="md-footer-copyright">
  738. <div class="md-footer-copyright__highlight">
  739. Copyright 2021 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
  740. </div>
  741. Made with
  742. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  743. Material for MkDocs
  744. </a>
  745. </div>
  746. </div>
  747. </div>
  748. </footer>
  749. </div>
  750. <div class="md-dialog" data-md-component="dialog">
  751. <div class="md-dialog__inner md-typeset"></div>
  752. </div>
  753. <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script>
  754. <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
  755. <script src="javascripts/extra.js"></script>
  756. </body>
  757. </html>