IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

ImagenForegroundMask

@PublicPreviewAPI
public final class ImagenForegroundMask extends ImagenMaskReference

java.lang.Object
↳	com.google.firebase.ai.type.ImagenReferenceImage
	↳	com.google.firebase.ai.type.ImagenMaskReference
		↳	com.google.firebase.ai.type.ImagenForegroundMask

A generated mask image which will auto-detect and mask out the foreground. The background will be black, and the foreground white

Deprecation Notice: All Imagen models are deprecated and will shut down as early as June 2026. As a replacement, you can migrate your apps to use Gemini Image models (the 'Nano Banana' models)

Summary

Public constructors
`ImagenForegroundMask(Double dilation)`

Inherited fields

From com.google.firebase.ai.type.ImagenReferenceImage

`final ImagenInlineImage`	`image`
`final Integer`	`referenceId`

Public constructors

ImagenForegroundMask

public ImagenForegroundMask(Double dilation)

Parameters
`Double dilation`	the amount to dilate the mask. This can help smooth the borders of an edit and make it seem more convincing. For example, `0.05` will dilate the mask 5%.