Skip to content

Latest commit

 

History

History
63 lines (34 loc) · 1.87 KB

File metadata and controls

63 lines (34 loc) · 1.87 KB

Function: useTextToImage()

useTextToImage(config, options?): object

Defined in: hooks/useTextToImage.ts:24

React hook to load and run an SDXS text-to-image synthesis model.

This hook manages downloading (if remote URLs are provided) and loading the model assets and tokenizer files, tracking download progress and load errors, and releasing native memory when the component unmounts or the configuration changes.

For imperative usage, see createSdxsTextToImage.

Parameters

config

SdxsTextToImageModel

The SDXS model configuration. See SdxsTextToImageModel.

options?

ResourceOptions

Load and caching options. See ResourceOptions.

Returns

object

The same object as SdxsTextToImage (without dispose), combined with loading state and download progress.

downloadProgress

downloadProgress: number

error

error: Error | undefined

generate

generate: (prompt, seed?) => Promise<ImageBuffer> | undefined = model.generate

generateWorklet

generateWorklet: (prompt, seed?) => ImageBuffer | undefined = model.generateWorklet

isReady

isReady: boolean = !!model

resource

resource: SdxsTextToImageModel | undefined

See

SdxsTextToImage