# Interface: BackgroundImageGenerateOptions (/pixi-vn-ai/index/interfaces/BackgroundImageGenerateOptions)



Defined in: [src/types/BackgroundImageGenerateOptions.ts:9](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/BackgroundImageGenerateOptions.ts#L9)

Options accepted by [ai.image.generateBackground](/pixi-vn-ai/index/namespaces/ai/namespaces/image/functions/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 [#extends]

* [`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions)

## Properties [#properties]

### context? [#context]

\> `optional` **context?**: `string`

Defined in: [src/types/GenerateOptions.ts:19](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L19)

Additional developer context, injected verbatim into the prompt.

#### Inherited from [#inherited-from]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`context`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#context)

***

### history? [#history]

\> `optional` **history?**: `boolean`

Defined in: [src/types/GenerateOptions.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L15)

Include the Pixi'VN narrative history.

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

#### Default [#default]

```ts
true
```

#### Inherited from [#inherited-from-1]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`history`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#history)

***

### referenceImage? [#referenceimage]

\> `optional` **referenceImage?**: `string`

Defined in: [src/types/ImageGenerateOptions.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/ImageGenerateOptions.ts#L11)

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

#### Inherited from [#inherited-from-2]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`referenceImage`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#referenceimage)

***

### scene? [#scene]

\> `optional` **scene?**: `string`

Defined in: [src/types/GenerateOptions.ts:23](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L23)

Scene description.

#### Inherited from [#inherited-from-3]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`scene`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#scene)

***

### style? [#style]

\> `optional` **style?**: `string`

Defined in: [src/types/GenerateOptions.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/types/GenerateOptions.ts#L27)

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

#### Inherited from [#inherited-from-4]

[`ImageGenerateOptions`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions).[`style`](/pixi-vn-ai/index/interfaces/ImageGenerateOptions#style)