Skip to main content
Version: 0.10.0

Type Alias: SdxsTextToImage

SdxsTextToImage = object

Defined in: extensions/cv/tasks/sdxsTextToImage.ts:57

SDXS single-step text-to-image generation task runner.

Properties​

dispose()​

readonly dispose: () => void

Defined in: extensions/cv/tasks/sdxsTextToImage.ts:61

Releases all allocated native resources.

Returns​

void


generate()​

readonly generate: (prompt, seed?) => Promise<ImageBuffer>

Defined in: extensions/cv/tasks/sdxsTextToImage.ts:72

Generates an image from a text prompt.

Parameters​

prompt​

string

The text prompt describing the desired image.

seed?​

number

Seed for the initial latent noise (same seed → same image). Defaults to a time-based value so omitting it yields a fresh image each call.

Returns​

Promise<ImageBuffer>

A promise resolving to the generated RGBA image buffer.

Throws​

With code RESOURCE_BUSY if the model is in use, or RESOURCE_DISPOSED if disposed.


generateWorklet()​

readonly generateWorklet: (prompt, seed?) => ImageBuffer

Defined in: extensions/cv/tasks/sdxsTextToImage.ts:78

Synchronous version of generate to be executed directly on the caller or worklet thread.

Parameters​

prompt​

string

seed?​

number

Returns​

ImageBuffer