import TextBuffer from 'ngl/src/buffer/text-buffer.js'

public class | source

TextBuffer

Extends:

Buffer → MappedBuffer → MappedQuadBuffer → 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" ]
} );

Constructor Summary

Public Constructor
public	constructor(data: Object, params: TextBufferParameters)

Member Summary

Public Members
public	attachment
public	backgroundColor
public	backgroundMargin
public	backgroundOpacity
public	borderColor
public	borderWidth
public	fontFamily
public	fontSize
public	fontStyle
public	fontWeight
public get	fragmentShader
public get	isText
public get	parameters
public	positionCount
public	sdf
public	showBackground
public	showBorder
public	text
public	textAtlas
public	texture
public get	vertexShader
public set	wireframe
public get	wireframe
public	xOffset
public	yOffset
public	zOffset

Method Summary

Public Methods
public	getDefines()
public	makeMapping()
public	makeMaterial()
public	makeTexture()
public	setAttributes()
public	setUniforms()

Inherited Summary

From class Buffer
public get	attributeSize
public get	dynamic
public get abstract	fragmentShader
public get	matrix
public set	matrix
public get	parameters
public get	pickable
public get	size
public get	transparent
public get abstract	vertexShader
public	[name]
public	background
public	clipCenter
public	clipNear
public	clipRadius
public	depthWrite
public	diffuse
public	disablePicking
public	dullInterior
public	flatShaded
public	forceTransparent
public	geometry
public	group
public	indexVersion
public	material
public	metalness
public	opacity
public	opaqueBack
public	picking
public	pickingGroup
public	pickingMaterial
public	pickingUniforms
public	roughness
public	side
public	uniforms
public	visible
public	wireframe
public	wireframeGeometry
public	wireframeGroup
public	wireframeIndex
public	wireframeIndexCount
public	wireframeIndexVersion
public	wireframeMaterial
private	_positionDataSize
public	addAttributes()
public	addUniforms()
public	dispose(): undefined Free buffer resources
public	getDefines()
public	getFragmentShader()
public	getMesh()
public	getParameters()
public	getPickingMesh()
public	getRenderOrder()
public	getShader()
public	getVertexShader()
public	getWireframeMesh()
public	initIndex()
public	makeMaterial()
public	makeWireframeGeometry()
public	makeWireframeIndex()
public	setAttributes(data: Object) Sets buffer attributes
public	setMatrix()
public	setParameters(params: BufferParameters): undefined Set buffer parameters
public	setProperties()
public	setUniforms()
public	setVisibility(value: Boolean): undefined Set buffer visibility
public	updateRenderOrder()
public	updateShader()
public	updateWireframeIndex()
private	_getMesh()

From class MappedBuffer
public get	attributeSize
public get	indexSize
public get abstract	mapping
public get abstract	mappingIndices
public get abstract	mappingIndicesSize
public get abstract	mappingItemSize
public get abstract	mappingSize
public get abstract	mappingType
public	index
public	addAttributes()
public	getAttributeIndex()
public	makeIndex()
public	makeMapping()
public	setAttributes()

From class MappedQuadBuffer
public get	mapping
public get	mappingIndices
public get	mappingIndicesSize
public get	mappingItemSize
public get	mappingSize
public get	mappingType

Public Constructors

public constructor(data: Object, params: TextBufferParameters) source

Override:

MappedBuffer#constructor

Params:

Name	Type	Attribute	Description
data	Object		attribute object
data.position	Float32Array		positions
data.color	Float32Array		colors
data.size	Float32Array		sizes
data.text	String[]		text strings
params	TextBufferParameters		parameters object