Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpsimageconversion(3) [mojave man page]

MPSImageConversion(3)					 MetalPerformanceShaders.framework				     MPSImageConversion(3)

NAME

       MPSImageConversion

SYNOPSIS

       #import <MPSImageConversion.h>

       Inherits MPSUnaryImageKernel.

   Instance Methods
       (nonnull instancetype) - initWithDevice:srcAlpha:destAlpha:backgroundColor:conversionInfo:

   Properties
       MPSAlphaType sourceAlpha
       MPSAlphaType destinationAlpha

   Additional Inherited Members
Detailed Description
       MPSImageConversions.h  MetalPerformanceShaders.framework

       Copyright:
	   Copyright (c) 2015 Apple Inc. All rights reserved.  MetalPerformanceShaders conversion filters  MPS_CLASS_AVAILABLE_STARTING

       The MPSImageConversion filter performs a conversion from source to destination

Method Documentation
   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(MPSAlphaType) srcAlpha(MPSAlphaType) destAlpha(nullable CGFloat *)
       backgroundColor(nullable CGColorConversionInfoRef) conversionInfo
       Create a converter that can convert texture colorspace, alpha and texture format  Create a converter that can convert texture colorspace,
       alpha and MTLPixelFormat. Optimized cases exist for NULL color space converter and no alpha conversion.

       Parameters:
	   device The device the filter will run on
	   srcAlpha The alpha encoding for the source texture
	   destAlpha The alpha encoding for the destination texture
	   backgroundColor An array of CGFloats giving the background color to use when flattening an image. The color is in the source
	   colorspace. The length of the array is the number of color channels in the src colorspace. If NULL, use {0}.
	   conversionInfo The colorspace conversion to use. May be NULL, indicating no color space conversions need to be done.

       Returns:
	   An initialized MPSImageConversion object.

Property Documentation
   - destinationAlpha [read],  [nonatomic],  [assign]
       Premultiplication description for the destinationAlpha texture  Colorspace conversion operations produce non-premultiplied data. Use this
       property to tag cases where premultiplied results are required. If MPSPixelAlpha_AlphaIsOne is used, the alpha channel will be set to 1.
       Default: MPSPixelAlpha_AlphaIsOne

   - sourceAlpha [read],  [nonatomic],	[assign]
       Premultiplication description for the source texture  Most colorspace conversion operations can not work directly on premultiplied data.
       Use this property to tag premultiplied data so that the source texture can be unpremultiplied prior to application of these transforms.
       Default: MPSPixelAlpha_AlphaIsOne

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

Version MetalPerformanceShaders-100				  Thu Feb 8 2018					     MPSImageConversion(3)

Check Out this Related Man Page

MPSImageReduceUnary(3)					 MetalPerformanceShaders.framework				    MPSImageReduceUnary(3)

NAME

       MPSImageReduceUnary

SYNOPSIS

       #import <MPSImageReduce.h>

       Inherits MPSUnaryImageKernel.

       Inherited by MPSImageReduceColumnMax, MPSImageReduceColumnMean, MPSImageReduceColumnMin, MPSImageReduceColumnSum, MPSImageReduceRowMax,
       MPSImageReduceRowMean, MPSImageReduceRowMin, and MPSImageReduceRowSum.

   Instance Methods
       (nonnull instancetype) - initWithDevice:

   Properties
       MTLRegion clipRectSource

   Additional Inherited Members
Detailed Description
       MPSImageReduce.h  MetalPerformanceShaders

       Copyright:
	   Copyright (c) 2017 Apple Inc. All rights reserved.  Reduction filters for MetalPerformanceShaders

       The MPSImageReduce performs a reduction operation The reduction operations supported are:

       o Reduce row min

       o Reduce column min

       o Reduce row max

       o Reduce column max

       o Reduce row mean

       o Reduce column mean

       o Reduce row sum

       o Reduce column sum

Method Documentation
   - (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.

       Reimplemented in MPSImageReduceRowMin, MPSImageReduceColumnMin, MPSImageReduceRowMax, MPSImageReduceColumnMax, MPSImageReduceRowMean,
       MPSImageReduceColumnMean, MPSImageReduceRowSum, and MPSImageReduceColumnSum.

Property Documentation
   - clipRectSource [read],  [write],  [nonatomic],  [assign]
       The source rectangle to use when reading data.  A MTLRegion that indicates which part of the source to read. If the clipRectSource does not
       lie completely within the source image, the intersection of the image bounds and clipRectSource will be used. The clipRectSource replaces
       the MPSUnaryImageKernel offset parameter for this filter. The latter is ignored. Default: MPSRectNoClip, use the entire source texture.

       The clipRect specified in MPSUnaryImageKernel is used to control the origin in the destination texture where the min, max values are
       written. The clipRect.width must be >=2. The clipRect.height must be >= 1.

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

Version MetalPerformanceShaders-100				  Thu Feb 8 2018					    MPSImageReduceUnary(3)
Man Page