Skip to content

textmode.js / conversion

conversion ​

All media conversion related modules and types.

Responsible for converting images and videos into textmode-renderable formats using various conversion strategies, like brightness- or edge-detection-based conversion.

textmode.js only comes with a built-in 'brightness'-based conversion strategy, but custom strategies can be registered via conversion.TextmodeConversionManager.register.

Classes ​

ClassDescription
TextmodeConversionManagerRegisters conversion strategies for a Textmodifier instance.

Interfaces ​

InterfaceDescription
TextmodeConversionContextInterface for the context provided to conversion strategies during shader and uniform creation.
TextmodeConversionPassContextMetadata describing the active pass while a conversion stack is being rendered.
TextmodeConversionSourceRead-only source view exposed to conversion strategies.
TextmodeConversionStepOne pass in a source-level conversion stack.
TextmodeConversionStrategyInterface for defining a custom textmode conversion strategy.

Type Aliases ​

Type AliasDescription
BuiltInConversionModeBuilt-in conversion mode names provided by textmode.js
TextmodeColorInputColor input accepted by conversion stack steps.
TextmodeConversionModeType representing the available textmode conversion modes
TextmodeConversionStepOptionsCustom options passed to conversion strategies for one conversion stack pass.