.TH "MPSImageReduceUnary" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MPSImageReduceUnary
.SH SYNOPSIS
.br
.PP
.PP
\fC#import <MPSImageReduce\&.h>\fP
.PP
Inherits \fBMPSUnaryImageKernel\fP\&.
.PP
Inherited by \fBMPSImageReduceColumnMax\fP, \fBMPSImageReduceColumnMean\fP, \fBMPSImageReduceColumnMin\fP, \fBMPSImageReduceColumnSum\fP, \fBMPSImageReduceRowMax\fP, \fBMPSImageReduceRowMean\fP, \fBMPSImageReduceRowMin\fP, and \fBMPSImageReduceRowSum\fP\&.
.SS "Instance Methods"

.in +1c
.ti -1c
.RI "(nonnull instancetype) \- \fBinitWithDevice:\fP"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "MTLRegion \fBclipRectSource\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
\fBMPSImageReduce\&.h\fP  MetalPerformanceShaders
.PP
\fBCopyright:\fP
.RS 4
Copyright (c) 2017 Apple Inc\&. All rights reserved\&.  Reduction filters for MetalPerformanceShaders
.RE
.PP
The MPSImageReduce performs a reduction operation The reduction operations supported are:
.IP "\(bu" 2
Reduce row min
.IP "\(bu" 2
Reduce column min
.IP "\(bu" 2
Reduce row max
.IP "\(bu" 2
Reduce column max
.IP "\(bu" 2
Reduce row mean
.IP "\(bu" 2
Reduce column mean
.IP "\(bu" 2
Reduce row sum
.IP "\(bu" 2
Reduce column sum 
.PP

.SH "Method Documentation"
.PP 
.SS "\- (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device"
Standard init with default properties per filter type 
.PP
\fBParameters:\fP
.RS 4
\fIdevice\fP The device that the filter will be used on\&. May not be NULL\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
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\&. 
.RE
.PP

.PP
Reimplemented from \fBMPSUnaryImageKernel\fP\&.
.PP
Reimplemented in \fBMPSImageReduceRowMin\fP, \fBMPSImageReduceColumnMin\fP, \fBMPSImageReduceRowMax\fP, \fBMPSImageReduceColumnMax\fP, \fBMPSImageReduceRowMean\fP, \fBMPSImageReduceColumnMean\fP, \fBMPSImageReduceRowSum\fP, and \fBMPSImageReduceColumnSum\fP\&.
.SH "Property Documentation"
.PP 
.SS "\- clipRectSource\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The source rectangle to use when reading data\&.  \fBA\fP 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 \fBMPSUnaryImageKernel\fP offset parameter for this filter\&. The latter is ignored\&. Default: MPSRectNoClip, use the entire source texture\&.
.PP
The clipRect specified in \fBMPSUnaryImageKernel\fP 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\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.