One Logo Pool Ball
MetalPerformanceShaders · IOS API REFERENCE

MPSBinaryImageKernel

class · iOS 9.0+ · SDK 27.1

class MPSBinaryImageKernel

Members (18)

method · iOS 9.0+

encode

TypeScript
encodeCommandBufferInPlacePrimaryTextureSecondaryTexture(commandBuffer: SDKHandle, inPlacePrimaryTexture: SDKHandle, secondaryTexture: SDKHandle): boolean
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, inPlacePrimaryTexture: UnsafeMutablePointer<any MTLTexture>, secondaryTexture: any MTLTexture, fallbackCopyAllocator copyAllocator: MPSCopyAllocator? = nil) -> Bool
method · iOS 9.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 9.0+

encode

TypeScript
encodeCommandBufferPrimaryTextureInPlaceSecondaryTexture(commandBuffer: SDKHandle, primaryTexture: SDKHandle, inPlaceSecondaryTexture: SDKHandle): boolean
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, primaryTexture: any MTLTexture, inPlaceSecondaryTexture: UnsafeMutablePointer<any MTLTexture>, fallbackCopyAllocator copyAllocator: MPSCopyAllocator? = nil) -> Bool
method · iOS 9.0+

encode

TypeScript
encodeCommandBufferPrimaryTextureSecondaryTextureDestinationTexture(commandBuffer: SDKHandle, primaryTexture: SDKHandle, secondaryTexture: SDKHandle, destinationTexture: SDKHandle): void
Swift declaration
func encode(commandBuffer: any MTLCommandBuffer, primaryTexture: any MTLTexture, secondaryTexture: any MTLTexture, destinationTexture: any MTLTexture)
init · iOS 11.0+

init

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

init

TypeScript
static initDevice(device: SDKHandle): MPSBinaryImageKernel
Swift declaration
init(device: any MTLDevice)
method · iOS 9.0+

primarySourceRegion

TypeScript
primarySourceRegion(destinationSize: _Metal_MTLSize): MPSRegion
Swift declaration
func primarySourceRegion(forDestinationSize destinationSize: MTLSize) -> MPSRegion
method · iOS 9.0+

secondarySourceRegion

TypeScript
secondarySourceRegion(destinationSize: _Metal_MTLSize): MPSRegion
Swift declaration
func secondarySourceRegion(forDestinationSize destinationSize: MTLSize) -> MPSRegion
get · iOS 9.0+

clipRect

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

clipRect

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

primaryEdgeMode

TypeScript
get primaryEdgeMode(): MPSImageEdgeMode
Swift declaration
var primaryEdgeMode: MPSImageEdgeMode { get set }
set · iOS 9.0+

primaryEdgeMode

TypeScript
set primaryEdgeMode(value: MPSImageEdgeMode)
Swift declaration
var primaryEdgeMode: MPSImageEdgeMode { get set }
get · iOS 9.0+

primaryOffset

TypeScript
get primaryOffset(): MPSOffset
Swift declaration
var primaryOffset: MPSOffset { get set }
set · iOS 9.0+

primaryOffset

TypeScript
set primaryOffset(value: MPSOffset)
Swift declaration
var primaryOffset: MPSOffset { get set }
get · iOS 9.0+

secondaryEdgeMode

TypeScript
get secondaryEdgeMode(): MPSImageEdgeMode
Swift declaration
var secondaryEdgeMode: MPSImageEdgeMode { get set }
set · iOS 9.0+

secondaryEdgeMode

TypeScript
set secondaryEdgeMode(value: MPSImageEdgeMode)
Swift declaration
var secondaryEdgeMode: MPSImageEdgeMode { get set }
get · iOS 9.0+

secondaryOffset

TypeScript
get secondaryOffset(): MPSOffset
Swift declaration
var secondaryOffset: MPSOffset { get set }
set · iOS 9.0+

secondaryOffset

TypeScript
set secondaryOffset(value: MPSOffset)
Swift declaration
var secondaryOffset: MPSOffset { get set }

Skipped declarations

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

MPSBinaryImageKernel.init()

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

All MetalPerformanceShaders types →