These functions clear the layout cache of text layout instances based on the specified criteria. More specifically, all layout instances that match the specified font, script, language and/or typographic control flags are removed from the layout cache by these functions.
Parameter | Description |
---|---|
layout_cache |
Handle of the previously created cache instance. |
font_index |
All layout instances with the specified font_index will be removed from the layout cache. font_index must be a valid font index of the font or font instance in the Font Catalog (associated with the Standard Engine instance that was used to create the layout cache). However, you can set this value to -1 to disable matching based on the font. In other words, -1 means "any font". |
script_code |
All layout instances with the specified script_code will be removed from the layout cache. script_code must be a code from the list of defined scripts. However, you can set this value to -1 to disable matching based on the script code. In other words, -1 means "any script". |
language_code |
All layout instances with the specified language_code will be removed from the layout cache. language_code must be a code from the list of defined languages. However, you can set this value to -1 to disable matching based on the language_code code. In other words, -1 means "any language". |
typo_flags |
Typographic control flags. Use 0 for no specific typographic features, 1 for kerning, 2 for ligature formation, and 3 for kerning and ligature formation. Others values are reserved for future. |
You can call these functions to remove any layout instances associated with a given font, script, language and/or typographic control flags from the layout cache. These functions can be used, for example, after removing a font from the Font Catalog in order to ensure that all layout instances associated with the removed font are also removed.
lxCacheClear has the same effect as lxCacheClearPlus(layout_cache, font_index, script_code, -1, 3).