Skip to content

Commit fe7c3c4

Browse files
committed
docs: add refdocs for AspectRatio
1 parent 53b3453 commit fe7c3c4

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/AspectRatio.kt

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,25 @@ package com.google.firebase.ai.type
1919
/** Represents the aspect ratio that the generated image should conform to. */
2020
public class AspectRatio private constructor(internal val internalVal: String) {
2121
public companion object {
22+
/** A square image, useful for icons, profile pictures, etc. */
2223
@JvmField public val SQUARE_1x1: AspectRatio = AspectRatio("1:1")
23-
@JvmField public val PORTRAIT_2x3: AspectRatio = AspectRatio("2:3")
24-
@JvmField public val LANDSCAPE_3x2: AspectRatio = AspectRatio("3:2")
24+
/** A portrait image in 3:4, the aspect ratio of older TVs. */
2525
@JvmField public val PORTRAIT_3x4: AspectRatio = AspectRatio("3:4")
26+
/** A landscape image in 4:3, the aspect ratio of older TVs. */
2627
@JvmField public val LANDSCAPE_4x3: AspectRatio = AspectRatio("4:3")
27-
@JvmField public val PORTRAIT_4x5: AspectRatio = AspectRatio("4:5")
28-
@JvmField public val LANDSCAPE_5x4: AspectRatio = AspectRatio("5:4")
28+
/** A portrait image in 9:16, the aspect ratio of modern monitors and phone screens. */
2929
@JvmField public val PORTRAIT_9x16: AspectRatio = AspectRatio("9:16")
30+
/** A landscape image in 16:9, the aspect ratio of modern monitors and phone screens. */
3031
@JvmField public val LANDSCAPE_16x9: AspectRatio = AspectRatio("16:9")
32+
/** A portrait image in 4:5, the aspect ratio for prints from digital cameras. */
33+
@JvmField public val PORTRAIT_4x5: AspectRatio = AspectRatio("4:5")
34+
/** A landscape image in 5:4, the aspect ratio for prints from digital cameras. */
35+
@JvmField public val LANDSCAPE_5x4: AspectRatio = AspectRatio("5:4")
36+
/** A portrait image in 4:5, the aspect ratio for prints from 35mm film cameras. */
37+
@JvmField public val PORTRAIT_2x3: AspectRatio = AspectRatio("2:3")
38+
/** A landscape image in 4:5, the aspect ratio for prints from 35mm film cameras. */
39+
@JvmField public val LANDSCAPE_3x2: AspectRatio = AspectRatio("3:2")
40+
/** A ultrawide image in 21:9, an aspect ratio commonly used in modern movies. */
3141
@JvmField public val LANDSCAPE_21x9: AspectRatio = AspectRatio("21:9")
3242
}
3343
}

0 commit comments

Comments
 (0)