Winter Cardinal UI - v0.442.0 / DDynamicTextGeometry

Class: DDynamicTextGeometry

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new DDynamicTextGeometry(): DDynamicTextGeometry

Returns

DDynamicTextGeometry

Overrides

MeshGeometry.constructor

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:40

Properties

clipped

clipped: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:30


glVertexArrayObjects

Protected glVertexArrayObjects: any

A map of renderer IDs to webgl VAOs

Inherited from

MeshGeometry.glVertexArrayObjects

Defined in

node_modules/pixi.js/pixi.js.d.ts:14256


height

height: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:27


indexBuffer

indexBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:37


indices

indices: Uint16Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:38


instanceCount

instanceCount: number

Number of instances in this geometry, pass it to GeometrySystem.draw()

Member

PIXI.Geometry#instanceCount

Default

1

Inherited from

MeshGeometry.instanceCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:14262


nchars

nchars: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:32


refCount

refCount: number

Count of existing (not destroyed) meshes that reference this geometry

Member

PIXI.Geometry#refCount

Inherited from

MeshGeometry.refCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:14267


scale

scale: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:28


scaled

scaled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:29


uvBuffer

uvBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:35


uvs

uvs: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:36


vertexBuffer

vertexBuffer: Buffer

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:33


vertices

vertices: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:34


width

width: number

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:26


INDICES

Static Protected Optional INDICES: Uint16Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:24


UVS

Static Protected Optional UVS: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:23


VERTICES

Static Protected Optional VERTICES: Float32Array

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:22

Methods

addAttribute

addAttribute(id, buffer?, size?, normalized?, type?, stride?, start?, instance?): Geometry

Adds an attribute to the geometry Note: stride and start should be undefined if you dont know them, not 0!

Parameters

Name Type Description
id string the name of the attribute (matching up to a shader)
buffer? number[] | Buffer the buffer that holds the data of the attribute . You can also provide an Array and a buffer will be created from it.
size? number the size of the attribute. If you have 2 floats per vertex (eg position x and y) this would be 2
normalized? boolean should the data be normalized.
type? number what type of number is the attribute. Check {PIXI.TYPES} to see the ones available
stride? number How far apart (in floats) the start of each value is. (used for interleaving data)
start? number How far into the array to start reading values (used for interleaving data)
instance? boolean Instancing flag

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.addAttribute

Defined in

node_modules/pixi.js/pixi.js.d.ts:14284


addIndex

addIndex(buffer?): Geometry

Adds an index buffer to the geometry The index buffer contains integers, three for each triangle in the geometry, which reference the various attribute buffers (position, colour, UV coordinates, other UV coordinates, normal, …). There is only ONE index buffer.

Parameters

Name Type Description
buffer? number[] | Buffer the buffer that holds the data of the index buffer. You can also provide an Array and a buffer will be created from it.

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.addIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:14307


clone

clone(): Geometry

returns a clone of the geometry

Returns

Geometry

a new clone of this geometry

Inherited from

MeshGeometry.clone

Defined in

node_modules/pixi.js/pixi.js.d.ts:14334


destroy

destroy(): void

Destroys the geometry.

Returns

void

Inherited from

MeshGeometry.destroy

Defined in

node_modules/pixi.js/pixi.js.d.ts:14328


dispose

dispose(): void

disposes WebGL resources that are connected to this geometry

Returns

void

Inherited from

MeshGeometry.dispose

Defined in

node_modules/pixi.js/pixi.js.d.ts:14324


fill

fill(vertices, uvs, index, x, y, scale, character, fw, fh): void

Parameters

Name Type
vertices Float32Array
uvs Float32Array
index number
x number
y number
scale number
character DynamicFontAtlasCharacter
fw number
fh number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:127


fillBlank

fillBlank(vertices, uvs, index): void

Parameters

Name Type
vertices Float32Array
uvs Float32Array
index number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:174


getAttribute

getAttribute(id): Attribute

returns the requested attribute

Parameters

Name Type Description
id string the name of the attribute required

Returns

Attribute

the attribute requested.

Inherited from

MeshGeometry.getAttribute

Defined in

node_modules/pixi.js/pixi.js.d.ts:14291


getBuffer

getBuffer(id): Buffer

returns the requested buffer

Parameters

Name Type Description
id string the name of the buffer required

Returns

Buffer

the buffer requested.

Inherited from

MeshGeometry.getBuffer

Defined in

node_modules/pixi.js/pixi.js.d.ts:14298


getIndex

getIndex(): Buffer

returns the index buffer

Returns

Buffer

the index buffer.

Inherited from

MeshGeometry.getIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:14313


initIndices

initIndices(indices): void

Parameters

Name Type
indices Uint16Array

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:195


interleave

interleave(): Geometry

this function modifies the structure so that all current attributes become interleaved into a single buffer This can be useful if your model remains static as it offers a little performance boost

Returns

Geometry

returns self, useful for chaining.

Inherited from

MeshGeometry.interleave

Defined in

node_modules/pixi.js/pixi.js.d.ts:14320


update

update(text, atlas, modifier): void

Parameters

Name Type
text string
atlas null | DynamicFontAtlas
modifier DDynamicTextGeometryModifier

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dynamic-text-geometry.ts:62


merge

merge(geometries): Geometry

merges an array of geometries into a new single one geometry attribute styles must match for this operation to work

Parameters

Name Type Description
geometries Geometry[] array of geometries to merge

Returns

Geometry

shiny new geometry!

Inherited from

MeshGeometry.merge

Defined in

node_modules/pixi.js/pixi.js.d.ts:3115