One Logo Pool Ball
CoreImage · IOS API REFERENCE

CIFilter

class · iOS 5.0+ · SDK 27.1

class CIFilter

Members (22)

static · iOS 6.0+ · Deprecated in iOS 17.0

filterArray

TypeScript
static filterArray(xmpData: ArrayBuffer, extent: { x: number; y: number; width: number; height: number }): { $ret: Array<CIFilter>; $out: { "outError": (_Foundation_NSError) | null } }
Swift declaration
class func filterArray(fromSerializedXMP xmpData: Data, inputImageExtent extent: CGRect, error outError: NSErrorPointer) -> [CIFilter]

Omit the output parameters from the call. The result contains $ret and $out, with outError inside $out.

static

filterNames

TypeScript
static filterNamesInCategories(categories?: (Array<string>) | null): Array<string>
Swift declaration
class func filterNames(inCategories categories: [String]?) -> [String]
static

filterNames

TypeScript
static filterNamesInCategory(category?: (string) | null): Array<string>
Swift declaration
class func filterNames(inCategory category: String?) -> [String]
init · iOS 10.0+ · Deprecated in iOS 100000.0

init

TypeScript
static initCvPixelBufferPropertiesOptions(pixelBuffer?: (_CoreVideo_CVBuffer) | null, properties?: (NativeMap<unknown, unknown>) | null, options?: (NativeMap<CIRAWFilterOption, unknown>) | null): CIFilter
Swift declaration
init!(cvPixelBuffer pixelBuffer: CVPixelBuffer!, properties: [AnyHashable : Any]!, options: [CIRAWFilterOption : Any]! = [:])
init · iOS 10.0+ · Deprecated in iOS 100000.0

init

TypeScript
static initImageDataOptions(data?: (ArrayBuffer) | null, options?: (NativeMap<CIRAWFilterOption, unknown>) | null): CIFilter
Swift declaration
init!(imageData data: Data!, options: [CIRAWFilterOption : Any]! = [:])
init · iOS 10.0+ · Deprecated in iOS 100000.0

init

TypeScript
static initImageURLOptions(url?: (string) | null, options?: (NativeMap<CIRAWFilterOption, unknown>) | null): CIFilter
Swift declaration
init!(imageURL url: URL!, options: [CIRAWFilterOption : Any]! = [:])
init

init

TypeScript
static initName(name: string): (CIFilter) | null
Swift declaration
init?(name: String)
init · iOS 8.0+

init

TypeScript
static initNameParameters(name: string, params?: (Record<string, unknown>) | null): (CIFilter) | null
Swift declaration
init?(name: String, parameters params: [String : Any]?)
static · iOS 9.0+

localizedDescription

TypeScript
static localizedDescription(filterName: string): (string) | null
Swift declaration
class func localizedDescription(forFilterName filterName: String) -> String?
static · iOS 9.0+

localizedName

TypeScript
static localizedNameForCategory(category: string): string
Swift declaration
class func localizedName(forCategory category: String) -> String
static · iOS 9.0+

localizedName

TypeScript
static localizedNameForFilterName(filterName: string): (string) | null
Swift declaration
class func localizedName(forFilterName filterName: String) -> String?
static · iOS 9.0+

localizedReferenceDocumentation

TypeScript
static localizedReferenceDocumentation(filterName: string): (string) | null
Swift declaration
class func localizedReferenceDocumentation(forFilterName filterName: String) -> URL?
static · iOS 9.0+

registerName

TypeScript
static registerName(name: string, anObject: SDKHandle, attributes?: Record<string, unknown>): void
Swift declaration
class func registerName(_ name: String, constructor anObject: any CIFilterConstructor, classAttributes attributes: [String : Any] = [:])
static · iOS 6.0+ · Deprecated in iOS 17.0

serializedXMP

TypeScript
static serializedXMP(filters: Array<CIFilter>, extent: { x: number; y: number; width: number; height: number }): (ArrayBuffer) | null
Swift declaration
class func serializedXMP(from filters: [CIFilter], inputImageExtent extent: CGRect) -> Data?
static · iOS 13.0+ · Deprecated in iOS 100000.0

supportedRawCameraModels

TypeScript
static supportedRawCameraModels(): (Array<string>) | null
Swift declaration
class func supportedRawCameraModels() -> [String]!
method · iOS 5.0+

setDefaults

TypeScript
setDefaults(): void
Swift declaration
func setDefaults()
get · iOS 5.0+

attributes

TypeScript
get attributes(): Record<string, unknown>
Swift declaration
var attributes: [String : Any] { get }
get · iOS 5.0+

inputKeys

TypeScript
get inputKeys(): Array<string>
Swift declaration
var inputKeys: [String] { get }
get · iOS 5.0+

name

TypeScript
get name(): string
Swift declaration
var name: String { get set }
set · iOS 5.0+

name

TypeScript
set name(value: string)
Swift declaration
var name: String { get set }
get · iOS 5.0+

outputImage

TypeScript
get outputImage(): (CIImage) | null
Swift declaration
var outputImage: CIImage? { get }
get · iOS 5.0+

outputKeys

TypeScript
get outputKeys(): Array<string>
Swift declaration
var outputKeys: [String] { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CIFilter.init()

inherited init: cannot prove legal (class declares 7 custom initializers)

All CoreImage types →