Pixi’VNClass: BatchableHTMLText
Defined in: node_modules/pixi.js/lib/scene/text-html/BatchableHTMLText.d.ts:8
Internal
The BatchableHTMLText class extends the BatchableSprite class and is used to handle HTML text rendering. It includes a promise for the texture as generating the HTML texture takes some time.
Extends
Constructors
Constructor
> new BatchableHTMLText(): BatchableHTMLText
Returns
BatchableHTMLText
Inherited from
Properties
attributeSize
> readonly attributeSize: 4 = 4
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:16
The size of the attribute data for this quad element.
Inherited from
batcherName
> batcherName: string
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:14
The name of the batcher to use. Must be registered.
Inherited from
bounds
> bounds: BoundsData
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:22
The bounds data for this quad element.
Inherited from
currentKey
> currentKey: string
Defined in: node_modules/pixi.js/lib/scene/text-html/BatchableHTMLText.d.ts:11
generatingTexture
> generatingTexture: boolean
Defined in: node_modules/pixi.js/lib/scene/text-html/BatchableHTMLText.d.ts:10
indexSize
> readonly indexSize: 6 = 6
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:17
The size of the index data for this quad element.
Inherited from
packAsQuad
> readonly packAsQuad: true = true
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:18
Indicates that this element should be packed as a quad.
Inherited from
renderable
> renderable: Container
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:20
Inherited from
roundPixels
> roundPixels: 0 | 1
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:23
Determines whether the element should be rounded to the nearest pixel.
- 0: No rounding (default)
- 1: Round to nearest pixel This can help with visual consistency, especially for pixel art styles.
Inherited from
texture
> texture: Texture
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:21
The texture to be used for rendering.
Inherited from
texturePromise
> texturePromise: Promise<Texture<TextureSource<any>>>
Defined in: node_modules/pixi.js/lib/scene/text-html/BatchableHTMLText.d.ts:9
topology
> topology: Topology
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:15
The topology to be used for rendering.
Inherited from
transform
> transform: Matrix
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:19
The transform matrix of the element. This matrix represents the position, scale, rotation, and skew of the element.
Inherited from
Accessors
blendMode
Get Signature
> get blendMode(): BLEND_MODES
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:29
The blend mode to be applied.
Returns
The blend mode to be applied.
Inherited from
color
Get Signature
> get color(): number
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:30
The color of the element that will be multiplied with the texture color. This is typically represented as a 32-bit integer in RGBA format.
Returns
number
The color of the element that will be multiplied with the texture color. This is typically represented as a 32-bit integer in RGBA format.
Inherited from
Methods
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/scene/text-html/BatchableHTMLText.d.ts:13
Destroys the BatchableHTMLText instance. Returns the texture promise to the renderer and cleans up references.
Returns
void
Overrides
reset()
> reset(): void
Defined in: node_modules/pixi.js/lib/scene/sprite/BatchableSprite.d.ts:31
Returns
void