One Logo Pool Ball
CreateMLComponents · IOS API REFERENCE

ImageScaler

struct · iOS 16.0+ · SDK 27.1

struct ImageScaler

An image scaling transformer.

Members (7)

init · iOS 16.0+

init

TypeScript
static initTargetSize(targetSize: { width: number; height: number }): ImageScaler
Swift declaration
init(targetSize: CGSize)

Creates an image scaler transformer. This transformer is used to scale an image to the `targetSize`. - Parameters: - targetSize: The target image size. Both width and height must be positive.

get · iOS 16.0+

targetSize

TypeScript
get targetSize(): { width: number; height: number }
Swift declaration
var targetSize: CGSize { get set }

The target image size.

set · iOS 16.0+

targetSize

TypeScript
set targetSize(value: { width: number; height: number })
Swift declaration
var targetSize: CGSize { get set }

The target image size.

init · iOS 17.0+

init

TypeScript
static initTargetWidth(targetWidth: number): ImageScaler
Swift declaration
init(targetWidth: Double)

Creates an image scaler transformer that preserves the aspect ratio. This transformer scales an image to match the `targetWidth` while preserving the aspect ratio. - Parameters: - targetWidth: The target image width. It must be positive.

init · iOS 17.0+

init

TypeScript
static initTargetHeight(targetHeight: number): ImageScaler
Swift declaration
init(targetHeight: Double)

Creates an image scaler transformer that preserves the aspect ratio. This transformer scales an image to match the `targetHeight` while preserving the aspect ratio. - Parameters: - targetHeight: The target image height. It must be positive.

get · iOS 16.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

method · iOS 16.0+

applied

TypeScript
applied(image: _CoreImage_CIImage, eventHandler?: (((arg0: Event) => void)) | null): _CoreImage_CIImage
Swift declaration
func applied(to image: CIImage, eventHandler: EventHandler? = nil) throws -> CIImage

Perform the image scaler operation on the input pixelBuffer. - Parameters: - image: An image. - eventHandler: An event handler. - Returns: The scaled pixel buffer.

Skipped declarations

No declarations were skipped in this snapshot.

All CreateMLComponents types →