MetalPerformanceShaders · IOS API REFERENCE

MPSCNNBinaryKernel

class · iOS 11.0+ · SDK 27.1

class MPSCNNBinaryKernel

Members (59)

method · iOS 11.3+

appendBatchBarrier

TypeScript

appendBatchBarrier(): boolean

Swift declaration

func appendBatchBarrier() -> Bool

method · iOS 13.0+

batchEncodingStorageSize

TypeScript

batchEncodingStorageSize(primaryImage: Array<MPSImage>, secondaryImage: Array<MPSImage>, sourceStates?: (Array<Array<MPSState>>) | null, destinationImage?: (Array<MPSImage>) | null): number

Swift declaration

func batchEncodingStorageSize(primaryImage: [MPSImage], secondaryImage: [MPSImage], sourceStates: [[MPSState]]?, destinationImage: [MPSImage]?) -> Int

method · iOS 11.0+

destinationImageDescriptor

TypeScript

destinationImageDescriptor(sourceImages: Array<MPSImage>, sourceStates?: (Array<MPSState>) | null): MPSImageDescriptor

Swift declaration

func destinationImageDescriptor(forSourceImages sourceImages: [MPSImage], sourceStates: [MPSState]?) -> MPSImageDescriptor

method · iOS 11.3+

encodeBatch

TypeScript

encodeBatchCommandBufferPrimaryImagesSecondaryImages(commandBuffer: SDKHandle, primaryImage: Array<MPSImage>, secondaryImage: Array<MPSImage>): Array<MPSImage>

Swift declaration

func encodeBatch(commandBuffer: any MTLCommandBuffer, primaryImages primaryImage: [MPSImage], secondaryImages secondaryImage: [MPSImage]) -> [MPSImage]

method · iOS 11.3+

encodeBatch

TypeScript

encodeBatchCommandBufferPrimaryImagesSecondaryImagesDestinationImages(commandBuffer: SDKHandle, primaryImages: Array<MPSImage>, secondaryImages: Array<MPSImage>, destinationImages: Array<MPSImage>): void

Swift declaration

func encodeBatch(commandBuffer: any MTLCommandBuffer, primaryImages: [MPSImage], secondaryImages: [MPSImage], destinationImages: [MPSImage])

method · iOS 11.3+

encodeBatch

TypeScript

encodeBatchCommandBufferPrimaryImagesSecondaryImagesDestinationStatesDestinationStateIsTemporary(commandBuffer: SDKHandle, primaryImages: Array<MPSImage>, secondaryImages: Array<MPSImage>, isTemporary: boolean): { $ret: Array<MPSImage>; $out: { "outState": (_Foundation_NSArray) | null } }

Swift declaration

func encodeBatch(commandBuffer: any MTLCommandBuffer, primaryImages: [MPSImage], secondaryImages: [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 11.0+

encode

TypeScript

encodeCommandBufferPrimaryImageSecondaryImage(commandBuffer: SDKHandle, primaryImage: MPSImage, secondaryImage: MPSImage): MPSImage

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, primaryImage: MPSImage, secondaryImage: MPSImage) -> MPSImage

method · iOS 11.0+

encode

TypeScript

encodeCommandBufferPrimaryImageSecondaryImageDestinationImage(commandBuffer: SDKHandle, primaryImage: MPSImage, secondaryImage: MPSImage, destinationImage: MPSImage): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, primaryImage: MPSImage, secondaryImage: MPSImage, destinationImage: MPSImage)

method · iOS 11.3+

encode

TypeScript

encodeCommandBufferPrimaryImageSecondaryImageDestinationStateDestinationStateIsTemporary(commandBuffer: SDKHandle, primaryImage: MPSImage, secondaryImage: MPSImage, isTemporary: boolean): { $ret: MPSImage; $out: { "outState": (MPSState) | null } }

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, primaryImage: MPSImage, secondaryImage: 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.

method · iOS 13.0+

encodingStorageSize

TypeScript

encodingStorageSize(primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates?: (Array<MPSState>) | null, destinationImage?: (MPSImage) | null): number

Swift declaration

func encodingStorageSize(primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates: [MPSState]?, destinationImage: MPSImage?) -> Int

init · iOS 11.0+

init

TypeScript

static initCoderDevice(aDecoder: _Foundation_NSCoder, device: SDKHandle): (MPSCNNBinaryKernel) | null

Swift declaration

init?(coder aDecoder: NSCoder, device: any MTLDevice)

init · iOS 11.0+

init

TypeScript

static initDevice(device: SDKHandle): MPSCNNBinaryKernel

Swift declaration

init(device: any MTLDevice)

method · iOS 11.3+

isResultStateReusedAcrossBatch

TypeScript

isResultStateReusedAcrossBatch(): boolean

Swift declaration

func isResultStateReusedAcrossBatch() -> Bool

method · iOS 11.3+

resultStateBatch

TypeScript

resultStateBatch(primaryImage: Array<MPSImage>, secondaryImage: Array<MPSImage>, sourceStates: (Array<Array<MPSState>>) | null, destinationImage: Array<MPSImage>): (Array<MPSState>) | null

Swift declaration

func resultStateBatch(primaryImage: [MPSImage], secondaryImage: [MPSImage], sourceStates: [[MPSState]]?, destinationImage: [MPSImage]) -> [MPSState]?

method · iOS 11.3+

resultState

TypeScript

resultState(primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates: (Array<MPSState>) | null, destinationImage: MPSImage): (MPSState) | null

Swift declaration

func resultState(primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates: [MPSState]?, destinationImage: MPSImage) -> MPSState?

method · iOS 11.3+

temporaryResultStateBatch

TypeScript

temporaryResultStateBatch(commandBuffer: SDKHandle, primaryImage: Array<MPSImage>, secondaryImage: Array<MPSImage>, sourceStates: (Array<Array<MPSState>>) | null, destinationImage: Array<MPSImage>): (Array<MPSState>) | null

Swift declaration

func temporaryResultStateBatch(commandBuffer: any MTLCommandBuffer, primaryImage: [MPSImage], secondaryImage: [MPSImage], sourceStates: [[MPSState]]?, destinationImage: [MPSImage]) -> [MPSState]?

method · iOS 11.3+

temporaryResultState

TypeScript

temporaryResultState(commandBuffer: SDKHandle, primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates: (Array<MPSState>) | null, destinationImage: MPSImage): (MPSState) | null

Swift declaration

func temporaryResultState(commandBuffer: any MTLCommandBuffer, primaryImage: MPSImage, secondaryImage: MPSImage, sourceStates: [MPSState]?, destinationImage: MPSImage) -> MPSState?

get · iOS 11.0+

clipRect

TypeScript

get clipRect(): _Metal_MTLRegion

Swift declaration

var clipRect: MTLRegion { get set }

set · iOS 11.0+

clipRect

TypeScript

set clipRect(value: _Metal_MTLRegion)

Swift declaration

var clipRect: MTLRegion { get set }

get · iOS 11.0+

destinationFeatureChannelOffset

TypeScript

get destinationFeatureChannelOffset(): number

Swift declaration

var destinationFeatureChannelOffset: Int { get set }

set · iOS 11.0+

destinationFeatureChannelOffset

TypeScript

set destinationFeatureChannelOffset(value: number)

Swift declaration

var destinationFeatureChannelOffset: Int { get set }

get · iOS 11.0+

destinationImageAllocator

TypeScript

get destinationImageAllocator(): SDKHandle

Swift declaration

var destinationImageAllocator: any MPSImageAllocator { get set }

set · iOS 11.0+

destinationImageAllocator

TypeScript

set destinationImageAllocator(value: SDKHandle)

Swift declaration

var destinationImageAllocator: any MPSImageAllocator { get set }

get · iOS 11.0+

isBackwards

TypeScript

get isBackwards(): boolean

Swift declaration

var isBackwards: Bool { get }

get · iOS 11.3+

isStateModified

TypeScript

get isStateModified(): boolean

Swift declaration

var isStateModified: Bool { get }

get · iOS 11.0+

padding

TypeScript

get padding(): SDKHandle

Swift declaration

var padding: any MPSNNPadding { get set }

set · iOS 11.0+

padding

TypeScript

set padding(value: SDKHandle)

Swift declaration

var padding: any MPSNNPadding { get set }

get · iOS 11.3+

primaryDilationRateX

TypeScript

get primaryDilationRateX(): number

Swift declaration

var primaryDilationRateX: Int { get }

get · iOS 11.3+

primaryDilationRateY

TypeScript

get primaryDilationRateY(): number

Swift declaration

var primaryDilationRateY: Int { get }

get · iOS 11.0+

primaryEdgeMode

TypeScript

get primaryEdgeMode(): MPSImageEdgeMode

Swift declaration

var primaryEdgeMode: MPSImageEdgeMode { get set }

set · iOS 11.0+

primaryEdgeMode

TypeScript

set primaryEdgeMode(value: MPSImageEdgeMode)

Swift declaration

var primaryEdgeMode: MPSImageEdgeMode { get set }

get · iOS 11.3+

primaryKernelHeight

TypeScript

get primaryKernelHeight(): number

Swift declaration

var primaryKernelHeight: Int { get }

get · iOS 11.3+

primaryKernelWidth

TypeScript

get primaryKernelWidth(): number

Swift declaration

var primaryKernelWidth: Int { get }

get · iOS 11.0+

primaryOffset

TypeScript

get primaryOffset(): MPSOffset

Swift declaration

var primaryOffset: MPSOffset { get set }

set · iOS 11.0+

primaryOffset

TypeScript

set primaryOffset(value: MPSOffset)

Swift declaration

var primaryOffset: MPSOffset { get set }

get · iOS 11.0+

primarySourceFeatureChannelMaxCount

TypeScript

get primarySourceFeatureChannelMaxCount(): number

Swift declaration

var primarySourceFeatureChannelMaxCount: Int { get set }

set · iOS 11.0+

primarySourceFeatureChannelMaxCount

TypeScript

set primarySourceFeatureChannelMaxCount(value: number)

Swift declaration

var primarySourceFeatureChannelMaxCount: Int { get set }

get · iOS 11.3+

primarySourceFeatureChannelOffset

TypeScript

get primarySourceFeatureChannelOffset(): number

Swift declaration

var primarySourceFeatureChannelOffset: Int { get set }

set · iOS 11.3+

primarySourceFeatureChannelOffset

TypeScript

set primarySourceFeatureChannelOffset(value: number)

Swift declaration

var primarySourceFeatureChannelOffset: Int { get set }

get · iOS 11.3+

primaryStrideInPixelsX

TypeScript

get primaryStrideInPixelsX(): number

Swift declaration

var primaryStrideInPixelsX: Int { get set }

set · iOS 11.3+

primaryStrideInPixelsX

TypeScript

set primaryStrideInPixelsX(value: number)

Swift declaration

var primaryStrideInPixelsX: Int { get set }

get · iOS 11.3+

primaryStrideInPixelsY

TypeScript

get primaryStrideInPixelsY(): number

Swift declaration

var primaryStrideInPixelsY: Int { get set }

set · iOS 11.3+

primaryStrideInPixelsY

TypeScript

set primaryStrideInPixelsY(value: number)

Swift declaration

var primaryStrideInPixelsY: Int { get set }

get · iOS 11.3+

secondaryDilationRateX

TypeScript

get secondaryDilationRateX(): number

Swift declaration

var secondaryDilationRateX: Int { get }

get · iOS 11.3+

secondaryDilationRateY

TypeScript

get secondaryDilationRateY(): number

Swift declaration

var secondaryDilationRateY: Int { get }

get · iOS 11.0+

secondaryEdgeMode

TypeScript

get secondaryEdgeMode(): MPSImageEdgeMode

Swift declaration

var secondaryEdgeMode: MPSImageEdgeMode { get set }

set · iOS 11.0+

secondaryEdgeMode

TypeScript

set secondaryEdgeMode(value: MPSImageEdgeMode)

Swift declaration

var secondaryEdgeMode: MPSImageEdgeMode { get set }

get · iOS 11.3+

secondaryKernelHeight

TypeScript

get secondaryKernelHeight(): number

Swift declaration

var secondaryKernelHeight: Int { get }

get · iOS 11.3+

secondaryKernelWidth

TypeScript

get secondaryKernelWidth(): number

Swift declaration

var secondaryKernelWidth: Int { get }

get · iOS 11.0+

secondaryOffset

TypeScript

get secondaryOffset(): MPSOffset

Swift declaration

var secondaryOffset: MPSOffset { get set }

set · iOS 11.0+

secondaryOffset

TypeScript

set secondaryOffset(value: MPSOffset)

Swift declaration

var secondaryOffset: MPSOffset { get set }

get · iOS 11.0+

secondarySourceFeatureChannelMaxCount

TypeScript

get secondarySourceFeatureChannelMaxCount(): number

Swift declaration

var secondarySourceFeatureChannelMaxCount: Int { get set }

set · iOS 11.0+

secondarySourceFeatureChannelMaxCount

TypeScript

set secondarySourceFeatureChannelMaxCount(value: number)

Swift declaration

var secondarySourceFeatureChannelMaxCount: Int { get set }

get · iOS 11.3+

secondarySourceFeatureChannelOffset

TypeScript

get secondarySourceFeatureChannelOffset(): number

Swift declaration

var secondarySourceFeatureChannelOffset: Int { get set }

set · iOS 11.3+

secondarySourceFeatureChannelOffset

TypeScript

set secondarySourceFeatureChannelOffset(value: number)

Swift declaration

var secondarySourceFeatureChannelOffset: Int { get set }

get · iOS 11.3+

secondaryStrideInPixelsX

TypeScript

get secondaryStrideInPixelsX(): number

Swift declaration

var secondaryStrideInPixelsX: Int { get set }

set · iOS 11.3+

secondaryStrideInPixelsX

TypeScript

set secondaryStrideInPixelsX(value: number)

Swift declaration

var secondaryStrideInPixelsX: Int { get set }

get · iOS 11.3+

secondaryStrideInPixelsY

TypeScript

get secondaryStrideInPixelsY(): number

Swift declaration

var secondaryStrideInPixelsY: Int { get set }

set · iOS 11.3+

secondaryStrideInPixelsY

TypeScript

set secondaryStrideInPixelsY(value: number)

Swift declaration

var secondaryStrideInPixelsY: Int { get set }

Skipped declarations

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

MPSCNNBinaryKernel.init()

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

All MetalPerformanceShaders types →