One Logo Pool Ball
Accelerate · IOS API REFERENCE

vImage.Options

struct · iOS 13.0+ · SDK 27.1

struct Options

An option set that represents `vImage_Flags`. You can also use this option set with the existing vImage API with the `flags` property. For example: vImageTentConvolve_ARGB8888(&src, &dst, nil, 0, 0, 11, 11, [0,0,0,0], vImage_Options([.backgroundColorFill, .doNotTile]).flags)

Members (16)

get · iOS 13.0+

doNotClamp

TypeScript
get doNotClamp(): vImage_Options
Swift declaration
static let doNotClamp: vImage.Options

Pass to disable clamping is some conversions to floating point formats. Use this if the input data may describe values outside [0,1] which should be preserved.

get · iOS 13.0+

hdrContent

TypeScript
get hdrContent(): vImage_Options
Swift declaration
static let hdrContent: vImage.Options

Use methods that are HDR-aware, capable of providing correct results for input images with pixel values outside the otherwise limited (typically [-2,2]) range. This may be slower.

get · iOS 13.0+

noAllocate

TypeScript
get noAllocate(): vImage_Options
Swift declaration
static let noAllocate: vImage.Options

Pass this flag to prevent vImage from allocating additional storage.

get · iOS 13.0+

copyInPlace

TypeScript
get copyInPlace(): vImage_Options
Swift declaration
static let copyInPlace: vImage.Options

Copy edge pixels. Convolution Only.

get · iOS 13.0+

imageExtend

TypeScript
get imageExtend(): vImage_Options
Swift declaration
static let imageExtend: vImage.Options

Use the nearest pixel for missing pixels.

get · iOS 13.0+

truncateKernel

TypeScript
get truncateKernel(): vImage_Options
Swift declaration
static let truncateKernel: vImage.Options

Use only the part of the kernel that overlaps the image. For integer kernels, real_divisor = divisor * (sum of used kernel elements) / (sum of kernel elements). This should preserve image brightness at the edges. Convolution only.

get · iOS 13.0+

getTempBufferSize

TypeScript
get getTempBufferSize(): vImage_Options
Swift declaration
static let getTempBufferSize: vImage.Options

The function will return the number of bytes required for the temp buffer. If this value is negative, it is an error, per standard usage.

get · iOS 13.0+

backgroundColorFill

TypeScript
get backgroundColorFill(): vImage_Options
Swift declaration
static let backgroundColorFill: vImage.Options

Use the background color for missing pixels.

get · iOS 13.0+

leaveAlphaUnchanged

TypeScript
get leaveAlphaUnchanged(): vImage_Options
Swift declaration
static let leaveAlphaUnchanged: vImage.Options

Operate on red, green and blue channels only. Alpha is copied from source to destination. For Interleaved formats only

get · iOS 13.0+

highQualityResampling

TypeScript
get highQualityResampling(): vImage_Options
Swift declaration
static let highQualityResampling: vImage.Options

Use a higher quality, slower resampling filter for Geometry operations (shear, scale, rotate, affine transform, etc.)

get · iOS 13.0+

printDiagnosticsToConsole

TypeScript
get printDiagnosticsToConsole(): vImage_Options
Swift declaration
static let printDiagnosticsToConsole: vImage.Options

Some functions such as vImageConverter_CreateWithCGImageFormat have so many possible error conditions that developers may need more help than a simple error code to diagnose problems. When this flag is set and an error is encountered, an informative error message will be logged to the Apple System Logger (ASL). The output should be visible in Console.app.

get · iOS 13.0+

flags

TypeScript
getFlags($self: vImage_Options): number
Swift declaration
var flags: vImage_Flags { get }
get · iOS 13.0+

noFlags

TypeScript
get noFlags(): vImage_Options
Swift declaration
static let noFlags: vImage.Options
init · iOS 13.0+

init

TypeScript
init(rawValue: number): vImage_Options
Swift declaration
init(rawValue: vImage_Flags)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 13.0+

rawValue

TypeScript
getRawValue($self: vImage_Options): number
Swift declaration
let rawValue: vImage_Flags

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 13.0+

doNotTile

TypeScript
get doNotTile(): vImage_Options
Swift declaration
static let doNotTile: vImage.Options

Pass to turn off internal tiling and disable internal multithreading. Use this if you want to do your own tiling, or to use the Min/Max filters in place.

Skipped declarations

No declarations were skipped in this snapshot.

All Accelerate types →