MPSImageAreaMax(3)     MetalPerformanceShaders.framework    MPSImageAreaMax(3)

NAME

       MPSImageAreaMax

SYNOPSIS

       #import <MPSImageMorphology.h>

       Inherits MPSUnaryImageKernel.

       Inherited by MPSImageAreaMin.

   Instance Methods
       (nonnull instancetype) - initWithDevice:kernelWidth:kernelHeight:
       (nullable instancetype) - initWithCoder:device:
       (nonnull instancetype) - initWithDevice:

   Properties
       NSUInteger kernelHeight
       NSUInteger kernelWidth

   Additional Inherited Members

Detailed Description

       MPSImageMorphology.h  MetalPerformanceShaders

       Copyright:
           Copyright (c) 2015 Apple Inc. All rights reserved.
           MetalPerformanceShaders morphological operators

       The MPSImageAreaMax kernel finds the maximum pixel value in a
       rectangular region centered around each pixel in the source image. If
       there are multiple channels in the source image, each channel is
       processed independently. The edgeMode property is assumed to always be
       MPSImageEdgeModeClamp for this filter.

Method Documentation

   - (nullable instancetype) initWithCoder: (NSCoder *__nonnull)
       aDecoder(nonnull id< MTLDevice >) device
       NSSecureCoding compatability  While the standard
       NSSecureCoding/NSCoding method -initWithCoder: should work, since the
       file can't know which device your data is allocated on, we have to
       guess and may guess incorrectly. To avoid that problem, use
       initWithCoder:device instead.

       Parameters:
           aDecoder The NSCoder subclass with your serialized MPSKernel
           device The MTLDevice on which to make the MPSKernel

       Returns:
           A new MPSKernel object, or nil if failure.



       Reimplemented from MPSUnaryImageKernel.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device
       Standard init with default properties per filter type

       Parameters:
           device The device that the filter will be used on. May not be NULL.

       Returns:
           a pointer to the newly initialized object. This will fail,
           returning nil if the device is not supported. Devices must be
           MTLFeatureSet_iOS_GPUFamily2_v1 or later.



       Reimplemented from MPSUnaryImageKernel.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >)
       device(NSUInteger) kernelWidth(NSUInteger) kernelHeight
       Set the kernel height and width

       Parameters:
           device The device the filter will run on
           kernelWidth The width of the kernel. Must be an odd number.
           kernelHeight The height of the kernel. Must be an odd number.

Property Documentation

   - kernelHeight [read],  [nonatomic],  [assign]
       The height of the filter window. Must be an odd number.

   - kernelWidth [read],  [nonatomic],  [assign]
       The width of the filter window. Must be an odd number.

Author

       Generated automatically by Doxygen for
       MetalPerformanceShaders.framework from the source code.





Version MetalPerformanceShaders-Thu2Jul 13 2017             MPSImageAreaMax(3)


Mac OS X 10.13.1 - Generated Mon Nov  6 19:19:29 CST 2017