textmode.js / conversion / TextmodeConversionManager

Class: TextmodeConversionManager

Registers conversion strategies for a Textmodifier instance.

Access via Textmodifier.conversions.

Example

// Register a custom conversion strategy
t.conversions.register({
    id: 'custom',
    createShader: (ctx) => shader,
    createUniforms: (ctx) => ({ u_image: ctx.source.texture })
});

// Use the conversion mode on an image
img.conversionMode('custom');

Methods

has()

has(id): boolean;

Check if a conversion strategy with the given ID is registered.

Parameters

Parameter	Type	Description
id	string	The conversion strategy ID to check

Returns

boolean

true if the strategy exists

Example

---

register()

register(strategy): void;

Register a custom conversion strategy.

Parameters

Parameter	Type	Description
strategy	TextmodeConversionStrategy	The conversion strategy to register

Returns

void

Example

t.conversions.register({
    id: 'custom',
    createShader: (ctx) => shader,
    createUniforms: (ctx) => ({ u_image: ctx.source.texture })
});

---

unregister()

unregister(id): boolean;

Unregister a conversion strategy by its ID.

Parameters

Parameter	Type	Description
id	string	The conversion strategy ID to unregister

Returns

boolean

true if the strategy was unregistered, false if it wasn't found

Example