Interface: BackgroundImageGenerateOptions

Defined in: src/types/BackgroundImageGenerateOptions.ts:9

Options accepted by ai.image.generateBackground.

The generated image is meant to fill the whole game canvas: its size is read directly from Pixi'VN and included in the prompt, so developers never have to pass it manually.

Extends

• ImageGenerateOptions

Properties

context?

> optional context?: string

Defined in: src/types/GenerateOptions.ts:19

Additional developer context, injected verbatim into the prompt.

Inherited from

ImageGenerateOptions.context

history?

> optional history?: boolean

Defined in: src/types/GenerateOptions.ts:15

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

Default

true

Inherited from

ImageGenerateOptions.history

referenceImage?

> optional referenceImage?: string

Defined in: src/types/ImageGenerateOptions.ts:11

Optional reference image, forwarded to providers that support image-to-image generation.

Inherited from

ImageGenerateOptions.referenceImage

scene?

> optional scene?: string

Defined in: src/types/GenerateOptions.ts:23

Scene description.

Inherited from

ImageGenerateOptions.scene

style?

> optional style?: string

Defined in: src/types/GenerateOptions.ts:27

Desired style (tone of voice, art style, etc).

Inherited from

ImageGenerateOptions.style