MPSImageSobel(3)       MetalPerformanceShaders.framework      MPSImageSobel(3)

NAME

       MPSImageSobel

SYNOPSIS

       #import <MPSImageConvolution.h>

       Inherits MPSUnaryImageKernel.

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

   Properties
       const float * colorTransform

   Additional Inherited Members

Detailed Description

       The MPSImageSobel implements the Sobel filter. When the color model
       (e.g. RGB, two-channel, grayscale, etc.) of source and destination
       textures match, the filter is applied to each channel separately. If
       the destination is monochrome (single channel) but source multichannel,
       the pixel values are converted to grayscale before applying Sobel
       operator using the linear gray color transform vector (v).

       Luminance = v[0] * pixel.x + v[1] * pixel.y + v[2] * pixel.z;

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
       Initialize a Sobel filter on a given device using the default color
       transform. Default: BT.601/JPEG {0.299f, 0.587f, 0.114f}

       For non-default conversion matrices, use
       -initWithDevice:linearGrayColorTransform:

       Parameters:
           device The device the filter will run on

       Returns:
           A valid object or nil, if failure.



       Reimplemented from MPSUnaryImageKernel.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >)
       device(const float *__nonnull) transform
       Initialize a Sobel filter on a given device with a non-default color
       transform

       Parameters:
           device The device the filter will run on
           transform Array of three floats describing the rgb to gray scale
           color transform.

           Luminance = transform[0] * pixel.x +
                       transform[1] * pixel.y +
                       transform[2] * pixel.z;




       Returns:
           A valid object or nil, if failure.

Property Documentation

   - colorTransform [read],  [nonatomic],  [assign]
       Returns a pointer to the array of three floats used to convert RGBA,
       RGB or RG images to the destination format when the destination is
       monochrome.

Author

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





Version MetalPerformanceShaders-Thu2Jul 13 2017               MPSImageSobel(3)


Mac OS X 10.13.1 - Generated Tue Nov  7 16:22:45 CST 2017