textmode.js / media / TextmodeSource

Abstract Class: TextmodeSource

Shared base for image, video, and dynamic texture sources drawn with Textmodifier.image.

Extends

• Disposable

Extended by

• TextmodeImage
• TextmodeTexture

Character & color mapping

Map sampled values to glyphs, foreground colors, cell colors, and a background.

Method	Description
background	Set the background color used for transparent pixels.
cellColor	Set the cell color used when cellColorMode is 'fixed'.
cellColorMode	Set whether cell color is sampled from the source or fixed.
characters	Set the characters used for brightness mapping.
charColor	Set the character color used when charColorMode is 'fixed'.
charColorMode	Set whether character color is sampled from the source or fixed.

Conversion

Select and clear the conversion stack used when drawing this source.

Method	Description
brightnessRange	Capture only source pixels whose brightness is inside the inclusive byte range.
clearConversions	Clear this source's conversion stack and return to single-mode conversion.
conversionMode	Select the conversion mode for this source.
conversions	Set an ordered conversion stack for this source.

Resource lifecycle

Release the WebGL resources owned by the source.

Method	Description
dispose	Dispose of the resource and free associated WebGL textures.

Source dimensions

Inspect the source texture and its original and grid-fitted dimensions.

Accessor	Description
height	Ideal draw height in grid cells.
originalHeight	Original source height in pixels.
originalWidth	Original source width in pixels.
texture	WebGL texture backing this source.
width	Ideal draw width in grid cells.

Source transforms

Mirror, invert, or rotate the source's converted output.

Method	Description
charRotation	Rotate generated characters.
flipX	Flip the source horizontally.
flipY	Flip the source vertically.
invert	Enable or disable source color inversion.