Class

MPSBinaryImageKernel

A kernel that consumes two textures and produces one texture.

Declaration

class MPSBinaryImageKernel : MPSKernel

Overview

MPSBinaryImageKernel defines shared behavior for most image processing kernels (filters) such as edging modes, clipping, and tiling support for image operations that consume two source textures. It is not meant to be used directly, but provides API abstraction and in some cases may allow some level of polymorphic manipulation of image kernel objects.

Topics

Initializers

init?(coder: NSCoder, device: MTLDevice)

init(device: MTLDevice)

Methods

func encode(commandBuffer: MTLCommandBuffer, primaryTexture: MTLTexture, inPlaceSecondaryTexture: UnsafeMutablePointer<MTLTexture>, fallbackCopyAllocator: MPSCopyAllocator?) -> Bool

This method attempts to apply a kernel in place on a texture.

func encode(commandBuffer: MTLCommandBuffer, inPlacePrimaryTexture: UnsafeMutablePointer<MTLTexture>, secondaryTexture: MTLTexture, fallbackCopyAllocator: MPSCopyAllocator?) -> Bool

This method attempts to apply a kernel in place on a texture.

func encode(commandBuffer: MTLCommandBuffer, primaryTexture: MTLTexture, secondaryTexture: MTLTexture, destinationTexture: MTLTexture)

Encodes a kernel into a command buffer, out-of-place.

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

func primarySourceRegion(forDestinationSize: MTLSize) -> MPSRegion

Determines the region of the primary source texture that will be read for an encode operation.

func secondarySourceRegion(forDestinationSize: MTLSize) -> MPSRegion

Determines the region of the secondary source texture that will be read for an encode operation.

Properties

var primaryOffset: MPSOffset

The position of the destination clip rectangle origin relative to the primary source buffer.

var secondaryOffset: MPSOffset

The position of the destination clip rectangle origin relative to the secondary source buffer.

var primaryEdgeMode: MPSImageEdgeMode

The edge mode to use when texture reads stray off the edge of the primary source image.

var secondaryEdgeMode: MPSImageEdgeMode

The edge mode to use when texture reads stray off the edge of the secondary source image.

var clipRect: MTLRegion

An optional clip rectangle to use when writing data. Only the pixels in the rectangle will be overwritten.

Relationships

Inherits From

MPSKernel