TextBuffer

Text buffer. Renders screen-aligned text strings.

example: var textBuffer = new TextBuffer({ position: new Float32Array([ 0, 0, 0 ]), color: new Float32Array([ 1, 0, 0 ]), size: new Float32Array([ 2 ]), text: [ "Hello" ] });

Hierarchy

MappedQuadBuffer
- TextBuffer

Index

Constructors

constructor

Accessors

Constructors

constructor

new TextBuffer(data: TextBufferData, params?: Partial<TextBufferParameters>): TextBuffer

Overrides MappedQuadBuffer.constructor
- Defined in src/buffer/text-buffer.ts:362
Parameters
- data: TextBufferData
  
  attribute object
- Default value params: Partial<TextBufferParameters> = {}
  
  parameters object
Returns TextBuffer

Properties

alwaysTransparent

alwaysTransparent: boolean = true

dynamic

dynamic: boolean = true

fragmentShader

fragmentShader: string = "SDFFont.frag"

geometry

geometry: BufferGeometry = new BufferGeometry()

group

group: Group = new Group()

hasWireframe

hasWireframe: boolean = false

index

index: Uint32Array | Uint16Array

indexVersion

indexVersion: number = 0

isImpostor

isImpostor: boolean = false

isLine

isLine: boolean = false

isPoint

isPoint: boolean = false

isSurface

isSurface: boolean = false

isText

isText: boolean = true

material

material: ShaderMaterial

parameterTypes

parameterTypes: { backgroundColor: object; backgroundOpacity: object; borderColor: object; borderWidth: object; fixedSize: object; fontFamily: object; fontSize: object; fontStyle: object; fontWeight: object; showBorder: object; xOffset: object; yOffset: object; zOffset: object } & { matrix: {}; background: object; clipCenter: object; clipNear: object; clipRadius: object; depthWrite: object; diffuse: object; diffuseInterior: object; flatShaded: object; interiorColor: object; interiorDarkening: object; metalness: object; opacity: object; opaqueBack: object; roughness: object; side: object; useInteriorColor: object; wireframe: object } = TextBufferParameterTypes

parameters

parameters: TextBufferParameters

Optional picking

picking: Picker

pickingGroup

pickingGroup: Group = new Group()

pickingMaterial

pickingMaterial: ShaderMaterial

pickingUniforms

pickingUniforms: Uniforms

positionCount

positionCount: number

text

text: string[]

textAtlas

textAtlas: TextAtlas

texture

texture: CanvasTexture

uniforms

uniforms: Uniforms

vertexShader

vertexShader: string = "SDFFont.vert"

visible

visible: boolean = true

Optional wireframeGeometry

wireframeGeometry: BufferGeometry

wireframeGroup

wireframeGroup: Group = new Group()

Optional wireframeIndex

wireframeIndex: Uint32Array | Uint16Array

wireframeIndexCount

wireframeIndexCount: number = 0

wireframeIndexVersion

wireframeIndexVersion: number = -1

wireframeMaterial

wireframeMaterial: ShaderMaterial

Accessors

attributeSize

get attributeSize(): number

Inherited from MappedBuffer.attributeSize

Overrides Buffer.attributeSize
- Defined in src/buffer/mapped-buffer.ts:41
Returns number

defaultParameters

get defaultParameters(): { attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; backgroundColor: string | number; backgroundMargin: number; backgroundOpacity: number; borderColor: string | number; borderWidth: number; fixedSize: false; fontFamily: "sans-serif" | "monospace" | "serif"; fontSize: number; fontStyle: "normal" | "italic"; fontWeight: "normal" | "bold"; forceTransparent: true; showBackground: false; showBorder: false; xOffset: number; yOffset: number; zOffset: number } & { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

Overrides Buffer.defaultParameters
- Defined in src/buffer/text-buffer.ts:350
Returns { attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; backgroundColor: string | number; backgroundMargin: number; backgroundOpacity: number; borderColor: string | number; borderWidth: number; fixedSize: false; fontFamily: "sans-serif" | "monospace" | "serif"; fontSize: number; fontStyle: "normal" | "italic"; fontWeight: "normal" | "bold"; forceTransparent: true; showBackground: false; showBorder: false; xOffset: number; yOffset: number; zOffset: number } & { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

indexSize

get indexSize(): number

Inherited from MappedBuffer.indexSize
- Defined in src/buffer/mapped-buffer.ts:45
Returns number

mapping

get mapping(): Float32Array

Inherited from MappedQuadBuffer.mapping

Overrides MappedBuffer.mapping
- Defined in src/buffer/mappedquad-buffer.ts:30
Returns Float32Array

mappingIndices

get mappingIndices(): Uint16Array

Inherited from MappedQuadBuffer.mappingIndices

Overrides MappedBuffer.mappingIndices
- Defined in src/buffer/mappedquad-buffer.ts:31
Returns Uint16Array

mappingIndicesSize

get mappingIndicesSize(): number

Inherited from MappedQuadBuffer.mappingIndicesSize

Overrides MappedBuffer.mappingIndicesSize
- Defined in src/buffer/mappedquad-buffer.ts:32
Returns number

mappingItemSize

get mappingItemSize(): number

Inherited from MappedQuadBuffer.mappingItemSize

Overrides MappedBuffer.mappingItemSize
- Defined in src/buffer/mappedquad-buffer.ts:34
Returns number

mappingSize

get mappingSize(): number

Inherited from MappedQuadBuffer.mappingSize

Overrides MappedBuffer.mappingSize
- Defined in src/buffer/mappedquad-buffer.ts:33
Returns number

matrix

get matrix(): Matrix4
set matrix(m: Matrix4): void

Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:226
Returns Matrix4
Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:223
Parameters
- m: Matrix4
Returns void

pickable

get pickable(): boolean

Inherited from Buffer.pickable
- Defined in src/buffer/buffer.ts:242
Returns boolean

size

get size(): number

Inherited from Buffer.size
- Defined in src/buffer/buffer.ts:234
Returns number

transparent

get transparent(): boolean

Inherited from Buffer.transparent
- Defined in src/buffer/buffer.ts:230
Returns boolean

Methods

_getMesh

_getMesh(materialName: BufferMaterials): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer._getMesh
- Defined in src/buffer/buffer.ts:473
Parameters
- materialName: BufferMaterials
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

addAttributes

addAttributes(attributes: any): void

Inherited from MappedBuffer.addAttributes

Overrides Buffer.addAttributes
- Defined in src/buffer/mapped-buffer.ts:49
Parameters
- attributes: any
Returns void

addUniforms

addUniforms(uniforms: Uniforms): void

Inherited from Buffer.addUniforms
- Defined in src/buffer/buffer.ts:569
Parameters
- uniforms: Uniforms
Returns void

dispose

dispose(): void

Inherited from Buffer.dispose
- Defined in src/buffer/buffer.ts:851
Free buffer resources

Returns void

getAttributeIndex

getAttributeIndex(dataIndex: number): number

Inherited from MappedBuffer.getAttributeIndex
- Defined in src/buffer/mapped-buffer.ts:62
Parameters
- dataIndex: number
Returns number

getDefines

getDefines(type: BufferTypes): {}

Overrides Buffer.getDefines
- Defined in src/buffer/text-buffer.ts:601
Parameters
- type: BufferTypes
Returns {}

getFragmentShader

getFragmentShader(type?: BufferTypes): string

Inherited from Buffer.getFragmentShader
- Defined in src/buffer/buffer.ts:527
Parameters
- Optional type: BufferTypes
Returns string

getMesh

getMesh(): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getMesh
- Defined in src/buffer/buffer.ts:495
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

getParameters

getParameters(): { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }

Inherited from Buffer.getParameters
- Defined in src/buffer/buffer.ts:565
Returns { background: boolean; clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: boolean; disablePicking: boolean; flatShaded: boolean; forceTransparent: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; opaqueBack: boolean; roughness: number; side: "double" | "front" | "back"; sortParticles: boolean; useInteriorColor: boolean; wireframe: boolean }
- background: boolean
- clipCenter: Vector3
- clipNear: number
- clipRadius: number
- depthWrite: boolean
- diffuse: number
- diffuseInterior: boolean
- disablePicking: boolean
- flatShaded: boolean
- forceTransparent: boolean
- interiorColor: number
- interiorDarkening: number
- matrix: Matrix4
- metalness: number
- opacity: number
- opaqueBack: boolean
- roughness: number
- side: "double" | "front" | "back"
- sortParticles: boolean
- useInteriorColor: boolean
- wireframe: boolean

getPickingMesh

getPickingMesh(): LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getPickingMesh
- Defined in src/buffer/buffer.ts:515
Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

getRenderOrder

getRenderOrder(): number

Inherited from Buffer.getRenderOrder
- Defined in src/buffer/buffer.ts:457
Returns number

getShader

getShader(name: string, type?: BufferTypes): string

Inherited from Buffer.getShader
- Defined in src/buffer/buffer.ts:519
Parameters
- name: string
- Optional type: BufferTypes
Returns string

getVertexShader

getVertexShader(type?: BufferTypes): string

Inherited from Buffer.getVertexShader
- Defined in src/buffer/buffer.ts:523
Parameters
- Optional type: BufferTypes
Returns string

getWireframeMesh

getWireframeMesh(): LineSegments<BufferGeometry, ShaderMaterial>

Inherited from Buffer.getWireframeMesh
- Defined in src/buffer/buffer.ts:499
Returns LineSegments<BufferGeometry, ShaderMaterial>

initIndex

initIndex(index: Uint32Array | Uint16Array): void

Inherited from Buffer.initIndex
- Defined in src/buffer/buffer.ts:252
Parameters
- index: Uint32Array | Uint16Array
Returns void

makeIndex

makeIndex(): void

Inherited from MappedBuffer.makeIndex
- Defined in src/buffer/mapped-buffer.ts:116
Returns void

makeMapping

makeMapping(): void

Overrides MappedBuffer.makeMapping
- Defined in src/buffer/text-buffer.ts:506
Returns void

makeMaterial

makeMaterial(): void

Overrides Buffer.makeMaterial
- Defined in src/buffer/text-buffer.ts:408
Returns void

makeTexture

makeTexture(): void

- Defined in src/buffer/text-buffer.ts:495
Returns void

makeWireframeGeometry

makeWireframeGeometry(): void

Inherited from Buffer.makeWireframeGeometry
- Defined in src/buffer/buffer.ts:319
Returns void

makeWireframeIndex

makeWireframeIndex(): void

Inherited from Buffer.makeWireframeIndex
- Defined in src/buffer/buffer.ts:337
Returns void

setAttributes

setAttributes(data?: Partial<TextBufferData>): void

Overrides MappedBuffer.setAttributes
- Defined in src/buffer/text-buffer.ts:434
Parameters
- Default value data: Partial<TextBufferData> = {}
Returns void

setMatrix

setMatrix(m: Matrix4): void

Inherited from Buffer.setMatrix
- Defined in src/buffer/buffer.ts:246
Parameters
- m: Matrix4
Returns void

setParameters

setParameters(params: Partial<BufferParameters>): void

Inherited from Buffer.setParameters
- Defined in src/buffer/buffer.ts:636
Set buffer parameters

Parameters
- params: Partial<BufferParameters>
  
  buffer parameters object
Returns void

setProperties

setProperties(data: any): void

Inherited from Buffer.setProperties
- Defined in src/buffer/buffer.ts:796
Parameters
- data: any
Returns void

setUniforms

setUniforms(data: any): void

Overrides Buffer.setUniforms
- Defined in src/buffer/text-buffer.ts:611
Parameters
- data: any
Returns void

setVisibility

setVisibility(value: boolean): void

Inherited from Buffer.setVisibility
- Defined in src/buffer/buffer.ts:829
Set buffer visibility

Parameters
- value: boolean
  
  visibility value
Returns void

toJSON

toJSON(): any

Inherited from Buffer.toJSON
- Defined in src/buffer/buffer.ts:863
Customize JSON serialization to avoid circular references

Returns any

updateRenderOrder

updateRenderOrder(): void

Inherited from Buffer.updateRenderOrder
- Defined in src/buffer/buffer.ts:601
Returns void

updateShader

updateShader(): void

Inherited from Buffer.updateShader
- Defined in src/buffer/buffer.ts:613
Returns void

updateWireframeIndex

updateWireframeIndex(): void

Inherited from Buffer.updateWireframeIndex
- Defined in src/buffer/buffer.ts:435
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: TextBufferData

Default value params: Partial<TextBufferParameters> = {}

Returns TextBuffer

Properties

alwaysTransparent

dynamic

fragmentShader

geometry

group

hasWireframe

index

indexVersion

isImpostor

isLine

isPoint

isSurface

isText

material

parameterTypes

parameters

Optional picking

pickingGroup

pickingMaterial

pickingUniforms

positionCount

text

textAtlas

texture

uniforms

vertexShader

visible

Optional wireframeGeometry

wireframeGroup

Optional wireframeIndex

wireframeIndexCount

wireframeIndexVersion

wireframeMaterial

Accessors

attributeSize

Returns number

defaultParameters

indexSize

Returns number

mapping

Returns Float32Array

mappingIndices

Returns Uint16Array

mappingIndicesSize

Returns number

mappingItemSize

Returns number

mappingSize

Returns number

matrix

Returns Matrix4

Parameters

m: Matrix4

Returns void

pickable

Returns boolean

size

Returns number

transparent

Returns boolean

Methods

_getMesh

Parameters

materialName: BufferMaterials

Returns LineSegments<BufferGeometry, ShaderMaterial> | Points<BufferGeometry, ShaderMaterial> | Mesh<BufferGeometry, ShaderMaterial>

addAttributes

Parameters