Instance Property

primaryEdgeMode

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

Declaration

var primaryEdgeMode: MPSImageEdgeMode { get set }

Discussion

Most kernel objects can read off the edge of a source image. This can happen because of a negative offset property, because the offset + clipRect.size is larger than the source image, or because the filter uses neighboring pixels in its calculations (e.g. convolution filters).

The default value is usually MPSImageEdgeMode.zero, but some kernels default to the MPSImageEdgeMode.clamp value instead if an edge mode of zero is either unsupported or undefined.

See Also

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 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.