One Logo Pool Ball
X
Github
Discord

System

MetalPerformanceShaders · IOS API REFERENCE

MPSCNNMultiaryKernel

class · iOS 13.0+ · SDK 27.1

class MPSCNNMultiaryKernel

Members (46)

method · iOS 13.0+

appendBatchBarrier

TypeScript
appendBatchBarrier(): boolean
Swift declaration
func appendBatchBarrier() -> Bool
method · iOS 13.0+

destinationImageDescriptor

TypeScript
destinationImageDescriptor(sourceImages: Array<MPSImage>, sourceStates?: (Array<MPSState>) | null): MPSImageDescriptor
Swift declaration
func destinationImageDescriptor(sourceImages: [MPSImage], sourceStates: [MPSState]?) -> MPSImageDescriptor
method · iOS 13.0+

dilationRateXatIndex

TypeScript
dilationRateXatIndex(index: number): number
Swift declaration
func dilationRateXatIndex(_ index: Int) -> Int
method · iOS 13.0+

dilationRateYatIndex

TypeScript
dilationRateYatIndex(index: number): number
Swift declaration
func dilationRateYatIndex(_ index: Int) -> Int
method · iOS 13.0+

edgeMode

TypeScript
edgeMode(index: number): MPSImageEdgeMode
Swift declaration
func edgeMode(at index: Int) -> MPSImageEdgeMode
method · iOS 13.0+

encodeBatch

TypeScript
encodeBatchCommandBufferSourceImages(commandBuffer: SDKHandle, sourceImageBatches: Array<Array<MPSImage>>): Array<MPSImage>
Swift declaration
func encodeBatch(commandBuffer: any MTLCommandBuffer, sourceImages sourceImageBatches: [[MPSImage]]) -> [MPSImage]
method · iOS 13.0+

encodeBatch

TypeScript
encodeBatchCommandBufferSourceImagesDestinationImages(commandBuffer: SDKHandle, sourceImages: Array<Array<MPSImage>>, destinationImages: Array<MPSImage>): void
Swift declaration
func encodeBatch(commandBuffer: any MTLCommandBuffer, sourceImages: [[MPSImage]], destinationImages: [MPSImage])
method · iOS 13.0+

encodeBatch

TypeScript
encodeBatchCommandBufferSourceImagesDestinationStatesDestinationStateIsTemporary(commandBuffer: SDKHandle, sourceImageBatches: Array<Array<MPSImage>>, isTemporary: boolean): { $ret: Array<MPSImage>; $out: { "outState": (_Foundation_NSArray) | null } }
Swift declaration
func encodeBatch(commandBuffer: any MTLCommandBuffer, sourceImages sourceImageBatches: [[MPSImage]], destinationStates outState: AutoreleasingUnsafeMutablePointer<NSArray?>, destinationStateIsTemporary isTemporary: Bool) -> [MPSImage]

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

method · iOS 13.0+

encode

TypeScript
encodeCommandBufferSourceImages(commandBuffer: SDKHandle, sourceImages: Array<MPSImage>): MPSImage
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, sourceImages: [MPSImage]) -> MPSImage
method · iOS 13.0+

encode

TypeScript
encodeCommandBufferSourceImagesDestinationImage(commandBuffer: SDKHandle, sourceImages: Array<MPSImage>, destinationImage: MPSImage): void
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, sourceImages: [MPSImage], destinationImage: MPSImage)
method · iOS 13.0+

encode

TypeScript
encodeCommandBufferSourceImagesDestinationStateDestinationStateIsTemporary(commandBuffer: SDKHandle, sourceImages: Array<MPSImage>, isTemporary: boolean): { $ret: MPSImage; $out: { "outState": (MPSState) | null } }
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, sourceImages: [MPSImage], destinationState outState: AutoreleasingUnsafeMutablePointer<MPSState?>, destinationStateIsTemporary isTemporary: Bool) -> MPSImage

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

init · iOS 13.0+

init

TypeScript
static initCoderDevice(aDecoder: _Foundation_NSCoder, device: SDKHandle): (MPSCNNMultiaryKernel) | null
Swift declaration
init?(coder aDecoder: NSCoder, device: any MTLDevice)
init · iOS 13.0+

init

TypeScript
static initDeviceSourceCount(device: SDKHandle, sourceCount: number): MPSCNNMultiaryKernel
Swift declaration
init(device: any MTLDevice, sourceCount: Int)
method · iOS 13.0+

isResultStateReusedAcrossBatch

TypeScript
isResultStateReusedAcrossBatch(): boolean
Swift declaration
func isResultStateReusedAcrossBatch() -> Bool
method · iOS 13.0+

kernelHeight

TypeScript
kernelHeight(index: number): number
Swift declaration
func kernelHeight(at index: Int) -> Int
method · iOS 13.0+

kernelWidth

TypeScript
kernelWidth(index: number): number
Swift declaration
func kernelWidth(at index: Int) -> Int
method · iOS 13.0+

offset

TypeScript
offset(index: number): MPSOffset
Swift declaration
func offset(at index: Int) -> MPSOffset
method · iOS 13.0+

resultStateBatch

TypeScript
resultStateBatch(sourceImages: Array<Array<MPSImage>>, sourceStates: (Array<Array<MPSState>>) | null, destinationImage: Array<MPSImage>): (Array<MPSState>) | null
Swift declaration
func resultStateBatch(sourceImages: [[MPSImage]], sourceStates: [[MPSState]]?, destinationImage: [MPSImage]) -> [MPSState]?
method · iOS 13.0+

resultState

TypeScript
resultState(sourceImages: Array<MPSImage>, sourceStates: (Array<MPSState>) | null, destinationImage: MPSImage): (MPSState) | null
Swift declaration
func resultState(sourceImages: [MPSImage], sourceStates: [MPSState]?, destinationImage: MPSImage) -> MPSState?
method · iOS 13.0+

setDilationRateX

TypeScript
setDilationRateX(dilationRate: number, index: number): void
Swift declaration
func setDilationRateX(_ dilationRate: Int, at index: Int)
method · iOS 13.0+

setDilationRateY

TypeScript
setDilationRateY(dilationRate: number, index: number): void
Swift declaration
func setDilationRateY(_ dilationRate: Int, at index: Int)
method · iOS 13.0+

setEdgeMode

TypeScript
setEdgeMode(edgeMode: MPSImageEdgeMode, index: number): void
Swift declaration
func setEdgeMode(_ edgeMode: MPSImageEdgeMode, at index: Int)
method · iOS 13.0+

setKernelHeight

TypeScript
setKernelHeight(height: number, index: number): void
Swift declaration
func setKernelHeight(_ height: Int, at index: Int)
method · iOS 13.0+

setKernelWidth

TypeScript
setKernelWidth(width: number, index: number): void
Swift declaration
func setKernelWidth(_ width: Int, at index: Int)
method · iOS 13.0+

setOffset

TypeScript
setOffset(offset: MPSOffset, index: number): void
Swift declaration
func setOffset(_ offset: MPSOffset, at index: Int)
method · iOS 13.0+

setSourceFeatureChannelMaxCount

TypeScript
setSourceFeatureChannelMaxCount(count: number, index: number): void
Swift declaration
func setSourceFeatureChannelMaxCount(_ count: Int, at index: Int)
method · iOS 13.0+

setSourceFeatureChannelOffset

TypeScript
setSourceFeatureChannelOffset(offset: number, index: number): void
Swift declaration
func setSourceFeatureChannelOffset(_ offset: Int, at index: Int)
method · iOS 13.0+

setStrideInPixelsX

TypeScript
setStrideInPixelsX(stride: number, index: number): void
Swift declaration
func setStrideInPixelsX(_ stride: Int, at index: Int)
method · iOS 13.0+

setStrideInPixelsY

TypeScript
setStrideInPixelsY(stride: number, index: number): void
Swift declaration
func setStrideInPixelsY(_ stride: Int, at index: Int)
method · iOS 13.0+

sourceFeatureChannelMaxCount

TypeScript
sourceFeatureChannelMaxCount(index: number): number
Swift declaration
func sourceFeatureChannelMaxCount(at index: Int) -> Int
method · iOS 13.0+

sourceFeatureChannelOffset

TypeScript
sourceFeatureChannelOffset(index: number): number
Swift declaration
func sourceFeatureChannelOffset(at index: Int) -> Int
method · iOS 13.0+

stride

TypeScript
strideInPixelsXatIndex(index: number): number
Swift declaration
func stride(inPixelsXatIndex index: Int) -> Int
method · iOS 13.0+

stride

TypeScript
strideInPixelsYatIndex(index: number): number
Swift declaration
func stride(inPixelsYatIndex index: Int) -> Int
method · iOS 13.0+

temporaryResultStateBatch

TypeScript
temporaryResultStateBatch(commandBuffer: SDKHandle, sourceImage: Array<Array<MPSImage>>, sourceStates: (Array<Array<MPSState>>) | null, destinationImage: Array<MPSImage>): (Array<MPSState>) | null
Swift declaration
func temporaryResultStateBatch(commandBuffer: any MTLCommandBuffer, sourceImages sourceImage: [[MPSImage]], sourceStates: [[MPSState]]?, destinationImage: [MPSImage]) -> [MPSState]?
method · iOS 13.0+

temporaryResultState

TypeScript
temporaryResultState(commandBuffer: SDKHandle, sourceImage: Array<MPSImage>, sourceStates: (Array<MPSState>) | null, destinationImage: MPSImage): (MPSState) | null
Swift declaration
func temporaryResultState(commandBuffer: any MTLCommandBuffer, sourceImages sourceImage: [MPSImage], sourceStates: [MPSState]?, destinationImage: MPSImage) -> MPSState?
get · iOS 13.0+

clipRect

TypeScript
get clipRect(): _Metal_MTLRegion
Swift declaration
var clipRect: MTLRegion { get set }
set · iOS 13.0+

clipRect

TypeScript
set clipRect(value: _Metal_MTLRegion)
Swift declaration
var clipRect: MTLRegion { get set }
get · iOS 13.0+

destinationFeatureChannelOffset

TypeScript
get destinationFeatureChannelOffset(): number
Swift declaration
var destinationFeatureChannelOffset: Int { get set }
set · iOS 13.0+

destinationFeatureChannelOffset

TypeScript
set destinationFeatureChannelOffset(value: number)
Swift declaration
var destinationFeatureChannelOffset: Int { get set }
get · iOS 13.0+

destinationImageAllocator

TypeScript
get destinationImageAllocator(): SDKHandle
Swift declaration
var destinationImageAllocator: any MPSImageAllocator { get set }
set · iOS 13.0+

destinationImageAllocator

TypeScript
set destinationImageAllocator(value: SDKHandle)
Swift declaration
var destinationImageAllocator: any MPSImageAllocator { get set }
get · iOS 13.0+

isBackwards

TypeScript
get isBackwards(): boolean
Swift declaration
var isBackwards: Bool { get }
get · iOS 13.0+

isStateModified

TypeScript
get isStateModified(): boolean
Swift declaration
var isStateModified: Bool { get }
get · iOS 13.0+

padding

TypeScript
get padding(): SDKHandle
Swift declaration
var padding: any MPSNNPadding { get set }
set · iOS 13.0+

padding

TypeScript
set padding(value: SDKHandle)
Swift declaration
var padding: any MPSNNPadding { get set }
get · iOS 13.0+

sourceCount

TypeScript
get sourceCount(): number
Swift declaration
var sourceCount: Int { get }

Skipped declarations

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

MPSCNNMultiaryKernel.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All MetalPerformanceShaders types →