🛠️🐜 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.

1400 lines
31 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>External Debugging APIs - 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="#external-debugging-apis" 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. External Debugging APIs
  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--nested">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  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">
  235. <a href="ft2-bdf_fonts.html" class="md-nav__link">
  236. BDF and PCF Files
  237. </a>
  238. </li>
  239. <li class="md-nav__item">
  240. <a href="ft2-cid_fonts.html" class="md-nav__link">
  241. CID Fonts
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="ft2-pfr_fonts.html" class="md-nav__link">
  246. PFR Fonts
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="ft2-winfnt_fonts.html" class="md-nav__link">
  251. Window FNT Files
  252. </a>
  253. </li>
  254. <li class="md-nav__item">
  255. <a href="ft2-font_formats.html" class="md-nav__link">
  256. Font Formats
  257. </a>
  258. </li>
  259. <li class="md-nav__item">
  260. <a href="ft2-gasp_table.html" class="md-nav__link">
  261. Gasp Table
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item md-nav__item--nested">
  268. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  269. <label class="md-nav__link" for="__nav_6">
  270. Controlling FreeType Modules
  271. <span class="md-nav__icon md-icon"></span>
  272. </label>
  273. <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
  274. <label class="md-nav__title" for="__nav_6">
  275. <span class="md-nav__icon md-icon"></span>
  276. Controlling FreeType Modules
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="ft2-auto_hinter.html" class="md-nav__link">
  281. The auto-hinter
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="ft2-cff_driver.html" class="md-nav__link">
  286. The CFF driver
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="ft2-t1_cid_driver.html" class="md-nav__link">
  291. The Type 1 and CID drivers
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="ft2-tt_driver.html" class="md-nav__link">
  296. The TrueType driver
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="ft2-pcf_driver.html" class="md-nav__link">
  301. The PCF driver
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="ft2-properties.html" class="md-nav__link">
  306. Driver properties
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="ft2-parameter_tags.html" class="md-nav__link">
  311. Parameter Tags
  312. </a>
  313. </li>
  314. <li class="md-nav__item">
  315. <a href="ft2-lcd_rendering.html" class="md-nav__link">
  316. Subpixel Rendering
  317. </a>
  318. </li>
  319. </ul>
  320. </nav>
  321. </li>
  322. <li class="md-nav__item md-nav__item--nested">
  323. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  324. <label class="md-nav__link" for="__nav_7">
  325. Cache Sub-System
  326. <span class="md-nav__icon md-icon"></span>
  327. </label>
  328. <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
  329. <label class="md-nav__title" for="__nav_7">
  330. <span class="md-nav__icon md-icon"></span>
  331. Cache Sub-System
  332. </label>
  333. <ul class="md-nav__list" data-md-scrollfix>
  334. <li class="md-nav__item">
  335. <a href="ft2-cache_subsystem.html" class="md-nav__link">
  336. Cache Sub-System
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>
  344. <label class="md-nav__link" for="__nav_8">
  345. Support API
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="Support API" data-md-level="1">
  349. <label class="md-nav__title" for="__nav_8">
  350. <span class="md-nav__icon md-icon"></span>
  351. Support API
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="ft2-computations.html" class="md-nav__link">
  356. Computations
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="ft2-list_processing.html" class="md-nav__link">
  361. List Processing
  362. </a>
  363. </li>
  364. <li class="md-nav__item">
  365. <a href="ft2-outline_processing.html" class="md-nav__link">
  366. Outline Processing
  367. </a>
  368. </li>
  369. <li class="md-nav__item">
  370. <a href="ft2-quick_advance.html" class="md-nav__link">
  371. Quick retrieval of advance values
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="ft2-bitmap_handling.html" class="md-nav__link">
  376. Bitmap Handling
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="ft2-raster.html" class="md-nav__link">
  381. Scanline Converter
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="ft2-glyph_stroker.html" class="md-nav__link">
  386. Glyph Stroker
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="ft2-system_interface.html" class="md-nav__link">
  391. System Interface
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="ft2-module_management.html" class="md-nav__link">
  396. Module Management
  397. </a>
  398. </li>
  399. <li class="md-nav__item">
  400. <a href="ft2-gzip.html" class="md-nav__link">
  401. GZIP Streams
  402. </a>
  403. </li>
  404. <li class="md-nav__item">
  405. <a href="ft2-lzw.html" class="md-nav__link">
  406. LZW Streams
  407. </a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="ft2-bzip2.html" class="md-nav__link">
  411. BZIP2 Streams
  412. </a>
  413. </li>
  414. <li class="md-nav__item md-nav__item--active">
  415. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  416. <label class="md-nav__link md-nav__link--active" for="__toc">
  417. External Debugging APIs
  418. <span class="md-nav__icon md-icon"></span>
  419. </label>
  420. <a href="ft2-debugging_apis.html" class="md-nav__link md-nav__link--active">
  421. External Debugging APIs
  422. </a>
  423. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  424. <label class="md-nav__title" for="__toc">
  425. <span class="md-nav__icon md-icon"></span>
  426. Table of contents
  427. </label>
  428. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  429. <li class="md-nav__item">
  430. <a href="#synopsis" class="md-nav__link">
  431. Synopsis
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="#ft_trace_set_level" class="md-nav__link">
  436. FT_Trace_Set_Level
  437. </a>
  438. </li>
  439. <li class="md-nav__item">
  440. <a href="#ft_trace_set_default_level" class="md-nav__link">
  441. FT_Trace_Set_Default_Level
  442. </a>
  443. </li>
  444. <li class="md-nav__item">
  445. <a href="#ft_custom_log_handler" class="md-nav__link">
  446. FT_Custom_Log_Handler
  447. </a>
  448. </li>
  449. <li class="md-nav__item">
  450. <a href="#ft_set_log_handler" class="md-nav__link">
  451. FT_Set_Log_Handler
  452. </a>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="#ft_set_default_log_handler" class="md-nav__link">
  456. FT_Set_Default_Log_Handler
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  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="#ft_trace_set_level" class="md-nav__link">
  546. FT_Trace_Set_Level
  547. </a>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="#ft_trace_set_default_level" class="md-nav__link">
  551. FT_Trace_Set_Default_Level
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="#ft_custom_log_handler" class="md-nav__link">
  556. FT_Custom_Log_Handler
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="#ft_set_log_handler" class="md-nav__link">
  561. FT_Set_Log_Handler
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="#ft_set_default_log_handler" class="md-nav__link">
  566. FT_Set_Default_Log_Handler
  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#support-api">Support API</a> &raquo; External Debugging APIs</p>
  577. <hr />
  578. <h1 id="external-debugging-apis">External Debugging APIs<a class="headerlink" href="#external-debugging-apis" 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 declarations of public functions that enables fine control of what the <code>FT_DEBUG_LOGGING</code> macro outputs.</p>
  581. <h2 id="ft_trace_set_level">FT_Trace_Set_Level<a class="headerlink" href="#ft_trace_set_level" title="Permanent link">&para;</a></h2>
  582. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  583. <b>FT_Trace_Set_Level</b>( <span class="keyword">const</span> <span class="keyword">char</span>* tracing_level );
  584. </code></pre></div>
  585. <p>Change the levels of tracing components of FreeType at run time.</p>
  586. <h4>input</h4>
  587. <table class="fields">
  588. <tr><td class="val" id="tracing_level">tracing_level</td><td class="desc">
  589. <p>New tracing value.</p>
  590. </td></tr>
  591. </table>
  592. <h4>example</h4>
  593. <p>The following call makes FreeType trace everything but the &lsquo;memory&rsquo; component.
  594. <div class="highlight"><pre><span></span><code>FT_Trace_Set_Level( &quot;any:7 memory:0 );
  595. </code></pre></div></p>
  596. <h4>note</h4>
  597. <p>This function does nothing if compilation option <code>FT_DEBUG_LOGGING</code> isn't set.</p>
  598. <h4>since</h4>
  599. <p>2.11</p>
  600. <hr>
  601. <h2 id="ft_trace_set_default_level">FT_Trace_Set_Default_Level<a class="headerlink" href="#ft_trace_set_default_level" title="Permanent link">&para;</a></h2>
  602. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  603. <b>FT_Trace_Set_Default_Level</b>( <span class="keyword">void</span> );
  604. </code></pre></div>
  605. <p>Reset tracing value of FreeType's components to the default value (i.e., to the value of the <code>FT2_DEBUG</code> environment value or to NULL if <code>FT2_DEBUG</code> is not set).</p>
  606. <h4>note</h4>
  607. <p>This function does nothing if compilation option <code>FT_DEBUG_LOGGING</code> isn't set.</p>
  608. <h4>since</h4>
  609. <p>2.11</p>
  610. <hr>
  611. <h2 id="ft_custom_log_handler">FT_Custom_Log_Handler<a class="headerlink" href="#ft_custom_log_handler" title="Permanent link">&para;</a></h2>
  612. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">void</span>
  613. (*<b>FT_Custom_Log_Handler</b>)( <span class="keyword">const</span> <span class="keyword">char</span>* ft_component,
  614. <span class="keyword">const</span> <span class="keyword">char</span>* fmt,
  615. va_list args );
  616. </code></pre></div>
  617. <p>A function typedef that is used to handle the logging of tracing and debug messages on a file system.</p>
  618. <h4>input</h4>
  619. <table class="fields">
  620. <tr><td class="val" id="ft_component">ft_component</td><td class="desc">
  621. <p>The name of <code>FT_COMPONENT</code> from which the current debug or error message is produced.</p>
  622. </td></tr>
  623. <tr><td class="val" id="fmt">fmt</td><td class="desc">
  624. <p>Actual debug or tracing message.</p>
  625. </td></tr>
  626. <tr><td class="val" id="args">args</td><td class="desc">
  627. <p>Arguments of debug or tracing messages.</p>
  628. </td></tr>
  629. </table>
  630. <h4>since</h4>
  631. <p>2.11</p>
  632. <hr>
  633. <h2 id="ft_set_log_handler">FT_Set_Log_Handler<a class="headerlink" href="#ft_set_log_handler" title="Permanent link">&para;</a></h2>
  634. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  635. <b>FT_Set_Log_Handler</b>( <a href="ft2-debugging_apis.html#ft_custom_log_handler">FT_Custom_Log_Handler</a> handler );
  636. </code></pre></div>
  637. <p>A function to set a custom log handler.</p>
  638. <h4>input</h4>
  639. <table class="fields">
  640. <tr><td class="val" id="handler">handler</td><td class="desc">
  641. <p>New logging function.</p>
  642. </td></tr>
  643. </table>
  644. <h4>note</h4>
  645. <p>This function does nothing if compilation option <code>FT_DEBUG_LOGGING</code> isn't set.</p>
  646. <h4>since</h4>
  647. <p>2.11</p>
  648. <hr>
  649. <h2 id="ft_set_default_log_handler">FT_Set_Default_Log_Handler<a class="headerlink" href="#ft_set_default_log_handler" title="Permanent link">&para;</a></h2>
  650. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  651. <b>FT_Set_Default_Log_Handler</b>( <span class="keyword">void</span> );
  652. </code></pre></div>
  653. <p>A function to undo the effect of <code><a href="ft2-debugging_apis.html#ft_set_log_handler">FT_Set_Log_Handler</a></code>, resetting the log handler to FreeType's built-in version.</p>
  654. <h4>note</h4>
  655. <p>This function does nothing if compilation option <code>FT_DEBUG_LOGGING</code> isn't set.</p>
  656. <h4>since</h4>
  657. <p>2.11</p>
  658. <hr>
  659. </article>
  660. </div>
  661. </div>
  662. </main>
  663. <footer class="md-footer">
  664. <nav class="md-footer__inner md-grid" aria-label="Footer">
  665. <a href="ft2-bzip2.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: BZIP2 Streams" rel="prev">
  666. <div class="md-footer__button md-icon">
  667. <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>
  668. </div>
  669. <div class="md-footer__title">
  670. <div class="md-ellipsis">
  671. <span class="md-footer__direction">
  672. Previous
  673. </span>
  674. BZIP2 Streams
  675. </div>
  676. </div>
  677. </a>
  678. <a href="ft2-error_enumerations.html" class="md-footer__link md-footer__link--next" aria-label="Next: Error Enumerations" rel="next">
  679. <div class="md-footer__title">
  680. <div class="md-ellipsis">
  681. <span class="md-footer__direction">
  682. Next
  683. </span>
  684. Error Enumerations
  685. </div>
  686. </div>
  687. <div class="md-footer__button md-icon">
  688. <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>
  689. </div>
  690. </a>
  691. </nav>
  692. <div class="md-footer-meta md-typeset">
  693. <div class="md-footer-meta__inner md-grid">
  694. <div class="md-footer-copyright">
  695. <div class="md-footer-copyright__highlight">
  696. Copyright 2021 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
  697. </div>
  698. Made with
  699. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  700. Material for MkDocs
  701. </a>
  702. </div>
  703. </div>
  704. </div>
  705. </footer>
  706. </div>
  707. <div class="md-dialog" data-md-component="dialog">
  708. <div class="md-dialog__inner md-typeset"></div>
  709. </div>
  710. <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>
  711. <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
  712. <script src="javascripts/extra.js"></script>
  713. </body>
  714. </html>