camera-core/com.stripe.android.camera.framework.util

Package-level declarations

Types

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
abstract class FrameSaver<Identifier, Frame, MetaData>

Save data frames for later retrieval.

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
class UnexpectedRetryException : Exception

This exception should never be thrown.

Functions

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun adjustSizeToAspectRatio(area: Size, aspectRatio: Float): Size

Given a size and an aspect ratio, resize the area to fit that aspect ratio. If the desired aspect ratio is smaller than the one of the provided size, the size will be cropped to match. If the desired aspect ratio is larger than the that of the provided size, then the size will be expanded to match.

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.aspectRatio(): Float

Determine the aspect ratio of a Size.

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun SizeF.aspectRatio(): Float

Determine the aspect ratio of a SizeF.

Link copied to clipboard
Link copied to clipboard
fun <Result> suspend () -> Result.cachedFirstResultSuspend(): suspend () -> Result
fun <Input, Result> suspend (Input) -> Result.cachedFirstResultSuspend(): suspend (Input) -> Result
fun <Input1, Input2, Result> suspend (Input1, Input2) -> Result.cachedFirstResultSuspend(): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> suspend (Input1, Input2, Input3) -> Result.cachedFirstResultSuspend(): suspend (Input1, Input2, Input3) -> Result
Link copied to clipboard
Link copied to clipboard
fun <Result> cacheFirstResultSuspend(f: suspend () -> Result): suspend () -> Result
fun <Input, Result> cacheFirstResultSuspend(f: suspend (Input) -> Result): suspend (Input) -> Result
fun <Input1, Input2, Result> cacheFirstResultSuspend(f: suspend (Input1, Input2) -> Result): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> cacheFirstResultSuspend(f: suspend (Input1, Input2, Input3) -> Result): suspend (Input1, Input2, Input3) -> Result
Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.centerOn(rect: Rect): Rect

Center a size on a given rectangle. The size may be larger or smaller than the rect.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.centerScaled(scaleX: Float, scaleY: Float): Rect

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.centerScaled(scaleX: Float, scaleY: Float): RectF

Scale a Rect to have a size equivalent to the scaledSize. This will maintain the center position of the Rect.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.intersectionWith(rect: Rect): Rect

Return a rect that is the intersection of two other rects

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun maxAspectRatioInSize(area: Size, aspectRatio: Float): Size

Determine the maximum size of rectangle with a given aspect ratio (X/Y) that can fit inside the specified area.

Link copied to clipboard
fun <Result> memoize(f: () -> Result): () -> Result
fun <Input, Result> memoize(f: (Input) -> Result): (Input) -> Result
fun <Input1, Input2, Result> memoize(f: (Input1, Input2) -> Result): (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> memoize(f: (Input1, Input2, Input3) -> Result): (Input1, Input2, Input3) -> Result
fun <Result> memoize(validFor: Duration, f: () -> Result): () -> Result
fun <Input, Result> memoize(validFor: Duration, f: (Input) -> Result): (Input) -> Result
fun <Input1, Input2, Result> memoize(validFor: Duration, f: (Input1, Input2) -> Result): (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> memoize(validFor: Duration, f: (Input1, Input2, Input3) -> Result): (Input1, Input2, Input3) -> Result
Link copied to clipboard
Link copied to clipboard
fun <Result> suspend () -> Result.memoizedSuspend(): suspend () -> Result
fun <Input, Result> suspend (Input) -> Result.memoizedSuspend(): suspend (Input) -> Result
fun <Input1, Input2, Result> suspend (Input1, Input2) -> Result.memoizedSuspend(): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> suspend (Input1, Input2, Input3) -> Result.memoizedSuspend(): suspend (Input1, Input2, Input3) -> Result
fun <Result> suspend () -> Result.memoizedSuspend(validFor: Duration): suspend () -> Result
fun <Input, Result> suspend (Input) -> Result.memoizedSuspend(validFor: Duration): suspend (Input) -> Result
fun <Input1, Input2, Result> suspend (Input1, Input2) -> Result.memoizedSuspend(validFor: Duration): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> suspend (Input1, Input2, Input3) -> Result.memoizedSuspend(validFor: Duration): suspend (Input1, Input2, Input3) -> Result
Link copied to clipboard
fun <Result> memoizeSuspend(f: suspend () -> Result): suspend () -> Result
fun <Input, Result> memoizeSuspend(f: suspend (Input) -> Result): suspend (Input) -> Result
fun <Input1, Input2, Result> memoizeSuspend(f: suspend (Input1, Input2) -> Result): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> memoizeSuspend(f: suspend (Input1, Input2, Input3) -> Result): suspend (Input1, Input2, Input3) -> Result
fun <Result> memoizeSuspend(validFor: Duration, f: suspend () -> Result): suspend () -> Result
fun <Input, Result> memoizeSuspend(validFor: Duration, f: suspend (Input) -> Result): suspend (Input) -> Result
fun <Input1, Input2, Result> memoizeSuspend(validFor: Duration, f: suspend (Input1, Input2) -> Result): suspend (Input1, Input2) -> Result
fun <Input1, Input2, Input3, Result> memoizeSuspend(validFor: Duration, f: suspend (Input1, Input2, Input3) -> Result): suspend (Input1, Input2, Input3) -> Result
Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun minAspectRatioSurroundingSize(area: Size, aspectRatio: Float): Size

Determine the minimum size of rectangle with a given aspect ratio (X/Y) that a specified area can fit inside.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.move(relativeX: Int, relativeY: Int): Rect
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.move(relativeX: Float, relativeY: Float): RectF

Move relative to its current position

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.projectRegionOfInterest(toRect: Rect, regionOfInterest: Rect): Rect
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.projectRegionOfInterest(toRect: RectF, regionOfInterest: RectF): RectF

Project a region of interest from one Rect to another. For example, given the rect and region of interest:

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.projectRegionOfInterest(toSize: Size, regionOfInterest: Rect): Rect
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.projectRegionOfInterest(toSize: SizeF, regionOfInterest: RectF): RectF

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.projectRegionOfInterest(toSize: Size, regionOfInterest: Rect): Rect
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun SizeF.projectRegionOfInterest(toSize: SizeF, regionOfInterest: RectF): RectF

Takes a relation between a region of interest and a size and projects the region of interest to that new location

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.resizeRegion(originalRegion: Rect, newRegion: Rect, newSize: Size): Map<Rect, Rect>

This method allows relocating and resizing a portion of a Size. It returns the required translations required to achieve this relocation. This is useful for zooming in on sections of an image.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scale(scale: Float): Size
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun SizeF.scale(scale: Float): SizeF

Calculate the new size based on a percentage scale.

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scale(x: Float, y: Float): Size
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun SizeF.scale(x: Float, y: Float): SizeF

Calculate the new size based on percentage scale values.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scaleAndCenterSurrounding(surroundedSize: Size): Rect

Calculate the position of the Size surrounding the surroundedSize. This makes a few assumptions:

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scaleAndCenterWithin(containingRect: Rect): Rect

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scaleAndCenterWithin(containingSize: Size): Rect

Scale up a Size so that it fills a containingSize while maintaining its original aspect ratio.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.scaleCentered(x: Float, y: Float): Rect

Scale a size based on percentage scale values, and keep track of its position.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.scaled(scaledSize: Size): RectF

Scale a Rect to have a size equivalent to the scaledSize. This will also scale the position of the Rect.

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Rect.size(): Size

Determine the size of a Rect.

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.size(): SizeF

Determine the size of a RectF.

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun View.size(): Size

Determine the size of a View.

Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun RectF.toRect(): Rect

@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.toRect(): Rect

Converts a size to rectangle with the top left corner at 0,0

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@CheckResult
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])
fun Size.transpose(): Size

Transpose a size's width and height.