laya-coreui-es
Version:
laya核心库、ui库es版本,剔除了媒体、TTF等功能。基于 LayaAir-release_2.12.0 修改
82 lines (81 loc) • 2.67 kB
TypeScript
import { Sprite } from "./Sprite";
import { Texture } from "../resource/Texture";
import { Handler } from "../utils/Handler";
/**
* <code>BitmapFont</code> 是位图字体类,用于定义位图字体信息。
* 字体制作及使用方法,请参考文章
* @see http://ldc2.layabox.com/doc/?nav=ch-js-1-2-5
*/
export declare class BitmapFont {
private _texture;
private _fontCharDic;
private _fontWidthMap;
private _complete;
private _path;
private _maxWidth;
private _spaceWidth;
private _padding;
/**当前位图字体字号,使用时,如果字号和设置不同,并且autoScaleSize=true,则按照设置字号比率进行缩放显示。*/
fontSize: number;
/**表示是否根据实际使用的字体大小缩放位图字体大小。*/
autoScaleSize: boolean;
/**字符间距(以像素为单位)。*/
letterSpacing: number;
/**
* 通过指定位图字体文件路径,加载位图字体文件,加载完成后会自动解析。
* @param path 位图字体文件的路径。
* @param complete 加载并解析完成的回调。
*/
loadFont(path: string, complete: Handler): void;
/**
* @private
*/
private _onLoaded;
/**
* 解析字体文件。
* @param xml 字体文件XML。
* @param texture 字体的纹理。
*/
parseFont(xml: XMLDocument, texture: Texture): void;
/**
* 解析字体文件。
* @param xml 字体文件XML。
* @param texture 字体的纹理。
*/
parseFont2(xml: XMLDocument, texture: Texture): void;
/**
* 获取指定字符的字体纹理对象。
* @param char 字符。
* @return 指定的字体纹理对象。
*/
getCharTexture(char: string): Texture;
/**
* 销毁位图字体,调用Text.unregisterBitmapFont 时,默认会销毁。
*/
destroy(): void;
/**
* 设置空格的宽(如果字体库有空格,这里就可以不用设置了)。
* @param spaceWidth 宽度,单位为像素。
*/
setSpaceWidth(spaceWidth: number): void;
/**
* 获取指定字符的宽度。
* @param char 字符。
* @return 宽度。
*/
getCharWidth(char: string): number;
/**
* 获取指定文本内容的宽度。
* @param text 文本内容。
* @return 宽度。
*/
getTextWidth(text: string): number;
/**
* 获取最大字符宽度。
*/
getMaxWidth(): number;
/**
* 获取最大字符高度。
*/
getMaxHeight(): number;
}