41 lines
1.5 KiB
TypeScript
41 lines
1.5 KiB
TypeScript
import { AbstractText } from './AbstractText';
|
|
import { TextStyle } from './TextStyle';
|
|
import type { View } from '../../rendering/renderers/shared/view/View';
|
|
import type { TextOptions, TextString } from './AbstractText';
|
|
import type { TextStyleOptions } from './TextStyle';
|
|
/**
|
|
* A Text Object will create a line or multiple lines of text.
|
|
*
|
|
* To split a line you can use '\n' in your text string, or, on the `style` object,
|
|
* change its `wordWrap` property to true and and givae the `wordWrapWidth` property a value.
|
|
*
|
|
* The primary advantage of this class over BitmapText is that you have great control over the style of the text,
|
|
* which you can change at runtime.
|
|
*
|
|
* The primary disadvantages is that each piece of text has it's own texture, which can use more memory.
|
|
* When text changes, this texture has to be re-generated and re-uploaded to the GPU, taking up time.
|
|
* @example
|
|
* import { Text } from 'pixi.js';
|
|
*
|
|
* const text = new Text({
|
|
* text: 'Hello Pixi!',
|
|
* style: {
|
|
* fontFamily: 'Arial',
|
|
* fontSize: 24,
|
|
* fill: 0xff1010,
|
|
* align: 'center',
|
|
* }
|
|
* });
|
|
* @memberof scene
|
|
*/
|
|
export declare class Text extends AbstractText<TextStyle, TextStyleOptions> implements View {
|
|
readonly renderPipeId: string;
|
|
/**
|
|
* @param {text.TextOptions} options - The options of the text.
|
|
*/
|
|
constructor(options?: TextOptions);
|
|
/** @deprecated since 8.0.0 */
|
|
constructor(text?: TextString, options?: Partial<TextStyle>);
|
|
protected _updateBounds(): void;
|
|
}
|