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.

ImagenImagePlacement

class ImagenImagePlacement

Represents where the placement of an image is within a new, larger image, usually in the context of an outpainting request.

Summary

Public companion functions
`ImagenImagePlacement`	`fromCoordinate(x: Int, y: Int)` Creates an `ImagenImagePlacement` that represents a placement in an image described by two coordinates.

Public companion properties
`ImagenImagePlacement`	`BOTTOM_CENTER` Center the image horizontally and aligned with the bottom edge of the larger image
`ImagenImagePlacement`	`BOTTOM_LEFT` Align the image with the bottom left corner of the larger image
`ImagenImagePlacement`	`BOTTOM_RIGHT` Align the image with the bottom right corner of the larger image
`ImagenImagePlacement`	`CENTER` Center the image horizontally and vertically within the larger image
`ImagenImagePlacement`	`LEFT_CENTER` Center the image vertically and aligned with the left edge of the larger image
`ImagenImagePlacement`	`RIGHT_CENTER` Center the image vertically and aligned with the right edge of the larger image
`ImagenImagePlacement`	`TOP_CENTER` Center the image horizontally and aligned with the top edge of the larger image
`ImagenImagePlacement`	`TOP_LEFT` Align the image with the top left corner of the larger image
`ImagenImagePlacement`	`TOP_RIGHT` Align the image with the top right corner of the larger image

Public properties
`Int?`	`x`
`Int?`	`y`

Public companion functions

fromCoordinate

fun fromCoordinate(x: Int, y: Int): ImagenImagePlacement

Creates an ImagenImagePlacement that represents a placement in an image described by two coordinates. The coordinate system has 0,0 in the top left corner, and the x and y coordinates represent the location of the top left corner of the original image.

Parameters
`x: Int`	the x coordinate of the top left corner of the original image
`y: Int`	the y coordinate of the top left corner of the original image

Public companion properties

BOTTOM_CENTER

val BOTTOM_CENTER: ImagenImagePlacement

Center the image horizontally and aligned with the bottom edge of the larger image

BOTTOM_LEFT

val BOTTOM_LEFT: ImagenImagePlacement

Align the image with the bottom left corner of the larger image

BOTTOM_RIGHT

val BOTTOM_RIGHT: ImagenImagePlacement

Align the image with the bottom right corner of the larger image

CENTER

val CENTER: ImagenImagePlacement

Center the image horizontally and vertically within the larger image

LEFT_CENTER

val LEFT_CENTER: ImagenImagePlacement

Center the image vertically and aligned with the left edge of the larger image

RIGHT_CENTER

val RIGHT_CENTER: ImagenImagePlacement

Center the image vertically and aligned with the right edge of the larger image

TOP_CENTER

val TOP_CENTER: ImagenImagePlacement

Center the image horizontally and aligned with the top edge of the larger image

TOP_LEFT

val TOP_LEFT: ImagenImagePlacement

Align the image with the top left corner of the larger image

TOP_RIGHT

val TOP_RIGHT: ImagenImagePlacement

Align the image with the top right corner of the larger image

Public properties

x

val x: Int?

y

val y: Int?