ResolutionInfo
class ResolutionInfo
A ResolutionInfo allows the application to know the resolution information of a specific use case.
Applications can know the resolution information of Preview before a SurfaceRequest is received, or know the resolution information of ImageAnalysis before an ImageProxy is received from ImageAnalysis.Analyzer.
Summary
Public constructors |
|---|
ResolutionInfo(resolution: Size, cropRect: Rect, rotationDegrees: Int)Creates a new instance of |
Public functions |
|
|---|---|
Boolean |
|
Rect |
Returns the crop rectangle. |
Size |
Returns the output resolution used for the use case. |
Int |
Returns the rotation degrees needed to transform the output resolution to the target rotation. |
Int |
hashCode() |
String |
toString() |
Public constructors
ResolutionInfo
ResolutionInfo(resolution: Size, cropRect: Rect, rotationDegrees: Int)
Creates a new instance of ResolutionInfo with the given parameters. This constructor is not normally needed outside of testing cases.
| Parameters | |
|---|---|
resolution: Size |
The resolution used for the |
cropRect: Rect |
The crop rectangle specifies the region of valid pixels in the buffer. |
rotationDegrees: Int |
The clockwise rotation in degrees that needs to be applied to the output buffer so the image appears upright at the target rotation setting. |
| See also | |
|---|---|
getResolution |
|
getCropRect |
|
getRotationDegrees |
Public functions
getCropRect
fun getCropRect(): Rect
Returns the crop rectangle.
The crop rectangle specifies the region of valid pixels in the buffer, using coordinates from (0, 0) to the (width, height) of the resolution obtained by getResolution. The dimensions need to be flipped by the rotation degrees obtained via getRotationDegrees to match the target rotation setting.
If the use case is configured with a ViewPort, this value is calculated based on the configuration of ViewPort; if not, it returns the full rect of the buffer which the dimensions will be the same as the value obtained from getResolution.
getResolution
fun getResolution(): Size
Returns the output resolution used for the use case.
The resolution will be expressed in the coordinates of the camera sensor. The dimensions need to be flipped by the rotation degrees obtained via getRotationDegrees to match the target rotation setting.
getRotationDegrees
fun getRotationDegrees(): Int
Returns the rotation degrees needed to transform the output resolution to the target rotation.
This is a clockwise rotation in degrees that needs to be applied to the output buffer so the image appears upright at the target rotation setting. The rotation will be determined by the camera sensor orientation value and target rotation setting.
| Returns | |
|---|---|
Int |
The rotation in degrees which will be a value in {0, 90, 180, 270}. |