ImagePlayground.SetSourceImage
------------------------------

Sets the source image.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [ImagePlayground](component_ImagePlayground.md) | [15.0](newinversion150.md) | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |

MBS( "ImagePlayground.SetSourceImage"; Image ) 

**MBS**( **"ImagePlayground.SetSourceImage";** /\* Sets the source image. \*/  
**$Image**) /\* The container with image to use. \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| Image | The container with image to use. |  |

### Result

Returns OK or error.

### Description

Sets the source image.  
An image to use as source input for generating the new image.  
If you have an existing image that you want to use as a starting point for the new image, add it to this property. If you don’t supply a source image, the system creates the new image from the prompt text you provide.  
Typically, you provide an image big enough to fit the device’s display. The expected minimum size is 384 x 384 pixels, and the recommended maximum size is 4096 x 4096 pixels.  
### Examples

Set the source image:

 Set Variable \[ $r ; Value: MBS ( "ImagePlayground.SetSourceImage"; Saxon MyDatabase::ImageContainer ) \]  
### See also

- [ImagePlayground.GetSourceImage](ImagePlaygroundGetSourceImage.md)

This function checks for a license.

Created 15th December 2024 , last changed 31st December 2024

  
[ImagePlayground.SetScriptTrigger](ImagePlaygroundSetScriptTrigger.md) - [ImageView.Clear](ImageViewClear.md)

[HTML Version](ImagePlaygroundSetSourceImage.shtml)