One Logo Pool Ball
X
Github
Discord

System

CoreImage · IOS API REFERENCE

CIImage

class · iOS 5.0+ · SDK 27.1

class CIImage

Members (81)

static · iOS 5.0+

empty

TypeScript
static empty(): CIImage
Swift declaration
class func empty() -> CIImage
get · iOS 13.0+

black

TypeScript
static get black(): CIImage
Swift declaration
class var black: CIImage { get }
get · iOS 13.0+

blue

TypeScript
static get blue(): CIImage
Swift declaration
class var blue: CIImage { get }
get · iOS 13.0+

clear

TypeScript
static get clear(): CIImage
Swift declaration
class var clear: CIImage { get }
get · iOS 13.0+

cyan

TypeScript
static get cyan(): CIImage
Swift declaration
class var cyan: CIImage { get }
get · iOS 13.0+

gray

TypeScript
static get gray(): CIImage
Swift declaration
class var gray: CIImage { get }
get · iOS 13.0+

green

TypeScript
static get green(): CIImage
Swift declaration
class var green: CIImage { get }
get · iOS 13.0+

magenta

TypeScript
static get magenta(): CIImage
Swift declaration
class var magenta: CIImage { get }
get · iOS 13.0+

red

TypeScript
static get red(): CIImage
Swift declaration
class var red: CIImage { get }
get · iOS 13.0+

white

TypeScript
static get white(): CIImage
Swift declaration
class var white: CIImage { get }
get · iOS 13.0+

yellow

TypeScript
static get yellow(): CIImage
Swift declaration
class var yellow: CIImage { get }
method · iOS 5.0+

autoAdjustmentFilters

TypeScript
autoAdjustmentFilters(): Array<CIFilter>
Swift declaration
func autoAdjustmentFilters() -> [CIFilter]
method · iOS 5.0+

autoAdjustmentFilters

TypeScript
autoAdjustmentFiltersOptions(options?: (NativeMap<CIImageAutoAdjustmentOption, unknown>) | null): Array<CIFilter>
Swift declaration
func autoAdjustmentFilters(options: [CIImageAutoAdjustmentOption : Any]? = nil) -> [CIFilter]
method · iOS 11.0+

oriented

TypeScript
oriented(orientation: _ImageIO_CGImagePropertyOrientation): CIImage
Swift declaration
func oriented(_ orientation: CGImagePropertyOrientation) -> CIImage
method · iOS 11.0+

applyingFilter

TypeScript
applyingFilter(filterName: string): CIImage
Swift declaration
func applyingFilter(_ filterName: String) -> CIImage
method · iOS 8.0+

applyingFilter

TypeScript
applyingFilterParameters(filterName: string, params: Record<string, unknown>): CIImage
Swift declaration
func applyingFilter(_ filterName: String, parameters params: [String : Any]) -> CIImage
method · iOS 18.0+

applyingGainMap

TypeScript
applyingGainMap(gainmap: CIImage): CIImage
Swift declaration
func applyingGainMap(_ gainmap: CIImage) -> CIImage
method · iOS 18.0+

applyingGainMap

TypeScript
applyingGainMapHeadroom(gainmap: CIImage, headroom: number): CIImage
Swift declaration
func applyingGainMap(_ gainmap: CIImage, headroom: Float) -> CIImage
method · iOS 10.0+

applyingGaussianBlur

TypeScript
applyingGaussianBlur(sigma: number): CIImage
Swift declaration
func applyingGaussianBlur(sigma: Double) -> CIImage
method · iOS 8.0+

oriented

TypeScript
orientedForExifOrientation(orientation: number): CIImage
Swift declaration
func oriented(forExifOrientation orientation: Int32) -> CIImage
method · iOS 5.0+

transformed

TypeScript
transformedBy(matrix: _CoreFoundation_CGAffineTransform): CIImage
Swift declaration
func transformed(by matrix: CGAffineTransform) -> CIImage
method · iOS 10.0+

transformed

TypeScript
transformedByHighQualityDownsample(matrix: _CoreFoundation_CGAffineTransform, highQualityDownsample: boolean): CIImage
Swift declaration
func transformed(by matrix: CGAffineTransform, highQualityDownsample: Bool) -> CIImage
method · iOS 8.0+

clampedToExtent

TypeScript
clampedToExtent(): CIImage
Swift declaration
func clampedToExtent() -> CIImage
method · iOS 10.0+

clamped

TypeScript
clamped(rect: { x: number; y: number; width: number; height: number }): CIImage
Swift declaration
func clamped(to rect: CGRect) -> CIImage
method · iOS 10.0+

matchedToWorkingSpace

TypeScript
matchedToWorkingSpace(colorSpace: _CoreGraphics_CGColorSpace): (CIImage) | null
Swift declaration
func matchedToWorkingSpace(from colorSpace: CGColorSpace) -> CIImage?
method · iOS 10.0+

matchedFromWorkingSpace

TypeScript
matchedFromWorkingSpace(colorSpace: _CoreGraphics_CGColorSpace): (CIImage) | null
Swift declaration
func matchedFromWorkingSpace(to colorSpace: CGColorSpace) -> CIImage?
method · iOS 8.0+

composited

TypeScript
composited(dest: CIImage): CIImage
Swift declaration
func composited(over dest: CIImage) -> CIImage
method · iOS 16.0+

convertingLabToWorkingSpace

TypeScript
convertingLabToWorkingSpace(): CIImage
Swift declaration
func convertingLabToWorkingSpace() -> CIImage
method · iOS 16.0+

convertingWorkingSpaceToLab

TypeScript
convertingWorkingSpaceToLab(): CIImage
Swift declaration
func convertingWorkingSpaceToLab() -> CIImage
method · iOS 5.0+

cropped

TypeScript
cropped(rect: { x: number; y: number; width: number; height: number }): CIImage
Swift declaration
func cropped(to rect: CGRect) -> CIImage
method · iOS 12.0+

insertingIntermediate

TypeScript
insertingIntermediate(): CIImage
Swift declaration
func insertingIntermediate() -> CIImage
method · iOS 12.0+

insertingIntermediate

TypeScript
insertingIntermediateCache(cache: boolean): CIImage
Swift declaration
func insertingIntermediate(cache: Bool) -> CIImage
method · iOS 26.0+

insertingTiledIntermediate

TypeScript
insertingTiledIntermediate(): CIImage
Swift declaration
func insertingTiledIntermediate() -> CIImage
method · iOS 10.0+

premultiplyingAlpha

TypeScript
premultiplyingAlpha(): CIImage
Swift declaration
func premultiplyingAlpha() -> CIImage
method · iOS 11.0+

samplingLinear

TypeScript
samplingLinear(): CIImage
Swift declaration
func samplingLinear() -> CIImage
method · iOS 11.0+

samplingNearest

TypeScript
samplingNearest(): CIImage
Swift declaration
func samplingNearest() -> CIImage
method · iOS 10.0+

settingAlphaOne

TypeScript
settingAlphaOne(extent: { x: number; y: number; width: number; height: number }): CIImage
Swift declaration
func settingAlphaOne(in extent: CGRect) -> CIImage
method · iOS 26.0+

settingContentAverageLightLevel

TypeScript
settingContentAverageLightLevel(average: number): CIImage
Swift declaration
func settingContentAverageLightLevel(_ average: Float) -> CIImage
method · iOS 26.0+

settingContentHeadroom

TypeScript
settingContentHeadroom(headroom: number): CIImage
Swift declaration
func settingContentHeadroom(_ headroom: Float) -> CIImage
method · iOS 10.0+

settingProperties

TypeScript
settingProperties(properties: NativeMap<unknown, unknown>): CIImage
Swift declaration
func settingProperties(_ properties: [AnyHashable : Any]) -> CIImage
method · iOS 10.0+

unpremultiplyingAlpha

TypeScript
unpremultiplyingAlpha(): CIImage
Swift declaration
func unpremultiplyingAlpha() -> CIImage
method · iOS 11.0+

orientationTransform

TypeScript
orientationTransformFor(orientation: _ImageIO_CGImagePropertyOrientation): _CoreFoundation_CGAffineTransform
Swift declaration
func orientationTransform(for orientation: CGImagePropertyOrientation) -> CGAffineTransform
method · iOS 8.0+

orientationTransform

TypeScript
orientationTransformForExifOrientation(orientation: number): _CoreFoundation_CGAffineTransform
Swift declaration
func orientationTransform(forExifOrientation orientation: Int32) -> CGAffineTransform
init · iOS 5.0+

init

TypeScript
static initBitmapDataBytesPerRowSizeFormatColorSpace(data: ArrayBuffer, bytesPerRow: number, size: { width: number; height: number }, format: CIFormat, colorSpace?: (_CoreGraphics_CGColorSpace) | null): CIImage
Swift declaration
init(bitmapData data: Data, bytesPerRow: Int, size: CGSize, format: CIFormat, colorSpace: CGColorSpace?)
init · iOS 5.0+

init

TypeScript
static initCgImage(image: _CoreGraphics_CGImage): CIImage
Swift declaration
init(cgImage image: CGImage)
init · iOS 5.0+

init

TypeScript
static initCgImageOptions(image: _CoreGraphics_CGImage, options?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(cgImage image: CGImage, options: [CIImageOption : Any]? = nil)
init · iOS 13.0+

init

TypeScript
static initCgImageSourceIndexOptions(source: _ImageIO_CGImageSource, index: number, dict?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(cgImageSource source: CGImageSource, index: Int, options dict: [CIImageOption : Any]? = nil)
init · iOS 9.0+

init

TypeScript
static initCvImageBuffer(imageBuffer: _CoreVideo_CVBuffer): CIImage
Swift declaration
init(cvImageBuffer imageBuffer: CVImageBuffer)
init · iOS 9.0+

init

TypeScript
static initCvImageBufferOptions(imageBuffer: _CoreVideo_CVBuffer, options?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(cvImageBuffer imageBuffer: CVImageBuffer, options: [CIImageOption : Any]? = nil)
init · iOS 5.0+

init

TypeScript
static initCvPixelBuffer(pixelBuffer: _CoreVideo_CVBuffer): CIImage
Swift declaration
init(cvPixelBuffer pixelBuffer: CVPixelBuffer)
init · iOS 5.0+

init

TypeScript
static initCvPixelBufferOptions(pixelBuffer: _CoreVideo_CVBuffer, options?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(cvPixelBuffer pixelBuffer: CVPixelBuffer, options: [CIImageOption : Any]? = nil)
init · iOS 5.0+

init

TypeScript
static initColor(color: CIColor): CIImage
Swift declaration
init(color: CIColor)
init · iOS 5.0+

init

TypeScript
static initContentsOf(url: string): (CIImage) | null
Swift declaration
init?(contentsOf url: URL)
init · iOS 5.0+

init

TypeScript
static initContentsOfOptions(url: string, options?: (NativeMap<CIImageOption, unknown>) | null): (CIImage) | null
Swift declaration
init?(contentsOf url: URL, options: [CIImageOption : Any]? = nil)
init · iOS 5.0+

init

TypeScript
static initData(data: ArrayBuffer): (CIImage) | null
Swift declaration
init?(data: Data)
init · iOS 5.0+

init

TypeScript
static initDataOptions(data: ArrayBuffer, options?: (NativeMap<CIImageOption, unknown>) | null): (CIImage) | null
Swift declaration
init?(data: Data, options: [CIImageOption : Any]? = nil)
init · iOS 11.0+

init

TypeScript
static initDepthData(data: _AVFoundation_AVDepthData): (CIImage) | null
Swift declaration
init?(depthData data: AVDepthData)
init · iOS 11.0+

init

TypeScript
static initDepthDataOptions(data: _AVFoundation_AVDepthData, options?: (Record<string, unknown>) | null): (CIImage) | null
Swift declaration
init?(depthData data: AVDepthData, options: [String : Any]? = nil)
init · iOS 5.0+

init

TypeScript
static initIoSurface(surface: _IOSurface_IOSurfaceRef): CIImage
Swift declaration
init(ioSurface surface: IOSurfaceRef)
init · iOS 5.0+

init

TypeScript
static initIoSurfaceOptions(surface: _IOSurface_IOSurfaceRef, options?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(ioSurface surface: IOSurfaceRef, options: [CIImageOption : Any]? = nil)
init · iOS 9.0+

init

TypeScript
static initImageProviderSizeFormatColorSpaceOptions(provider: unknown, width: number, height: number, format: CIFormat, colorSpace?: (_CoreGraphics_CGColorSpace) | null, options?: (NativeMap<CIImageOption, unknown>) | null): CIImage
Swift declaration
init(imageProvider provider: Any, size width: Int, _ height: Int, format: CIFormat, colorSpace: CGColorSpace?, options: [CIImageOption : Any]? = nil)
init · iOS 9.0+

init

TypeScript
static initMtlTextureOptions(texture: SDKHandle, options?: (NativeMap<CIImageOption, unknown>) | null): (CIImage) | null
Swift declaration
init?(mtlTexture texture: any MTLTexture, options: [CIImageOption : Any]? = nil)
init · iOS 11.0+

init

TypeScript
static initPortaitEffectsMatte(matte: _AVFoundation_AVPortraitEffectsMatte): (CIImage) | null
Swift declaration
init?(portaitEffectsMatte matte: AVPortraitEffectsMatte)
init · iOS 12.0+

init

TypeScript
static initPortaitEffectsMatteOptions(matte: _AVFoundation_AVPortraitEffectsMatte, options?: (NativeMap<CIImageOption, unknown>) | null): (CIImage) | null
Swift declaration
init?(portaitEffectsMatte matte: AVPortraitEffectsMatte, options: [CIImageOption : Any]? = nil)
init · iOS 13.0+

init

TypeScript
static initSemanticSegmentationMatte(matte: _AVFoundation_AVSemanticSegmentationMatte): (CIImage) | null
Swift declaration
init?(semanticSegmentationMatte matte: AVSemanticSegmentationMatte)
init · iOS 13.0+

init

TypeScript
static initSemanticSegmentationMatteOptions(matte: _AVFoundation_AVSemanticSegmentationMatte, options?: (NativeMap<CIImageOption, unknown>) | null): (CIImage) | null
Swift declaration
init?(semanticSegmentationMatte matte: AVSemanticSegmentationMatte, options: [CIImageOption : Any]? = nil)
init · iOS 6.0+ · Deprecated in iOS 12.0

init

TypeScript
static initTextureSizeFlippedColorSpace(name: number, size: { width: number; height: number }, flipped: boolean, colorSpace?: (_CoreGraphics_CGColorSpace) | null): CIImage
Swift declaration
init(texture name: UInt32, size: CGSize, flipped: Bool, colorSpace: CGColorSpace?)
method · iOS 6.0+

regionOfInterest

TypeScript
regionOfInterest(image: CIImage, rect: { x: number; y: number; width: number; height: number }): { x: number; y: number; width: number; height: number }
Swift declaration
func regionOfInterest(for image: CIImage, in rect: CGRect) -> CGRect
get · iOS 10.0+

cgImage

TypeScript
get cgImage(): (_CoreGraphics_CGImage) | null
Swift declaration
var cgImage: CGImage? { get }
get · iOS 9.0+

colorSpace

TypeScript
get colorSpace(): (_CoreGraphics_CGColorSpace) | null
Swift declaration
var colorSpace: CGColorSpace? { get }
get · iOS 26.0+

contentAverageLightLevel

TypeScript
get contentAverageLightLevel(): number
Swift declaration
var contentAverageLightLevel: Float { get }
get · iOS 18.0+

contentHeadroom

TypeScript
get contentHeadroom(): number
Swift declaration
var contentHeadroom: Float { get }
get · iOS 11.0+

depthData

TypeScript
get depthData(): (_AVFoundation_AVDepthData) | null
Swift declaration
var depthData: AVDepthData? { get }
get · iOS 5.0+

extent

TypeScript
get extent(): { x: number; y: number; width: number; height: number }
Swift declaration
var extent: CGRect { get }
get · iOS 18.0+

metalTexture

TypeScript
get metalTexture(): (SDKHandle) | null
Swift declaration
var metalTexture: (any MTLTexture)? { get }
get · iOS 5.0+

isOpaque

TypeScript
get isOpaque(): boolean
Swift declaration
var isOpaque: Bool { get }
get · iOS 10.0+

pixelBuffer

TypeScript
get pixelBuffer(): (_CoreVideo_CVBuffer) | null
Swift declaration
var pixelBuffer: CVPixelBuffer? { get }
get · iOS 12.0+

portraitEffectsMatte

TypeScript
get portraitEffectsMatte(): (_AVFoundation_AVPortraitEffectsMatte) | null
Swift declaration
var portraitEffectsMatte: AVPortraitEffectsMatte? { get }
get · iOS 5.0+

properties

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

semanticSegmentationMatte

TypeScript
get semanticSegmentationMatte(): (_AVFoundation_AVSemanticSegmentationMatte) | null
Swift declaration
var semanticSegmentationMatte: AVSemanticSegmentationMatte? { get }
get · iOS 9.0+

url

TypeScript
get url(): (string) | null
Swift declaration
var url: URL? { get }

Skipped declarations

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

CIImage.init()

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

All CoreImage types →