mpsimage

func (Acl_entry_id_t) String ¶

func (e Acl_entry_id_t) String() string

func (Acl_flag_t) String ¶

func (e Acl_flag_t) String() string

func (Acl_perm_t) String ¶

func (e Acl_perm_t) String() string

func (Acl_tag_t) String ¶

func (e Acl_tag_t) String() string

func (Acl_type_t) String ¶

func (e Acl_type_t) String() string

func (Clockid_t) String ¶

func (e Clockid_t) String() string

func (Dispatch_autorelease_frequency_t) String ¶

func (e Dispatch_autorelease_frequency_t) String() string

func (Dispatch_block_flags_t) String ¶

func (e Dispatch_block_flags_t) String() string

func (Filesec_property_t) String ¶

func (e Filesec_property_t) String() string

func (Idtype_t) String ¶

func (e Idtype_t) String() string

func (Ipc_info_object_type_t) String ¶

func (e Ipc_info_object_type_t) String() string

func (Launch_data_type_t) String ¶

func (e Launch_data_type_t) String() string

func (MDLabelDomain) String ¶

func (e MDLabelDomain) String() string

func (MDQueryOptionFlags) String ¶

func (e MDQueryOptionFlags) String() string

func (MDQuerySortOptionFlags) String ¶

func (e MDQuerySortOptionFlags) String() string

func (MPSAlphaType) String ¶

func (e MPSAlphaType) String() string

func (*MPSBinaryImageKernel) ClipRect ¶

func (o *MPSBinaryImageKernel) ClipRect() metal.MTLRegion

@property clipRect @abstract An optional clip rectangle to use when writing data. Only the pixels in the rectangle will be overwritten. @discussion A MTLRegion that indicates which part of the destination to overwrite. If the clipRect does not lie completely within the destination image, the intersection between clip rectangle and destination bounds is used. Default: MPSRectNoClip (MPSKernel::MPSRectNoClip) indicating the entire image. See Also: @ref MetalPerformanceShaders.h subsubsection_clipRect

func (*MPSBinaryImageKernel) EncodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator ¶

func (o *MPSBinaryImageKernel) EncodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator(commandBuffer metal.MTLCommandBuffer, inPlacePrimaryTexture metal.MTLTexture, secondaryTexture metal.MTLTexture, copyAllocator func() unsafe.Pointer) bool

@abstract Attempt to apply a MPSKernel to a texture in place. @discussion This method attempts to apply the MPSKernel in place on a texture. @code In-place operation means that the same texture is used both to hold the input image and the results. Operating in-place can be an excellent way to reduce resource utilization, and save time and energy. While simple Metal kernels can not operate in place because textures can not be readable and writable at the same time, some MPSKernels can operate in place because they use multi-pass algorithms. Whether a MPSKernel can operate in-place can depend on current hardware, operating system revision and the parameters and properties passed to it. You should never assume that a MPSKernel will continue to work in place, even if you have observed it doing so before. @endcode If the operation succeeds in-place, YES is returned. If the in-place operation fails and no copyAllocator is provided, then NO is returned. In neither case is the pointer held at *texture modified. Failure during in-place operation is common. You may find it simplifies your code to provide a copyAllocator. When an in-place filter fails, your copyAllocator will be invoked to create a new texture in which to write the results, allowing the filter to proceed reliably out-of-place. The original texture will be released, replaced with a pointer to the new texture and YES will be returned. If the allocator returns an invalid texture, it is released, *texture remains unmodified and NO is returned. Please see the MPSCopyAllocator definition for a sample allocator implementation. Note: Image filters that look at neighboring pixel values may actually consume more memory when operating in place than out of place. Many such operations are tiled internally to save intermediate texture storage, but can not tile when operating in place. The memory savings for tiling is however very short term, typically the lifetime of the MTLCommandBuffer. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param inPlacePrimaryTexture A pointer to a valid MTLTexture containing secondary image. On success, the image contents and possibly texture itself will be replaced with the result image. @param secondaryTexture A pointer to a valid MTLTexture containing the primary source image. It will not be overwritten. @param copyAllocator An optional block to allocate a new texture to hold the results, in case in-place operation is not possible. The allocator may use a different MTLPixelFormat or size than the original texture. You may enqueue operations on the provided MTLCommandBuffer using the provided MTLComputeCommandEncoder to initialize the texture contents. @return On success, YES is returned. The texture may have been replaced with a new texture if a copyAllocator was provided. On failure, NO is returned. The texture is unmodified.

func (*MPSBinaryImageKernel) EncodeToCommandBufferPrimaryImageSecondaryImageDestinationImage ¶

func (o *MPSBinaryImageKernel) EncodeToCommandBufferPrimaryImageSecondaryImageDestinationImage(commandBuffer metal.MTLCommandBuffer, primaryImage *mpscore.MPSImage, secondaryImage *mpscore.MPSImage, destinationImage *mpscore.MPSImage)

@abstract Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param primaryImage A valid MPSImage containing the primary source image. @param secondaryImage A valid MPSImage containing the secondary source image. @param destinationImage A valid MPSImage to be overwritten by result image. destinationImage may not alias the source images.

func (*MPSBinaryImageKernel) EncodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator ¶

func (o *MPSBinaryImageKernel) EncodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator(commandBuffer metal.MTLCommandBuffer, primaryTexture metal.MTLTexture, inPlaceSecondaryTexture metal.MTLTexture, copyAllocator func() unsafe.Pointer) bool

This method attempts to apply the MPSKernel in place on a texture. In-place operation means that the same texture is used both to hold the input image and the results. Operating in-place can be an excellent way to reduce resource utilization, and save time and energy. While simple Metal kernels can not operate in place because textures can not be readable and writable at the same time, some MPSKernels can operate in place because they use multi-pass algorithms. Whether a MPSKernel can operate in-place can depend on current hardware, operating system revision and the parameters and properties passed to it. You should never assume that a MPSKernel will continue to work in place, even if you have observed it doing so before. If the operation succeeds in-place, YES is returned. If the in-place operation fails and no copyAllocator is provided, then NO is returned. In neither case is the pointer held at *texture modified. Failure during in-place operation is common. You may find it simplifies your code to provide a copyAllocator. When an in-place filter fails, your copyAllocator will be invoked to create a new texture in which to write the results, allowing the filter to proceed reliably out-of-place. The original texture will be released, replaced with a pointer to the new texture and YES will be returned. If the allocator returns an invalid texture, it is released, *texture remains unmodified and NO is returned. Please see the MPSCopyAllocator definition for a sample allocator implementation. Note: Image filters that look at neighboring pixel values may actually consume more memory when operating in place than out of place. Many such operations are tiled internally to save intermediate texture storage, but can not tile when operating in place. The memory savings for tiling is however very short term, typically the lifetime of the MTLCommandBuffer. @abstract Attempt to apply a MPSKernel to a texture in place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param primaryTexture A pointer to a valid MTLTexture containing the primary source image. It will not be overwritten. @param inPlaceSecondaryTexture A pointer to a valid MTLTexture containing secondary image. On success, the image contents and possibly texture itself will be replaced with the result image. @param copyAllocator An optional block to allocate a new texture to hold the results, in case in-place operation is not possible. The allocator may use a different MTLPixelFormat or size than the original texture. You may enqueue operations on the provided MTLCommandBuffer using the provided MTLComputeCommandEncoder to initialize the texture contents. @return On success, YES is returned. The texture may have been replaced with a new texture if a copyAllocator was provided. On failure, NO is returned. The texture is unmodified.

func (*MPSBinaryImageKernel) EncodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture ¶

func (o *MPSBinaryImageKernel) EncodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture(commandBuffer metal.MTLCommandBuffer, primaryTexture metal.MTLTexture, secondaryTexture metal.MTLTexture, destinationTexture metal.MTLTexture)

@abstract Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param primaryTexture A valid MTLTexture containing the primary source image. @param secondaryTexture A valid MTLTexture containing the secondary source image. @param destinationTexture A valid MTLTexture to be overwritten by result image. destinationTexture may not alias the source textures.

func (*MPSBinaryImageKernel) InitWithCoderDevice ¶

func (o *MPSBinaryImageKernel) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSBinaryImageKernel

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSBinaryImageKernel) InitWithDevice ¶

func (o *MPSBinaryImageKernel) InitWithDevice(device metal.MTLDevice) *MPSBinaryImageKernel

@abstract Standard init with default properties per filter type @param device The device that the filter will be used on. May not be NULL. @result 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.

func (*MPSBinaryImageKernel) PrimaryEdgeMode ¶

func (o *MPSBinaryImageKernel) PrimaryEdgeMode() mpscore.MPSImageEdgeMode

@property primaryEdgeMode @abstract The MPSImageEdgeMode to use when texture reads stray off the edge of the primary source image @discussion Most MPSKernel 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 looks at neighboring pixels, such as a Convolution or morphology filter. Default: usually MPSImageEdgeModeZero. (Some MPSKernel types default to MPSImageEdgeModeClamp, because MPSImageEdgeModeZero is either not supported or would produce unexpected results.) See Also: @ref MetalPerformanceShaders.h subsubsection_edgemode

func (*MPSBinaryImageKernel) PrimaryOffset ¶

func (o *MPSBinaryImageKernel) PrimaryOffset() mpscore.MPSOffset

@property primaryOffset @abstract The position of the destination clip rectangle origin relative to the primary source buffer. @discussion The offset is defined to be the position of clipRect.origin in source coordinates. Default: {0,0,0}, indicating that the top left corners of the clipRect and primary source image align. See Also: @ref MetalPerformanceShaders.h subsubsection_mpsoffset

func (*MPSBinaryImageKernel) PrimarySourceRegionForDestinationSize ¶

func (o *MPSBinaryImageKernel) PrimarySourceRegionForDestinationSize(destinationSize metal.MTLSize) mpscore.MPSRegion

primarySourceRegionForDestinationSize: is used to determine which region of the primaryTexture will be read by encodeToCommandBuffer:primaryTexture:secondaryTexture:destinationTexture (and in-place variants) when the filter runs. This information may be needed if the primary source image is broken into multiple textures. The size of the full (untiled) destination image is provided. The region of the full (untiled) source image that will be read is returned. You can then piece together an appropriate texture containing that information for use in your tiled context. The function will consult the MPSBinaryImageKernel primaryOffset and clipRect parameters, to determine the full region read by the function. Other parameters such as kernelHeight and kernelWidth will be consulted as necessary. All properties should be set to intended values prior to calling primarySourceRegionForDestinationSize:. Caution: This function operates using global image coordinates, but -encodeToCommandBuffer:... uses coordinates local to the source and destination image textures. Consequently, the primaryOffset and clipRect attached to this object will need to be updated using a global to local coordinate transform before -encodeToCommandBuffer:... is called. @abstract Determine the region of the source texture that will be read for a encode operation @param destinationSize The size of the full virtual destination image. @return The area in the virtual source image that will be read.

func (*MPSBinaryImageKernel) SecondaryEdgeMode ¶

func (o *MPSBinaryImageKernel) SecondaryEdgeMode() mpscore.MPSImageEdgeMode

@property secondaryEdgeMode @abstract The MPSImageEdgeMode to use when texture reads stray off the edge of the secondary source image @discussion Most MPSKernel 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 looks at neighboring pixels, such as a Convolution or morphology filter. Default: usually MPSImageEdgeModeZero. (Some MPSKernel types default to MPSImageEdgeModeClamp, because MPSImageEdgeModeZero is either not supported or would produce unexpected results.) See Also: @ref MetalPerformanceShaders.h subsubsection_edgemode

func (*MPSBinaryImageKernel) SecondaryOffset ¶

func (o *MPSBinaryImageKernel) SecondaryOffset() mpscore.MPSOffset

@property secondaryOffset @abstract The position of the destination clip rectangle origin relative to the secondary source buffer. @discussion The offset is defined to be the position of clipRect.origin in source coordinates. Default: {0,0,0}, indicating that the top left corners of the clipRect and secondary source image align. See Also: @ref MetalPerformanceShaders.h subsubsection_mpsoffset

func (*MPSBinaryImageKernel) SecondarySourceRegionForDestinationSize ¶

func (o *MPSBinaryImageKernel) SecondarySourceRegionForDestinationSize(destinationSize metal.MTLSize) mpscore.MPSRegion

secondarySourceRegionForDestinationSize: is used to determine which region of the sourceTexture will be read by encodeToCommandBuffer:primaryTexture:secondaryTexture:destinationTexture (and in-place variants) when the filter runs. This information may be needed if the secondary source image is broken into multiple textures. The size of the full (untiled) destination image is provided. The region of the full (untiled) secondary source image that will be read is returned. You can then piece together an appropriate texture containing that information for use in your tiled context. The function will consult the MPSBinaryImageKernel secondaryOffset and clipRect parameters, to determine the full region read by the function. Other parameters such as kernelHeight and kernelWidth will be consulted as necessary. All properties should be set to intended values prior to calling secondarySourceRegionForDestinationSize:. Caution: This function operates using global image coordinates, but -encodeToCommandBuffer:... uses coordinates local to the source and destination image textures. Consequently, the secondaryOffset and clipRect attached to this object will need to be updated using a global to local coordinate transform before -encodeToCommandBuffer:... is called. @abstract Determine the region of the source texture that will be read for a encode operation @param destinationSize The size of the full virtual destination image. @return The area in the virtual source image that will be read.

func (*MPSBinaryImageKernel) SetClipRect ¶

func (o *MPSBinaryImageKernel) SetClipRect(clipRect metal.MTLRegion)

func (*MPSBinaryImageKernel) SetPrimaryEdgeMode ¶

func (o *MPSBinaryImageKernel) SetPrimaryEdgeMode(primaryEdgeMode mpscore.MPSImageEdgeMode)

func (*MPSBinaryImageKernel) SetPrimaryOffset ¶

func (o *MPSBinaryImageKernel) SetPrimaryOffset(primaryOffset mpscore.MPSOffset)

func (*MPSBinaryImageKernel) SetSecondaryEdgeMode ¶

func (o *MPSBinaryImageKernel) SetSecondaryEdgeMode(secondaryEdgeMode mpscore.MPSImageEdgeMode)

func (*MPSBinaryImageKernel) SetSecondaryOffset ¶

func (o *MPSBinaryImageKernel) SetSecondaryOffset(secondaryOffset mpscore.MPSOffset)

func (MPSCustomKernelIndex) String ¶

func (e MPSCustomKernelIndex) String() string

func (MPSDeviceCapsValues) String ¶

func (e MPSDeviceCapsValues) String() string

func (*MPSImageAdd) InitWithDevice ¶

func (o *MPSImageAdd) InitWithDevice(device metal.MTLDevice) *MPSImageAdd

@abstract Initialize the addition operator @param device The device the filter will run on. @return A valid MPSImageAdd object or nil, if failure.

func (*MPSImageAreaMax) InitWithCoderDevice ¶

func (o *MPSImageAreaMax) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageAreaMax

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageAreaMax) InitWithDeviceKernelWidthKernelHeight ¶

func (o *MPSImageAreaMax) InitWithDeviceKernelWidthKernelHeight(device metal.MTLDevice, kernelWidth uint, kernelHeight uint) *MPSImageAreaMax

@abstract Set the kernel height and width @param device The device the filter will run on @param kernelWidth The width of the kernel. Must be an odd number. @param kernelHeight The height of the kernel. Must be an odd number.

func (*MPSImageAreaMax) KernelHeight ¶

func (o *MPSImageAreaMax) KernelHeight() uint

@property kernelHeight @abstract The height of the filter window. Must be an odd number.

func (*MPSImageAreaMax) KernelWidth ¶

func (o *MPSImageAreaMax) KernelWidth() uint

@property kernelWidth @abstract The width of the filter window. Must be an odd number.

func (*MPSImageArithmetic) Bias ¶

func (o *MPSImageArithmetic) Bias() float32

func (*MPSImageArithmetic) MaximumValue ¶

func (o *MPSImageArithmetic) MaximumValue() float32

@property maximumValue @abstract maximumValue is used to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of maximumValue is FLT_MAX.

func (*MPSImageArithmetic) MinimumValue ¶

func (o *MPSImageArithmetic) MinimumValue() float32

@property minimumValue @abstract minimumValue is to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of minimumValue is -FLT_MAX.

func (*MPSImageArithmetic) PrimaryScale ¶

func (o *MPSImageArithmetic) PrimaryScale() float32

func (*MPSImageArithmetic) PrimaryStrideInPixels ¶

func (o *MPSImageArithmetic) PrimaryStrideInPixels() metal.MTLSize

@property primaryStrideInPixels @abstract The secondarySource stride in the x, y, and z dimensions. The only supported values are 0 or 1. The default value for each dimension is 1.

func (*MPSImageArithmetic) SecondaryScale ¶

func (o *MPSImageArithmetic) SecondaryScale() float32

func (*MPSImageArithmetic) SecondaryStrideInPixels ¶

func (o *MPSImageArithmetic) SecondaryStrideInPixels() metal.MTLSize

@property secondaryStrideInPixels @abstract The secondarySource stride in the x, y, and z dimensions. The only supported values are 0 or 1. The default value for each dimension is 1.

func (*MPSImageArithmetic) SetBias ¶

func (o *MPSImageArithmetic) SetBias(bias float32)

func (*MPSImageArithmetic) SetMaximumValue ¶

func (o *MPSImageArithmetic) SetMaximumValue(maximumValue float32)

func (*MPSImageArithmetic) SetMinimumValue ¶

func (o *MPSImageArithmetic) SetMinimumValue(minimumValue float32)

func (*MPSImageArithmetic) SetPrimaryScale ¶

func (o *MPSImageArithmetic) SetPrimaryScale(primaryScale float32)

func (*MPSImageArithmetic) SetPrimaryStrideInPixels ¶

func (o *MPSImageArithmetic) SetPrimaryStrideInPixels(primaryStrideInPixels metal.MTLSize)

func (*MPSImageArithmetic) SetSecondaryScale ¶

func (o *MPSImageArithmetic) SetSecondaryScale(secondaryScale float32)

func (*MPSImageArithmetic) SetSecondaryStrideInPixels ¶

func (o *MPSImageArithmetic) SetSecondaryStrideInPixels(secondaryStrideInPixels metal.MTLSize)

func (*MPSImageBilinearScale) InitWithCoderDevice ¶

func (o *MPSImageBilinearScale) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageBilinearScale

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageBilinearScale) InitWithDevice ¶

func (o *MPSImageBilinearScale) InitWithDevice(device metal.MTLDevice) *MPSImageBilinearScale

func (*MPSImageBox) InitWithCoderDevice ¶

func (o *MPSImageBox) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageBox

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageBox) InitWithDeviceKernelWidthKernelHeight ¶

func (o *MPSImageBox) InitWithDeviceKernelWidthKernelHeight(device metal.MTLDevice, kernelWidth uint, kernelHeight uint) *MPSImageBox

func (*MPSImageBox) KernelHeight ¶

func (o *MPSImageBox) KernelHeight() uint

@property kernelHeight @abstract The height of the filter window.

func (*MPSImageBox) KernelWidth ¶

func (o *MPSImageBox) KernelWidth() uint

@property kernelWidth @abstract The width of the filter window.

func (*MPSImageCanny) ColorTransform ¶

func (o *MPSImageCanny) ColorTransform() *float32

@property colorTransform @discussion 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. Value is readonly and user should not modify or free.

func (*MPSImageCanny) HighThreshold ¶

func (o *MPSImageCanny) HighThreshold() float32

@property highThreshold @abstract Read-write value used to set the high threshold for double thresholding, value is normalized. Default is 0.4

func (*MPSImageCanny) InitWithCoderDevice ¶

func (o *MPSImageCanny) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageCanny

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageCanny) InitWithDevice ¶

func (o *MPSImageCanny) InitWithDevice(device metal.MTLDevice) *MPSImageCanny

@abstract Initialize a Canny filter on a given device using the default color transform and default sigma value for Gaussian blur. Default transform: BT.601/JPEG {0.299f, 0.587f, 0.114f} Default sigma: sqrt(2) For non-default parameters, use -initWithDevice:linearGrayColorTransform:sigma: @param device The device the filter will run on @return A valid object or nil, if failure.

func (*MPSImageCanny) InitWithDeviceLinearToGrayScaleTransformSigma ¶

func (o *MPSImageCanny) InitWithDeviceLinearToGrayScaleTransformSigma(device metal.MTLDevice, transform *float32, sigma unsafe.Pointer) *MPSImageCanny

@abstract Initialize a Canny filter on a given device with a non-default color transform and non-default sigma. @param device The device the filter will run on @param transform Array of three floats describing the rgb to gray scale color transform. @code Luminance = transform[0] * pixel.x + transform[1] * pixel.y + transform[2] * pixel.z; @endcode @param sigma The standard deviation of gaussian blur filter. Gaussian weight, centered at 0, at integer grid n is given as @code w(i) = 1/sqrt(2*pi*sigma) * exp(-n^2/2*sigma^2) @endcode If we take cut off at 1% of w(0) (max weight) beyond which weights are considered 0, we have @code ceil (sqrt(-log(0.01)*2)*sigma) ~ ceil(3.7*sigma) @endcode as rough estimate of filter width @return A valid object or nil, if failure.

func (*MPSImageCanny) LowThreshold ¶

func (o *MPSImageCanny) LowThreshold() float32

@property lowThreshold @abstract Read-write value used to set the low threshold for double thresholding, value is normalized. Default is 0.2

func (*MPSImageCanny) SetHighThreshold ¶

func (o *MPSImageCanny) SetHighThreshold(highThreshold float32)

func (*MPSImageCanny) SetLowThreshold ¶

func (o *MPSImageCanny) SetLowThreshold(lowThreshold float32)

func (*MPSImageCanny) SetUseFastMode ¶

func (o *MPSImageCanny) SetUseFastMode(useFastMode bool)

func (*MPSImageCanny) Sigma ¶

func (o *MPSImageCanny) Sigma() float32

@property sigma @abstract Read-only sigma value used in performing Gaussian blur of the image

func (*MPSImageCanny) UseFastMode ¶

func (o *MPSImageCanny) UseFastMode() bool

@property useFastMode @abstract Read-write value used to change algorithm to an approximation of the true Canny Edge detection Algorithm. When true, a limit is placed on how far a single strong edge can extend. The result will be similar to a true output but some edges may terminate early, resulting in minor differences for cases with long, weak edges. The performance for the approximate canny implementation is improved and should provide similar enough results for most cases. Extra tuning of the high and low thresholds as well as sigma may help achieve a more similar output in this mode. Default is YES

func (*MPSImageConversion) DestinationAlpha ¶

func (o *MPSImageConversion) DestinationAlpha() MPSAlphaType

@property destinationAlpha @abstract Premultiplication description for the destinationAlpha texture @discussion 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

func (*MPSImageConversion) InitWithDeviceSrcAlphaDestAlphaBackgroundColorConversionInfo ¶

func (o *MPSImageConversion) InitWithDeviceSrcAlphaDestAlphaBackgroundColorConversionInfo(device metal.MTLDevice, srcAlpha MPSAlphaType, destAlpha MPSAlphaType, backgroundColor *float64, conversionInfo unsafe.Pointer) *MPSImageConversion

@abstract Create a converter that can convert texture colorspace, alpha and texture format @discussion Create a converter that can convert texture colorspace, alpha and MTLPixelFormat. Optimized cases exist for NULL color space converter and no alpha conversion. @param device The device the filter will run on @param srcAlpha The alpha encoding for the source texture @param destAlpha The alpha encoding for the destination texture @param 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}. @param conversionInfo The colorspace conversion to use. May be NULL, indicating no color space conversions need to be done. @result An initialized MPSImageConversion object.

func (*MPSImageConversion) SourceAlpha ¶

func (o *MPSImageConversion) SourceAlpha() MPSAlphaType

@property sourceAlpha @abstract Premultiplication description for the source texture @discussion 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

func (*MPSImageConvolution) Bias ¶

func (o *MPSImageConvolution) Bias() float32

@property bias @discussion The bias is a value to be added to convolved pixel before it is converted back to the storage format. It can be used to convert negative values into a representable range for a unsigned MTLPixelFormat. For example, many edge detection filters produce results in the range [-k,k]. By scaling the filter weights by 0.5/k and adding 0.5, the results will be in range [0,1] suitable for use with unorm formats. It can be used in combination with renormalization of the filter weights to do video ranging as part of the convolution effect. It can also just be used to increase the brightness of the image. Default value is 0.0f.

func (*MPSImageConvolution) InitWithCoderDevice ¶

func (o *MPSImageConvolution) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageConvolution

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageConvolution) InitWithDeviceKernelWidthKernelHeightWeights ¶

func (o *MPSImageConvolution) InitWithDeviceKernelWidthKernelHeightWeights(device metal.MTLDevice, kernelWidth uint, kernelHeight uint, kernelWeights *float32) *MPSImageConvolution

func (*MPSImageConvolution) KernelHeight ¶

func (o *MPSImageConvolution) KernelHeight() uint

@property kernelHeight @abstract The height of the filter window. Must be an odd number.

func (*MPSImageConvolution) KernelWidth ¶

func (o *MPSImageConvolution) KernelWidth() uint

@property kernelWidth @abstract The width of the filter window. Must be an odd number.

func (*MPSImageConvolution) SetBias ¶

func (o *MPSImageConvolution) SetBias(bias float32)

func (*MPSImageCopyToMatrix) DataLayout ¶

func (o *MPSImageCopyToMatrix) DataLayout() mpscore.MPSDataLayout

@property dataLayout @abstract The data layout to use @discussion Returns the data layout. When copying from a MPSImage to a MPSMatrix, this describes the order in which the image values are stored in the buffer associated with the MPSMatrix. Default: MPSDataLayoutFeatureChannelsxHeightxWidth

func (*MPSImageCopyToMatrix) DestinationMatrixBatchIndex ¶

func (o *MPSImageCopyToMatrix) DestinationMatrixBatchIndex() uint

@property destinationMatrixBatchIndex @discussion The index of the destination matrix in the batch. This property is modifiable and defaults to 0 at initialization time.

func (*MPSImageCopyToMatrix) DestinationMatrixOrigin ¶

func (o *MPSImageCopyToMatrix) DestinationMatrixOrigin() metal.MTLOrigin

@property destinationMatrixOrigin @discussion The origin, relative to [0, 0] in the destination matrix, at which to start writing results. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel. The z value must be 0.

func (*MPSImageCopyToMatrix) EncodeBatchToCommandBufferSourceImagesDestinationMatrix ¶

func (o *MPSImageCopyToMatrix) EncodeBatchToCommandBufferSourceImagesDestinationMatrix(commandBuffer metal.MTLCommandBuffer, sourceImages unsafe.Pointer, destinationMatrix *mpscore.MPSMatrix)

@abstract Encode a kernel that copies a MPSImageBatch to a MPSMatrix into a command buffer using a MTLComputeCommandEncoder. @discussion The kernel copies feature channels from sourceImage to the buffer associated with destinationMatrix. The kernel will not begin to execute until after the command buffer has been enqueued and committed. Each image will be copied to its own row in the matrix, starting with row destinationMatrixOrigin.x. NOTE: The destinationMatrix.dataType must match the feature channel data type in sourceImage. NOTE: All the images in the source batch should be of the same size and have numberOfImages = 1. @param commandBuffer A valid MTLCommandBuffer. @param sourceImages A valid MPSImageBatch describing the images to copy from. @param destinationMatrix A valid MPSMatrix or MPSTemporaryMatrix object describing the matrix to copy to.

func (*MPSImageCopyToMatrix) EncodeToCommandBufferSourceImageDestinationMatrix ¶

func (o *MPSImageCopyToMatrix) EncodeToCommandBufferSourceImageDestinationMatrix(commandBuffer metal.MTLCommandBuffer, sourceImage *mpscore.MPSImage, destinationMatrix *mpscore.MPSMatrix)

@abstract Encode a kernel that copies a MPSImage to a MPSMatrix into a command buffer using a MTLComputeCommandEncoder. @discussion The kernel copies feature channels from sourceImage to the buffer associated with destinationMatrix. The kernel will not begin to execute until after the command buffer has been enqueued and committed. NOTE: The destinationMatrix.dataType must match the feature channel data type in sourceImage. @param commandBuffer A valid MTLCommandBuffer. @param sourceImage A valid MPSImage describing the image to copy from. @param destinationMatrix A valid MPSMatrix or MPSTemporaryMatrix object describing the matrix to copy to.

func (*MPSImageCopyToMatrix) InitWithCoderDevice ¶

func (o *MPSImageCopyToMatrix) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageCopyToMatrix

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageCopyToMatrix) InitWithDeviceDataLayout ¶

func (o *MPSImageCopyToMatrix) InitWithDeviceDataLayout(device metal.MTLDevice, dataLayout mpscore.MPSDataLayout) *MPSImageCopyToMatrix

@abstract Initialize a MPSMatrixCopy object on a device @param device The device the kernel will run on @param dataLayout The data layout @return A valid MPSMatrixCopy object or nil, if failure.

func (*MPSImageCopyToMatrix) SetDestinationMatrixBatchIndex ¶

func (o *MPSImageCopyToMatrix) SetDestinationMatrixBatchIndex(destinationMatrixBatchIndex uint)

func (*MPSImageCopyToMatrix) SetDestinationMatrixOrigin ¶

func (o *MPSImageCopyToMatrix) SetDestinationMatrixOrigin(destinationMatrixOrigin metal.MTLOrigin)

func (*MPSImageDilate) InitWithCoderDevice ¶

func (o *MPSImageDilate) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageDilate

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageDilate) InitWithDeviceKernelWidthKernelHeightValues ¶

func (o *MPSImageDilate) InitWithDeviceKernelWidthKernelHeightValues(device metal.MTLDevice, kernelWidth uint, kernelHeight uint, values *float32) *MPSImageDilate

@abstract Init a object with kernel height, width and weight values. @discussion Each dilate shape probe defines a 3D surface of values. These are arranged in order left to right, then top to bottom in a 1D array. (values[kernelWidth*y+x] = probe[y][x]) Values should be generally be in the range [0,1] with the center pixel tending towards 0 and edges towards 1. However, any numerical value is allowed. Calculations are subject to the usual floating-point rounding error. @param device The device the filter will run on @param kernelWidth The width of the kernel. Must be an odd number. @param kernelHeight The height of the kernel. Must be an odd number. @param values The set of values to use as the dilate probe. The values are copied into the filter. To avoid image ligthening or darkening, the center value should be 0.0f.

func (*MPSImageDilate) KernelHeight ¶

func (o *MPSImageDilate) KernelHeight() uint

@property kernelHeight @abstract The height of the filter window. Must be an odd number.

func (*MPSImageDilate) KernelWidth ¶

func (o *MPSImageDilate) KernelWidth() uint

@property kernelWidth @abstract The width of the filter window. Must be an odd number.

func (*MPSImageDivide) InitWithDevice ¶

func (o *MPSImageDivide) InitWithDevice(device metal.MTLDevice) *MPSImageDivide

@abstract Initialize the division operator @param device The device the filter will run on. @return A valid MPSImageDivide object or nil, if failure.

func (*MPSImageEDLines) ClipRectSource ¶

func (o *MPSImageEDLines) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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.

func (*MPSImageEDLines) DetailRatio ¶

func (o *MPSImageEDLines) DetailRatio() uint16

@property detailRatio @abstract Read-write value used to set the detailRatio to use in the EDLines algorithm Default is 32

func (*MPSImageEDLines) EncodeToCommandBufferSourceTextureDestinationTextureEndpointBufferEndpointOffset ¶

func (o *MPSImageEDLines) EncodeToCommandBufferSourceTextureDestinationTextureEndpointBufferEndpointOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, dest metal.MTLTexture, endpointBuffer metal.MTLBuffer, endpointOffset uint)

@abstract Encode the filter to a command buffer using a MTLComputeCommandEncoder. @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter @param dest A valid MTLTexture containing the destination image for the filter. If not nil, the output will be the edges found through the Edge Drawing algorithm. @param endpointBuffer A valid MTLBuffer to receive the line segment count and endpoint results. @param endpointOffset Byte offset into endpoint buffer at which to write the line segment endpoint results. Must be a multiple of 32 bytes. The total line segment count and the line segment endpoints are written to the endpoint buffer. The count is written as a uint32_t at the start of the buffer. The line segments are written to the endpoint buffer as start and end pixel coordinates of the segment. Coordinates are stored as unsigned short pairs, and a single line segment will consist of two pairs, or four total unsigned shorts. The endpoint buffer size must be >= 4 * maxLines * sizeof(unsigned short) + sizeof(uint32_t).

func (*MPSImageEDLines) GaussianSigma ¶

func (o *MPSImageEDLines) GaussianSigma() float32

@property sigma @abstract Read-only sigma value used in performing Gaussian blur of the image. Default is 2.0

func (*MPSImageEDLines) GradientThreshold ¶

func (o *MPSImageEDLines) GradientThreshold() float32

@property gradientThreshold @abstract Read-write value used to set the threshold for a pixel to be considered an edge Default is 0.2

func (*MPSImageEDLines) InitWithCoderDevice ¶

func (o *MPSImageEDLines) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageEDLines

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageEDLines) InitWithDeviceGaussianSigmaMinLineLengthMaxLinesDetailRatioGradientThresholdLineErrorThresholdMergeLocalityThreshold ¶

func (o *MPSImageEDLines) InitWithDeviceGaussianSigmaMinLineLengthMaxLinesDetailRatioGradientThresholdLineErrorThresholdMergeLocalityThreshold(device metal.MTLDevice, gaussianSigma unsafe.Pointer, minLineLength unsafe.Pointer, maxLines uint, detailRatio unsafe.Pointer, gradientThreshold unsafe.Pointer, lineErrorThreshold unsafe.Pointer, mergeLocalityThreshold unsafe.Pointer) *MPSImageEDLines

@abstract Initialize an EDLines kernel on a given device with specified parameters. @param device The device the filter will run on @param gaussianSigma The standard deviation of gaussian blur filter. Gaussian weight, centered at 0, at integer grid i is given as @code w(i) = 1/sqrt(2*pi*sigma) * exp(-i^2/(2*sigma^2)) @endcode If we take cut off at 1% of w(0) (max weight) beyond which weights are considered 0, we have @code ceil (sqrt(-log(0.01)*2)*sigma) ~ ceil(3.7*sigma) @endcode as rough estimate of filter width @param minLineLength The minimum length of output line segments. @param maxLines The maximum amount of lines for the EDLines algorithm to output. The size of the endpointBuffer supplied at encode must be >= maxLines * 4 * sizeof(unsigned short) + sizeof(uint32_t). @param detailRatio The detailRatio to use in the EDLines algorithm, which inversely effects the number of anchor points @param gradientThreshold Any pixel with a gradient below the gradientThreshold will not be considerd an edge @param lineErrorThreshold The limit of how much error a line segment can have relative to the edge it represents @param mergeLocalityThreshold Determines how many pixels apart two lines can deviate spatially and still be merged. This value is normalized to the diagonal length of the image. @return A valid object or nil, if failure.

func (*MPSImageEDLines) LineErrorThreshold ¶

func (o *MPSImageEDLines) LineErrorThreshold() float32

@property lineErrorThreshold @abstract Read-write value used to set the limit on error for a line segment relative to the edge it fits Default is 0.05

func (*MPSImageEDLines) MaxLines ¶

func (o *MPSImageEDLines) MaxLines() uint

@property maxLines @abstract Read-write value used to set the max number of line segments to be written out. The endpointBuffer at encode must be >= maxLines * 4 * sizeof(unsigned short) + sizeof(uint32_t). Default is 256

func (*MPSImageEDLines) MergeLocalityThreshold ¶

func (o *MPSImageEDLines) MergeLocalityThreshold() float32

@property mergeLocalityThreshold @abstract Read-write value used to set how many pixels apart two lines can deviate spatially and still be merged. Default is 0.0025

func (*MPSImageEDLines) MinLineLength ¶

func (o *MPSImageEDLines) MinLineLength() uint16

@property minLineLength @abstract Read-write value used to set the minimum length of a line segment. Default is 32

func (*MPSImageEDLines) SetClipRectSource ¶

func (o *MPSImageEDLines) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageEDLines) SetDetailRatio ¶

func (o *MPSImageEDLines) SetDetailRatio(detailRatio uint16)

func (*MPSImageEDLines) SetGradientThreshold ¶

func (o *MPSImageEDLines) SetGradientThreshold(gradientThreshold float32)

func (*MPSImageEDLines) SetLineErrorThreshold ¶

func (o *MPSImageEDLines) SetLineErrorThreshold(lineErrorThreshold float32)

func (*MPSImageEDLines) SetMaxLines ¶

func (o *MPSImageEDLines) SetMaxLines(maxLines uint)

func (*MPSImageEDLines) SetMergeLocalityThreshold ¶

func (o *MPSImageEDLines) SetMergeLocalityThreshold(mergeLocalityThreshold float32)

func (*MPSImageEDLines) SetMinLineLength ¶

func (o *MPSImageEDLines) SetMinLineLength(minLineLength uint16)

func (*MPSImageEuclideanDistanceTransform) InitWithCoderDevice ¶

func (o *MPSImageEuclideanDistanceTransform) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageEuclideanDistanceTransform

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageEuclideanDistanceTransform) InitWithDevice ¶

func (o *MPSImageEuclideanDistanceTransform) InitWithDevice(device metal.MTLDevice) *MPSImageEuclideanDistanceTransform

func (*MPSImageEuclideanDistanceTransform) SearchLimitRadius ¶

func (o *MPSImageEuclideanDistanceTransform) SearchLimitRadius() float32

@property searchLimitRadius @abstract Defines a search scope size around output pixel to limit closest non-zero pixel search. Optional variable. @discussion When the non-zeroes in the input image are on average very far away from each other (ie. the distances are large), the distance calculation algorithm has to work harder to find the closest pixel. If you don't care about getting exact results beyond a certain distance you can use this property to limit the search space and speed up the kernels. In case there are no non-zero pixels within this search scope around the output pixel, then the output value will be some number that is larger than this search limit. Normally you should be fine with the default value of FLT_MAX, which results in the exact EDT, so use this only if you need additional performance. Typical good values are: 32, 64, 96, 128. Default: FLT_MAX

func (*MPSImageEuclideanDistanceTransform) SetSearchLimitRadius ¶

func (o *MPSImageEuclideanDistanceTransform) SetSearchLimitRadius(searchLimitRadius float32)

func (*MPSImageFindKeypoints) EncodeToCommandBufferSourceTextureRegionsNumberOfRegionsKeypointCountBufferKeypointCountBufferOffsetKeypointDataBufferKeypointDataBufferOffset ¶

func (o *MPSImageFindKeypoints) EncodeToCommandBufferSourceTextureRegionsNumberOfRegionsKeypointCountBufferKeypointCountBufferOffsetKeypointDataBufferKeypointDataBufferOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, regions *metal.MTLRegion, numberOfRegions uint, keypointCountBuffer metal.MTLBuffer, keypointCountBufferOffset uint, keypointDataBuffer metal.MTLBuffer, keypointDataBufferOffset uint)

@abstract Encode the filter to a command buffer using a MTLComputeCommandEncoder. @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter. @param regions An array of rectangles that describe regions in the image. The list of keypoints is generated for each individual rectangle specifed. @param keypointCountBuffer The list of keypoints for each specified region @param keypointCountBufferOffset Byte offset into keypointCountBufferOffset buffer at which to write the keypoint results. Must be a multiple of 32 bytes. @param keypointDataBuffer A valid MTLBuffer to receive the keypoint data results for each rectangle. The keypoint data for keypoints in each rectangle are stored consecutively. The keypoint data for each rectangle starts at the following offset: MPSImageKeypointRangeInfo.maximumKeyPoints * rectangle index @param keypointDataBufferOffset Byte offset into keypointData buffer at which to write the keypoint results. Must be a multiple of 32 bytes.

func (*MPSImageFindKeypoints) InitWithCoderDevice ¶

func (o *MPSImageFindKeypoints) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageFindKeypoints

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageFindKeypoints) InitWithDeviceInfo ¶

func (o *MPSImageFindKeypoints) InitWithDeviceInfo(device metal.MTLDevice, info *MPSImageKeypointRangeInfo) *MPSImageFindKeypoints

func (*MPSImageFindKeypoints) KeypointRangeInfo ¶

func (o *MPSImageFindKeypoints) KeypointRangeInfo() MPSImageKeypointRangeInfo

@property keypointRangeInfo @abstract Return a structure describing the keypoint range info @discussion Returns a MPSImageKeypointRangeInfo structure

func (*MPSImageGaussianBlur) InitWithCoderDevice ¶

func (o *MPSImageGaussianBlur) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageGaussianBlur

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageGaussianBlur) InitWithDeviceSigma ¶

func (o *MPSImageGaussianBlur) InitWithDeviceSigma(device metal.MTLDevice, sigma float32) *MPSImageGaussianBlur

func (*MPSImageGaussianBlur) Sigma ¶

func (o *MPSImageGaussianBlur) Sigma() float32

@property sigma @abstract Read-only sigma value with which filter was created

func (*MPSImageGuidedFilter) EncodeReconstructionToCommandBufferGuidanceTextureCoefficientsTextureACoefficientsTextureBDestinationTexture ¶

func (o *MPSImageGuidedFilter) EncodeReconstructionToCommandBufferGuidanceTextureCoefficientsTextureACoefficientsTextureBDestinationTexture(commandBuffer metal.MTLCommandBuffer, guidanceTexture metal.MTLTexture, coefficientsTextureA metal.MTLTexture, coefficientsTextureB metal.MTLTexture, destinationTexture metal.MTLTexture)

@abstract Perform Guided Filter Reconstruction (inference) to produce the filtered output @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param guidanceTexture Input guidance pixel buffer. @param coefficientsTextureA Input coefficients A texture generated generated by a previous encodeRegressionToCommandBuffer. @param coefficientsTextureB Input coefficients B texture generated generated by a previous encodeRegressionToCommandBuffer. @param destinationTexture Output texture

func (*MPSImageGuidedFilter) EncodeReconstructionToCommandBufferGuidanceTextureCoefficientsTextureDestinationTexture ¶

func (o *MPSImageGuidedFilter) EncodeReconstructionToCommandBufferGuidanceTextureCoefficientsTextureDestinationTexture(commandBuffer metal.MTLCommandBuffer, guidanceTexture metal.MTLTexture, coefficientsTexture metal.MTLTexture, destinationTexture metal.MTLTexture)

@abstract Perform Guided Filter Reconstruction (inference) to produce the filtered output @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @pparam sourceGuidanceTexture Input guidance pixel buffer. This should be a color (RGB) image. @pparam coefficientsTexture Input coefficients texture generated generated by a previous encodeRegressionToCommandBuffer @param destinationTexture Output texture Note: The coefficients are upsampled at the reconstruction of the filtered data. Reconstruct(guidance RGB) = a.r * R + a.g * G + a.b * B + b, where a and b are the coefficients learnt using encodeRegressionToCommandBuffer. Final reconstructed value = value * reconstructScale + reconstructOffset

func (*MPSImageGuidedFilter) EncodeRegressionToCommandBufferSourceTextureGuidanceTextureWeightsTextureDestinationCoefficientsTexture ¶

func (o *MPSImageGuidedFilter) EncodeRegressionToCommandBufferSourceTextureGuidanceTextureWeightsTextureDestinationCoefficientsTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, guidanceTexture metal.MTLTexture, weightsTexture metal.MTLTexture, destinationCoefficientsTexture metal.MTLTexture)

@abstract Perform Guided Filter Regression (correlation) to produce a coefficients texture @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param sourceTexture Input source texture to be filtered (typically a mask). This should be a single channel image. @param guidanceTexture Input guidance texture. This should be a color (RGB) image. @param weightsTexture Optional input confidence texture. This should also a single channel image. @param destinationCoefficientsTexture Output texture with four coefficients that minimize the mean squared error between the source and an affine function of guidance R, G, B. Note: The destinationCoefficientsTexture computes the linear cofficients "a" and "b". The "a" coefficient is stored in the RGB channels of destinationCoefficientsTexture and the "b" coefficient in the alpha chnanel. Set the MPSKernelOptionsAllowReducedPrecision in the "options" property for this kernel to peform the computations using half-precision arithmetic. This can potentially improve performance and/or power usage.

func (*MPSImageGuidedFilter) EncodeRegressionToCommandBufferSourceTextureGuidanceTextureWeightsTextureDestinationCoefficientsTextureADestinationCoefficientsTextureB ¶

func (o *MPSImageGuidedFilter) EncodeRegressionToCommandBufferSourceTextureGuidanceTextureWeightsTextureDestinationCoefficientsTextureADestinationCoefficientsTextureB(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, guidanceTexture metal.MTLTexture, weightsTexture metal.MTLTexture, destinationCoefficientsTextureA metal.MTLTexture, destinationCoefficientsTextureB metal.MTLTexture)

@abstract Perform per-channel (non-color correlated) Guided Filter Regression (correlation) to produce a coefficients texture @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. This encode call differs from the one above in that the correlations are not computed across channels and therefore this filter computes two coefficient textures: ai and bi. @param commandBuffer A valid MTLCommandBuffer. @param sourceTexture Input source texture to be filtered. @param guidanceTexture Input guidance texture. This should be a color (RGB) image. @param weightsTexture Optional input confidence texture. This should be a single channel image. @param destinationCoefficientsTextureA Output texture with four coefficients A that minimize the mean squared error between the source channels and an affine function of guidance channels. @param destinationCoefficientsTextureB Output texture with four coefficients B that minimize the mean squared error between the source channels and an affine function of guidance channels. Set the MPSKernelOptionsAllowReducedPrecision in the "options" property for this kernel to peform the computations using half-precision arithmetic. This can potentially improve performance and/or power usage.

func (*MPSImageGuidedFilter) Epsilon ¶

func (o *MPSImageGuidedFilter) Epsilon() float32

@property epsilon @abstract The regularization parameter @discussion The parameter used when computing the linear coefficients a and b.

func (*MPSImageGuidedFilter) InitWithCoderDevice ¶

func (o *MPSImageGuidedFilter) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageGuidedFilter

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageGuidedFilter) InitWithDeviceKernelDiameter ¶

func (o *MPSImageGuidedFilter) InitWithDeviceKernelDiameter(device metal.MTLDevice, kernelDiameter uint) *MPSImageGuidedFilter

@abstract Specifies information to apply the guided filter regression. @param device The device the filter will run on @param kernelDiameter The local window size @return A valid MPSImageGuidedFilterRegression object or nil, if failure.

func (*MPSImageGuidedFilter) KernelDiameter ¶

func (o *MPSImageGuidedFilter) KernelDiameter() uint

@property kernelDiameter @abstract The local window size @discussion The local window size.

func (*MPSImageGuidedFilter) ReconstructOffset ¶

func (o *MPSImageGuidedFilter) ReconstructOffset() float32

@property reconstructOffset @abstract The offset parameter @discussion The offset parameter added to the result of the scaled reconstructed value. The default value is 0.0f.

func (*MPSImageGuidedFilter) ReconstructScale ¶

func (o *MPSImageGuidedFilter) ReconstructScale() float32

@property reconstructScale @abstract The scale parameter @discussion The parameter used to scale the result of the reconstruction operation. The default value is 1.0f.

func (*MPSImageGuidedFilter) SetEpsilon ¶

func (o *MPSImageGuidedFilter) SetEpsilon(epsilon float32)

func (*MPSImageGuidedFilter) SetReconstructOffset ¶

func (o *MPSImageGuidedFilter) SetReconstructOffset(reconstructOffset float32)

func (*MPSImageGuidedFilter) SetReconstructScale ¶

func (o *MPSImageGuidedFilter) SetReconstructScale(reconstructScale float32)

func (*MPSImageHistogram) ClipRectSource ¶

func (o *MPSImageHistogram) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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.

func (*MPSImageHistogram) EncodeToCommandBufferSourceTextureHistogramHistogramOffset ¶

func (o *MPSImageHistogram) EncodeToCommandBufferSourceTextureHistogramHistogramOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, histogram metal.MTLBuffer, histogramOffset uint)

@abstract Encode the filter to a command buffer using a MTLComputeCommandEncoder. @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter @param histogram A valid MTLBuffer to receive the histogram results. @param histogramOffset Byte offset into histogram buffer at which to write the histogram results. Must be a multiple of 32 bytes. The histogram results / channel are stored together. The number of channels for which histogram results are stored is determined by the number of channels in the image. If histogramInfo.histogramForAlpha is false and the source image is RGBA then only histogram results for RGB channels are stored. The histogram results are stored in the histogram buffer as follows: - histogram results for the R channel for all bins followed by - histogram results for the G channel for all bins followed by - histogram results for the B channel for all bins followed by - histogram results for the A channel for all bins

func (*MPSImageHistogram) HistogramInfo ¶

func (o *MPSImageHistogram) HistogramInfo() MPSImageHistogramInfo

@property histogramInfo @abstract Return a structure describing the histogram content @discussion Returns a MPSImageHistogramInfo structure describing the format of the histogram.

func (*MPSImageHistogram) HistogramSizeForSourceFormat ¶

func (o *MPSImageHistogram) HistogramSizeForSourceFormat(sourceFormat metal.MTLPixelFormat) uint

@abstract The amount of space in the output MTLBuffer the histogram will take up. @discussion This convenience function calculates the minimum amount of space needed in the output histogram for the results. The MTLBuffer should be at least this length, longer if histogramOffset is non-zero. @param sourceFormat The MTLPixelFormat of the source image. This is the source parameter of -encodeToCommandBuffer: sourceTexture:histogram:histogramOffset @return The number of bytes needed to store the result histograms.

func (*MPSImageHistogram) InitWithCoderDevice ¶

func (o *MPSImageHistogram) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageHistogram

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageHistogram) InitWithDeviceHistogramInfo ¶

func (o *MPSImageHistogram) InitWithDeviceHistogramInfo(device metal.MTLDevice, histogramInfo *MPSImageHistogramInfo) *MPSImageHistogram

func (*MPSImageHistogram) MinPixelThresholdValue ¶

func (o *MPSImageHistogram) MinPixelThresholdValue() unsafe.Pointer

@property minPixelThresholdValue @abstract The minimum pixel threshold value @discussion The histogram entries will be incremented only if pixel value is >= minPixelThresholdValue. The minPixelThresholdValue is a floating-point value. For unsigned normalized textures, the minPixelThresholdValue should be a value between 0.0f and 1.0f (for eg. MTLPixelFormatRGBA8Unorm). For signed normalized textures, the minPixelThresholdValue should be a value between -1.0f and 1.0f (for eg. MTLPixelFormatRGBA8Snorm). Default: vector_float4(0.0f).

func (*MPSImageHistogram) SetClipRectSource ¶

func (o *MPSImageHistogram) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageHistogram) SetMinPixelThresholdValue ¶

func (o *MPSImageHistogram) SetMinPixelThresholdValue(minPixelThresholdValue unsafe.Pointer)

func (*MPSImageHistogram) SetZeroHistogram ¶

func (o *MPSImageHistogram) SetZeroHistogram(zeroHistogram bool)

func (*MPSImageHistogram) ZeroHistogram ¶

func (o *MPSImageHistogram) ZeroHistogram() bool

@property zeroHistogram @abstract Zero-initalize the histogram results @discussion Indicates that the memory region in which the histogram results are to be written in the histogram buffer are to be zero-initialized or not. Default: YES.

func (*MPSImageHistogramEqualization) EncodeTransformToCommandBufferSourceTextureHistogramHistogramOffset ¶

func (o *MPSImageHistogramEqualization) EncodeTransformToCommandBufferSourceTextureHistogramHistogramOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, histogram metal.MTLBuffer, histogramOffset uint)

@abstract Encode the transform function to a command buffer using a MTLComputeCommandEncoder. The transform function computes the equalization lookup table. @discussion The transform function will not begin to execute until after the command buffer has been enqueued and committed. This step will need to be repeated with the new MPSKernel if -copyWithZone:device or -copyWithZone: is called. The transform is stored as internal state to the object. You still need to call -encodeToCommandBuffer:sourceTexture:destinationTexture: afterward to apply the transform to produce a result texture. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter. @param histogram A valid MTLBuffer containing the histogram results for an image. This filter will use these histogram results to generate the cumulative histogram for equalizing the image. The histogram results / channel are stored together. The number of channels for which histogram results are stored is determined by the number of channels in the image. If histogramInfo.histogramForAlpha is false and the source image is RGBA then only histogram results for RGB channels are stored. @param histogramOffset A byte offset into the histogram MTLBuffer where the histogram starts. Must conform to alignment requirements for [MTLComputeCommandEncoder setBuffer:offset:atIndex:] offset parameter.

func (*MPSImageHistogramEqualization) HistogramInfo ¶

func (o *MPSImageHistogramEqualization) HistogramInfo() MPSImageHistogramInfo

@property histogramInfo @abstract Return a structure describing the histogram content @discussion Returns a MPSImageHistogramInfo structure describing the format of the histogram.

func (*MPSImageHistogramEqualization) InitWithCoderDevice ¶

func (o *MPSImageHistogramEqualization) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageHistogramEqualization

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageHistogramEqualization) InitWithDeviceHistogramInfo ¶

func (o *MPSImageHistogramEqualization) InitWithDeviceHistogramInfo(device metal.MTLDevice, histogramInfo *MPSImageHistogramInfo) *MPSImageHistogramEqualization

func (*MPSImageHistogramSpecification) EncodeTransformToCommandBufferSourceTextureSourceHistogramSourceHistogramOffsetDesiredHistogramDesiredHistogramOffset ¶

func (o *MPSImageHistogramSpecification) EncodeTransformToCommandBufferSourceTextureSourceHistogramSourceHistogramOffsetDesiredHistogramDesiredHistogramOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, sourceHistogram metal.MTLBuffer, sourceHistogramOffset uint, desiredHistogram metal.MTLBuffer, desiredHistogramOffset uint)

@abstract Encode the transform function to a command buffer using a MTLComputeCommandEncoder. The transform function computes the specification lookup table. @discussion The transform function will not begin to execute until after the command buffer has been enqueued and committed. This step will need to be repeated with the new MPSKernel if -copyWithZone:device or -copyWithZone: is called. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter. @param sourceHistogram A valid MTLBuffer containing the histogram results for the source image. This filter will use these histogram results to generate the cumulative histogram for equalizing the image. The histogram results / channel are stored together. The number of channels for which histogram results are stored is determined by the number of channels in the image. If histogramInfo.histogramForAlpha is false and the source image is RGBA then only histogram results for RGB channels are stored. @param sourceHistogramOffset A byte offset into the sourceHistogram MTLBuffer where the histogram starts. Must conform to alignment requirements for [MTLComputeCommandEncoder setBuffer:offset:atIndex:] offset parameter. @param desiredHistogram A valid MTLBuffer containing the desired histogram results for the source image. The histogram results / channel are stored together. The number of channels for which histogram results are stored is determined by the number of channels in the image. If histogramInfo.histogramForAlpha is false and the source image is RGBA then only histogram results for RGB channels are stored. @param desiredHistogramOffset A byte offset into the desiredHistogram MTLBuffer where the histogram starts. Must conform to alignment requirements for [MTLComputeCommandEncoder setBuffer:offset:atIndex:] offset parameter.

func (*MPSImageHistogramSpecification) HistogramInfo ¶

func (o *MPSImageHistogramSpecification) HistogramInfo() MPSImageHistogramInfo

@property histogramInfo @abstract Return a structure describing the histogram content @discussion Returns a MPSImageHistogramInfo structure describing the format of the histogram.

func (*MPSImageHistogramSpecification) InitWithCoderDevice ¶

func (o *MPSImageHistogramSpecification) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageHistogramSpecification

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageHistogramSpecification) InitWithDeviceHistogramInfo ¶

func (o *MPSImageHistogramSpecification) InitWithDeviceHistogramInfo(device metal.MTLDevice, histogramInfo *MPSImageHistogramInfo) *MPSImageHistogramSpecification

func (*MPSImageLanczosScale) InitWithCoderDevice ¶

func (o *MPSImageLanczosScale) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageLanczosScale

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageLanczosScale) InitWithDevice ¶

func (o *MPSImageLanczosScale) InitWithDevice(device metal.MTLDevice) *MPSImageLanczosScale

func (*MPSImageLaplacian) Bias ¶

func (o *MPSImageLaplacian) Bias() float32

@property bias @discussion The bias is a value to be added to convolved pixel before it is converted back to the storage format. It can be used to convert negative values into a representable range for a unsigned MTLPixelFormat. For example, many edge detection filters produce results in the range [-k,k]. By scaling the filter weights by 0.5/k and adding 0.5, the results will be in range [0,1] suitable for use with unorm formats. It can be used in combination with renormalization of the filter weights to do video ranging as part of the convolution effect. It can also just be used to increase the brightness of the image. Default value is 0.0f.

func (*MPSImageLaplacian) SetBias ¶

func (o *MPSImageLaplacian) SetBias(bias float32)

func (*MPSImageLaplacianPyramid) GetLaplacianBias ¶

func (o *MPSImageLaplacianPyramid) GetLaplacianBias() float32

func (*MPSImageLaplacianPyramid) GetLaplacianScale ¶

func (o *MPSImageLaplacianPyramid) GetLaplacianScale() float32

func (*MPSImageLaplacianPyramid) SetLaplacianBias ¶

func (o *MPSImageLaplacianPyramid) SetLaplacianBias(laplacianBias float32)

func (*MPSImageLaplacianPyramid) SetLaplacianScale ¶

func (o *MPSImageLaplacianPyramid) SetLaplacianScale(laplacianScale float32)

func (*MPSImageMedian) InitWithCoderDevice ¶

func (o *MPSImageMedian) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageMedian

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageMedian) InitWithDeviceKernelDiameter ¶

func (o *MPSImageMedian) InitWithDeviceKernelDiameter(device metal.MTLDevice, kernelDiameter uint) *MPSImageMedian

func (*MPSImageMedian) KernelDiameter ¶

func (o *MPSImageMedian) KernelDiameter() uint

@property kernelDiameter @abstract The diameter in pixels of the filter window. @discussion The median filter is applied to a kernelDiameter x kernelDiameter window of pixels centered on the corresponding source pixel for each destination pixel. The kernel diameter must be an odd number.

func (*MPSImageMultiply) InitWithDevice ¶

func (o *MPSImageMultiply) InitWithDevice(device metal.MTLDevice) *MPSImageMultiply

@abstract Initialize the multiplication operator @param device The device the filter will run on. @return A valid MPSImageMultiply object or nil, if failure.

func (*MPSImageNormalizedHistogram) ClipRectSource ¶

func (o *MPSImageNormalizedHistogram) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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.

func (*MPSImageNormalizedHistogram) EncodeToCommandBufferSourceTextureMinmaxTextureHistogramHistogramOffset ¶

func (o *MPSImageNormalizedHistogram) EncodeToCommandBufferSourceTextureMinmaxTextureHistogramHistogramOffset(commandBuffer metal.MTLCommandBuffer, source metal.MTLTexture, minmaxTexture metal.MTLTexture, histogram metal.MTLBuffer, histogramOffset uint)

@abstract Encode the filter to a command buffer using a MTLComputeCommandEncoder. @discussion The filter will not begin to execute until after the command buffer has been enqueued and committed. @param commandBuffer A valid MTLCommandBuffer. @param source A valid MTLTexture containing the source image for the filter @param minmaxTexture A valid MTLTexture in which the min/max pixel values from source will be returned @param histogram A valid MTLBuffer to receive the histogram results. @param histogramOffset Byte offset into histogram buffer at which to write the histogram results. Must be a multiple of 32 bytes. The histogram results / channel are stored together. The number of channels for which histogram results are stored is determined by the number of channels in the image. If histogramInfo.histogramForAlpha is false and the source image is RGBA then only histogram results for RGB channels are stored. The histogram results are stored in the histogram buffer as follows: - histogram results for the R channel for all bins followed by - histogram results for the G channel for all bins followed by - histogram results for the B channel for all bins followed by - histogram results for the A channel for all bins

func (*MPSImageNormalizedHistogram) HistogramInfo ¶

func (o *MPSImageNormalizedHistogram) HistogramInfo() MPSImageHistogramInfo

@property histogramInfo @abstract Return a structure describing the histogram content @discussion Returns a MPSImageHistogramInfo structure describing the format of the histogram.

func (*MPSImageNormalizedHistogram) HistogramSizeForSourceFormat ¶

func (o *MPSImageNormalizedHistogram) HistogramSizeForSourceFormat(sourceFormat metal.MTLPixelFormat) uint

@abstract The amount of space in the output MTLBuffer the histogram will take up. @discussion This convenience function calculates the minimum amount of space needed in the output histogram for the results. The MTLBuffer should be at least this length, longer if histogramOffset is non-zero. @param sourceFormat The MTLPixelFormat of the source image. This is the source parameter of -encodeToCommandBuffer: sourceTexture:histogram:histogramOffset @return The number of bytes needed to store the result histograms.

func (*MPSImageNormalizedHistogram) InitWithCoderDevice ¶

func (o *MPSImageNormalizedHistogram) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageNormalizedHistogram

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageNormalizedHistogram) InitWithDeviceHistogramInfo ¶

func (o *MPSImageNormalizedHistogram) InitWithDeviceHistogramInfo(device metal.MTLDevice, histogramInfo *MPSImageHistogramInfo) *MPSImageNormalizedHistogram

func (*MPSImageNormalizedHistogram) SetClipRectSource ¶

func (o *MPSImageNormalizedHistogram) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageNormalizedHistogram) SetZeroHistogram ¶

func (o *MPSImageNormalizedHistogram) SetZeroHistogram(zeroHistogram bool)

func (*MPSImageNormalizedHistogram) ZeroHistogram ¶

func (o *MPSImageNormalizedHistogram) ZeroHistogram() bool

@property zeroHistogram @abstract Zero-initalize the histogram results @discussion Indicates that the memory region in which the histogram results are to be written in the histogram buffer are to be zero-initialized or not. Default: YES.

func (*MPSImagePyramid) InitWithCoderDevice ¶

func (o *MPSImagePyramid) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImagePyramid

@abstract NSSecureCoding compatability @discussion See @ref MPSKernel#initWithCoder. @param aDecoder The NSCoder subclass with your serialized MPSCNNPooling @param device The MTLDevice on which to make the MPSCNNPooling @return A new MPSCNNPooling object, or nil if failure.

func (*MPSImagePyramid) InitWithDevice ¶

func (o *MPSImagePyramid) InitWithDevice(device metal.MTLDevice) *MPSImagePyramid

func (*MPSImagePyramid) InitWithDeviceCenterWeight ¶

func (o *MPSImagePyramid) InitWithDeviceCenterWeight(device metal.MTLDevice, centerWeight float32) *MPSImagePyramid

func (*MPSImagePyramid) InitWithDeviceKernelWidthKernelHeightWeights ¶

func (o *MPSImagePyramid) InitWithDeviceKernelWidthKernelHeightWeights(device metal.MTLDevice, kernelWidth uint, kernelHeight uint, kernelWeights *float32) *MPSImagePyramid

func (*MPSImagePyramid) KernelHeight ¶

func (o *MPSImagePyramid) KernelHeight() uint

@property kernelHeight @abstract The height of the filter window. Must be an odd number.

func (*MPSImagePyramid) KernelWidth ¶

func (o *MPSImagePyramid) KernelWidth() uint

@property kernelWidth @abstract The width of the filter window. Must be an odd number.

func (*MPSImageReduceColumnMax) InitWithDevice ¶

func (o *MPSImageReduceColumnMax) InitWithDevice(device metal.MTLDevice) *MPSImageReduceColumnMax

func (*MPSImageReduceColumnMean) InitWithDevice ¶

func (o *MPSImageReduceColumnMean) InitWithDevice(device metal.MTLDevice) *MPSImageReduceColumnMean

func (*MPSImageReduceColumnMin) InitWithDevice ¶

func (o *MPSImageReduceColumnMin) InitWithDevice(device metal.MTLDevice) *MPSImageReduceColumnMin

func (*MPSImageReduceColumnSum) InitWithDevice ¶

func (o *MPSImageReduceColumnSum) InitWithDevice(device metal.MTLDevice) *MPSImageReduceColumnSum

func (*MPSImageReduceRowMax) InitWithDevice ¶

func (o *MPSImageReduceRowMax) InitWithDevice(device metal.MTLDevice) *MPSImageReduceRowMax

func (*MPSImageReduceRowMean) InitWithDevice ¶

func (o *MPSImageReduceRowMean) InitWithDevice(device metal.MTLDevice) *MPSImageReduceRowMean

func (*MPSImageReduceRowMin) InitWithDevice ¶

func (o *MPSImageReduceRowMin) InitWithDevice(device metal.MTLDevice) *MPSImageReduceRowMin

func (*MPSImageReduceRowSum) InitWithDevice ¶

func (o *MPSImageReduceRowSum) InitWithDevice(device metal.MTLDevice) *MPSImageReduceRowSum

func (*MPSImageReduceUnary) ClipRectSource ¶

func (o *MPSImageReduceUnary) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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.

func (*MPSImageReduceUnary) SetClipRectSource ¶

func (o *MPSImageReduceUnary) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageScale) InitWithCoderDevice ¶

func (o *MPSImageScale) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageScale

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageScale) InitWithDevice ¶

func (o *MPSImageScale) InitWithDevice(device metal.MTLDevice) *MPSImageScale

func (*MPSImageScale) ScaleTransform ¶

func (o *MPSImageScale) ScaleTransform() *mpscore.MPSScaleTransform

@property scaleTransform @abstract An optional transform that describes how to scale and translate the source image @discussion If the scaleTransform is NULL, then any image scaling factor such as MPSImageLanczosScale will rescale the image so that the source image fits exactly into the destination texture. If the transform is not NULL, then the transform is used for determining how to map the source image to the destination. Default: NULL When the scaleTransform is set to non-NULL, the values pointed to by the new scaleTransform are copied to object storage, and the pointer is updated to point to internal storage. Do not attempt to free it. You may free your copy of the MPSScaleTransform as soon as the property set operation is complete. When calculating a scaleTransform, use the limits of the bounding box for the intended source region of interest and the destination clipRect. Adjustments for pixel center coordinates are handled internally to the function. For example, the scale transform to convert the entire source image to the entire destination image size (clipRect = MPSRectNoClip) would be: @code scaleTransform.scaleX = (double) dest.width / source.width; scaleTransform.scaleY = (double) dest.height / source.height; scaleTransform.translateX = scaleTransform.translateY = 0.0; @endcode The translation parameters allow you to adjust the region of the source image used to create the destination image. They are in destination coordinates. To place the top left corner of the destination clipRect to represent the position {x,y} in source coordinates, we solve for the translation based on the standard scale matrix operation for each axis: @code dest_position = source_position * scale + translation; translation = dest_position - source_position * scale; @endcode For the top left corner of the clipRect, the dest_position is considered to be {0,0}. This gives us a translation of: @code scaleTransform.translateX = -source_origin.x * scaleTransform.scaleX; scaleTransform.translateY = -source_origin.y * scaleTransform.scaleY; @endcode One would typically use non-zero translations to do tiling, or provide a resized view into a internal segment of an image. NOTE: Changing the Lanczos scale factor may trigger recalculation of signficant state internal to the object when the filter is encoded to the command buffer. The scale factor is scaleTransform->scaleX,Y, or the ratio of source and destination image sizes if scaleTransform is NULL. Reuse a MPSImageLanczosScale object for frequently used scalings to avoid redundantly recreating expensive resampling state.

func (*MPSImageScale) SetScaleTransform ¶

func (o *MPSImageScale) SetScaleTransform(scaleTransform *mpscore.MPSScaleTransform)

func (*MPSImageSobel) ColorTransform ¶

func (o *MPSImageSobel) ColorTransform() *float32

@property colorTransform @discussion 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.

func (*MPSImageSobel) InitWithCoderDevice ¶

func (o *MPSImageSobel) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageSobel

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageSobel) InitWithDevice ¶

func (o *MPSImageSobel) InitWithDevice(device metal.MTLDevice) *MPSImageSobel

@abstract 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: @param device The device the filter will run on @return A valid object or nil, if failure.

func (*MPSImageSobel) InitWithDeviceLinearGrayColorTransform ¶

func (o *MPSImageSobel) InitWithDeviceLinearGrayColorTransform(device metal.MTLDevice, transform *float32) *MPSImageSobel

@abstract Initialize a Sobel filter on a given device with a non-default color transform @param device The device the filter will run on @param transform Array of three floats describing the rgb to gray scale color transform. @code Luminance = transform[0] * pixel.x + transform[1] * pixel.y + transform[2] * pixel.z; @endcode @return A valid object or nil, if failure.

func (*MPSImageStatisticsMean) ClipRectSource ¶

func (o *MPSImageStatisticsMean) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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 mean value is written.

func (*MPSImageStatisticsMean) InitWithCoderDevice ¶

func (o *MPSImageStatisticsMean) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageStatisticsMean

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageStatisticsMean) InitWithDevice ¶

func (o *MPSImageStatisticsMean) InitWithDevice(device metal.MTLDevice) *MPSImageStatisticsMean

func (*MPSImageStatisticsMean) SetClipRectSource ¶

func (o *MPSImageStatisticsMean) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageStatisticsMeanAndVariance) ClipRectSource ¶

func (o *MPSImageStatisticsMeanAndVariance) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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 mean value is written.

func (*MPSImageStatisticsMeanAndVariance) InitWithCoderDevice ¶

func (o *MPSImageStatisticsMeanAndVariance) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageStatisticsMeanAndVariance

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageStatisticsMeanAndVariance) InitWithDevice ¶

func (o *MPSImageStatisticsMeanAndVariance) InitWithDevice(device metal.MTLDevice) *MPSImageStatisticsMeanAndVariance

func (*MPSImageStatisticsMeanAndVariance) SetClipRectSource ¶

func (o *MPSImageStatisticsMeanAndVariance) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageStatisticsMinAndMax) ClipRectSource ¶

func (o *MPSImageStatisticsMinAndMax) ClipRectSource() metal.MTLRegion

@property clipRectSource @abstract The source rectangle to use when reading data. @discussion 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.

func (*MPSImageStatisticsMinAndMax) InitWithCoderDevice ¶

func (o *MPSImageStatisticsMinAndMax) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageStatisticsMinAndMax

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageStatisticsMinAndMax) InitWithDevice ¶

func (o *MPSImageStatisticsMinAndMax) InitWithDevice(device metal.MTLDevice) *MPSImageStatisticsMinAndMax

func (*MPSImageStatisticsMinAndMax) SetClipRectSource ¶

func (o *MPSImageStatisticsMinAndMax) SetClipRectSource(clipRectSource metal.MTLRegion)

func (*MPSImageSubtract) InitWithDevice ¶

func (o *MPSImageSubtract) InitWithDevice(device metal.MTLDevice) *MPSImageSubtract

@abstract Initialize the subtraction operator @param device The device the filter will run on. @return A valid MPSImageSubtract object or nil, if failure.

func (*MPSImageThresholdBinary) InitWithCoderDevice ¶

func (o *MPSImageThresholdBinary) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageThresholdBinary

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageThresholdBinary) InitWithDeviceThresholdValueMaximumValueLinearGrayColorTransform ¶

func (o *MPSImageThresholdBinary) InitWithDeviceThresholdValueMaximumValueLinearGrayColorTransform(device metal.MTLDevice, thresholdValue float32, maximumValue float32, transform *float32) *MPSImageThresholdBinary

@abstract initialize a MPSImageThresholdBinary filter @param device The device the filter will run on @param thresholdValue The threshold value to use @param maximumValue The maximum value to use @param transform This matrix is an array of 3 floats. The default if no transform is specifed is BT.601/JPEG: {0.299f, 0.587f, 0.114f};

func (*MPSImageThresholdBinary) MaximumValue ¶

func (o *MPSImageThresholdBinary) MaximumValue() float32

@property maximumValue @discussion The maximum value used to init the threshold filter

func (*MPSImageThresholdBinary) ThresholdValue ¶

func (o *MPSImageThresholdBinary) ThresholdValue() float32

@property thresholdValue @discussion The threshold value used to init the threshold filter

func (*MPSImageThresholdBinary) Transform ¶

func (o *MPSImageThresholdBinary) Transform() *float32

@property transform @discussion The color transform used to init the threshold filter

func (*MPSImageThresholdBinaryInverse) InitWithCoderDevice ¶

func (o *MPSImageThresholdBinaryInverse) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageThresholdBinaryInverse

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageThresholdBinaryInverse) InitWithDeviceThresholdValueMaximumValueLinearGrayColorTransform ¶

func (o *MPSImageThresholdBinaryInverse) InitWithDeviceThresholdValueMaximumValueLinearGrayColorTransform(device metal.MTLDevice, thresholdValue float32, maximumValue float32, transform *float32) *MPSImageThresholdBinaryInverse

@abstract initialize a MPSImageThresholdBinaryInverse filter @param device The device the filter will run on @param thresholdValue The threshold value to use @param maximumValue The maximum value to use @param transform This matrix is an array of 3 floats. The default if no transform is specifed is BT.601/JPEG: {0.299f, 0.587f, 0.114f};

func (*MPSImageThresholdBinaryInverse) MaximumValue ¶

func (o *MPSImageThresholdBinaryInverse) MaximumValue() float32

@property maximumValue @discussion The maximum value used to init the threshold filter

func (*MPSImageThresholdBinaryInverse) ThresholdValue ¶

func (o *MPSImageThresholdBinaryInverse) ThresholdValue() float32

@property thresholdValue @discussion The threshold value used to init the threshold filter

func (*MPSImageThresholdBinaryInverse) Transform ¶

func (o *MPSImageThresholdBinaryInverse) Transform() *float32

@property transform @discussion The color transform used to init the threshold filter

func (*MPSImageThresholdToZero) InitWithCoderDevice ¶

func (o *MPSImageThresholdToZero) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageThresholdToZero

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageThresholdToZero) InitWithDeviceThresholdValueLinearGrayColorTransform ¶

func (o *MPSImageThresholdToZero) InitWithDeviceThresholdValueLinearGrayColorTransform(device metal.MTLDevice, thresholdValue float32, transform *float32) *MPSImageThresholdToZero

@abstract initialize a MPSImageThresholdToZero filter @param device The device the filter will run on @param thresholdValue The threshold value to use @param transform This matrix is an array of 3 floats. The default if no transform is specifed is BT.601/JPEG: {0.299f, 0.587f, 0.114f};

func (*MPSImageThresholdToZero) ThresholdValue ¶

func (o *MPSImageThresholdToZero) ThresholdValue() float32

@property thresholdValue @discussion The threshold value used to init the threshold filter

func (*MPSImageThresholdToZero) Transform ¶

func (o *MPSImageThresholdToZero) Transform() *float32

@property transform @discussion The color transform used to init the threshold filter

func (*MPSImageThresholdToZeroInverse) InitWithCoderDevice ¶

func (o *MPSImageThresholdToZeroInverse) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageThresholdToZeroInverse

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageThresholdToZeroInverse) InitWithDeviceThresholdValueLinearGrayColorTransform ¶

func (o *MPSImageThresholdToZeroInverse) InitWithDeviceThresholdValueLinearGrayColorTransform(device metal.MTLDevice, thresholdValue float32, transform *float32) *MPSImageThresholdToZeroInverse

@abstract initialize a MPSImageThresholdToZeroInverse filter @param device The device the filter will run on @param thresholdValue The threshold value to use @param transform This matrix is an array of 3 floats. The default if no transform is specifed is BT.601/JPEG: {0.299f, 0.587f, 0.114f};

func (*MPSImageThresholdToZeroInverse) ThresholdValue ¶

func (o *MPSImageThresholdToZeroInverse) ThresholdValue() float32

@property thresholdValue @discussion The threshold value used to init the threshold filter

func (*MPSImageThresholdToZeroInverse) Transform ¶

func (o *MPSImageThresholdToZeroInverse) Transform() *float32

@property transform @discussion The color transform used to init the threshold filter

func (*MPSImageThresholdTruncate) InitWithCoderDevice ¶

func (o *MPSImageThresholdTruncate) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSImageThresholdTruncate

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSImageThresholdTruncate) InitWithDeviceThresholdValueLinearGrayColorTransform ¶

func (o *MPSImageThresholdTruncate) InitWithDeviceThresholdValueLinearGrayColorTransform(device metal.MTLDevice, thresholdValue float32, transform *float32) *MPSImageThresholdTruncate

@abstract initialize a MPSImageThresholdTruncate filter @param device The device the filter will run on @param thresholdValue The threshold value to use @param transform This matrix is an array of 3 floats. The default if no transform is specifed is BT.601/JPEG: {0.299f, 0.587f, 0.114f};

func (*MPSImageThresholdTruncate) ThresholdValue ¶

func (o *MPSImageThresholdTruncate) ThresholdValue() float32

@property thresholdValue @discussion The threshold value used to init the threshold filter

func (*MPSImageThresholdTruncate) Transform ¶

func (o *MPSImageThresholdTruncate) Transform() *float32

@property transform @discussion The color transform used to init the threshold filter

func (MPSImageType) String ¶

func (e MPSImageType) String() string

func (*MPSMatrixCopyToImage) DataLayout ¶

func (o *MPSMatrixCopyToImage) DataLayout() mpscore.MPSDataLayout

@property dataLayout @abstract The data layout to use @discussion Returns the data layout. When copying from a MPSMatrix to a MPSImage, this describes the order in which the image values are to be stored in the buffer associated with the MPSMatrix. Default: MPSDataLayoutFeatureChannelsxHeightxWidth

func (*MPSMatrixCopyToImage) EncodeBatchToCommandBufferSourceMatrixDestinationImages ¶

func (o *MPSMatrixCopyToImage) EncodeBatchToCommandBufferSourceMatrixDestinationImages(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, destinationImages unsafe.Pointer)

@abstract Encode a kernel that copies a MPSMatrix to a MPSImageBatch into a command buffer using a MTLComputeCommandEncoder. @discussion The kernel copies feature channels from sourceImage to the buffer associated with destinationMatrix. The kernel will not begin to execute until after the command buffer has been enqueued and committed. Each image will be copied to its own row in the matrix, starting with row destinationMatrixOrigin.x. NOTE: The destinationMatrix.dataType must match the feature channel data type in sourceImage. NOTE: All the images in the source batch should be of the same size and have numberOfImages = 1. @param commandBuffer A valid MTLCommandBuffer. @param sourceMatrix A valid MPSMatrix or MPSTemporaryMatrix object describing the source matrix. @param destinationImages A valid MPSImageBatch describing the images to copy to.

func (*MPSMatrixCopyToImage) EncodeToCommandBufferSourceMatrixDestinationImage ¶

func (o *MPSMatrixCopyToImage) EncodeToCommandBufferSourceMatrixDestinationImage(commandBuffer metal.MTLCommandBuffer, sourceMatrix *mpscore.MPSMatrix, destinationImage *mpscore.MPSImage)

@abstract Encode a kernel that copies a MPSMatrix to a MPSImage into a command buffer using a MTLComputeCommandEncoder. @discussion The kernel copies feature channels from sourceMatrix to the destinationImage. The kernel will not begin to execute until after the command buffer has been enqueued and committed. NOTE: The sourceMatrix.dataType must match the feature channel data type in destinationImage. @param commandBuffer A valid MTLCommandBuffer. @param sourceMatrix A valid MPSMatrix or MPSTemporaryMatrix object describing the source matrix. @param destinationImage A valid MPSImage describing the image to copy to.

func (*MPSMatrixCopyToImage) InitWithCoderDevice ¶

func (o *MPSMatrixCopyToImage) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSMatrixCopyToImage

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSMatrixCopyToImage) InitWithDeviceDataLayout ¶

func (o *MPSMatrixCopyToImage) InitWithDeviceDataLayout(device metal.MTLDevice, dataLayout mpscore.MPSDataLayout) *MPSMatrixCopyToImage

@abstract Initialize a MPSMatrixCopyToImage object on a device @param device The device the kernel will run on @param dataLayout The data layout @return A valid MPSMatrixCopyToImage object or nil, if failure.

func (*MPSMatrixCopyToImage) SetSourceMatrixBatchIndex ¶

func (o *MPSMatrixCopyToImage) SetSourceMatrixBatchIndex(sourceMatrixBatchIndex uint)

func (*MPSMatrixCopyToImage) SetSourceMatrixOrigin ¶

func (o *MPSMatrixCopyToImage) SetSourceMatrixOrigin(sourceMatrixOrigin metal.MTLOrigin)

func (*MPSMatrixCopyToImage) SourceMatrixBatchIndex ¶

func (o *MPSMatrixCopyToImage) SourceMatrixBatchIndex() uint

@property sourceMatrixBatchIndex @discussion The index of the source matrix in the batch. This property is modifiable and defaults to 0 at initialization time.

func (*MPSMatrixCopyToImage) SourceMatrixOrigin ¶

func (o *MPSMatrixCopyToImage) SourceMatrixOrigin() metal.MTLOrigin

@property sourceMatrixOrigin @discussion The origin, relative to [0, 0] in the source matrix. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel. The z value must be 0.

func (*MPSUnaryImageKernel) ClipRect ¶

func (o *MPSUnaryImageKernel) ClipRect() metal.MTLRegion

@property clipRect @abstract An optional clip rectangle to use when writing data. Only the pixels in the rectangle will be overwritten. @discussion A MTLRegion that indicates which part of the destination to overwrite. If the clipRect does not lie completely within the destination image, the intersection between clip rectangle and destination bounds is used. Default: MPSRectNoClip (MPSKernel::MPSRectNoClip) indicating the entire image. See Also: @ref MetalPerformanceShaders.h subsubsection_clipRect

func (*MPSUnaryImageKernel) EdgeMode ¶

func (o *MPSUnaryImageKernel) EdgeMode() mpscore.MPSImageEdgeMode

@property edgeMode @abstract The MPSImageEdgeMode to use when texture reads stray off the edge of an image @discussion Most MPSKernel objects can read off the edge of the 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 looks at neighboring pixels, such as a Convolution or morphology filter. Default: usually MPSImageEdgeModeZero. (Some MPSKernel types default to MPSImageEdgeModeClamp, because MPSImageEdgeModeZero is either not supported or would produce unexpected results.) See Also: @ref MetalPerformanceShaders.h subsubsection_edgemode

func (*MPSUnaryImageKernel) EncodeToCommandBufferInPlaceTextureFallbackCopyAllocator ¶

func (o *MPSUnaryImageKernel) EncodeToCommandBufferInPlaceTextureFallbackCopyAllocator(commandBuffer metal.MTLCommandBuffer, texture metal.MTLTexture, copyAllocator func() unsafe.Pointer) bool

This method attempts to apply the MPSKernel in place on a texture. In-place operation means that the same texture is used both to hold the input image and the results. Operating in-place can be an excellent way to reduce resource utilization, and save time and energy. While simple Metal kernels can not operate in place because textures can not be readable and writable at the same time, some MPSKernels can operate in place because they use multi-pass algorithms. Whether a MPSKernel can operate in-place can depend on current hardware, operating system revision and the parameters and properties passed to it. You should never assume that a MPSKernel will continue to work in place, even if you have observed it doing so before. If the operation succeeds in-place, YES is returned. If the in-place operation fails and no copyAllocator is provided, then NO is returned. Without a fallback MPSCopyAllocator, in neither case is the pointer held at *texture modified. Failure during in-place operation is very common and will occur inconsistently across different hardware platforms and OS releases. Without a fallback MPSCopyAllocator, operating in place may require significant error handling code to accompany each call to -encodeToCommandBuffer:..., complicating your code. You may find it simplifies your code to provide a fallback MPSCopyAllocator so that the operation can proceed reliably even when it can not proceed in-place. When an in-place filter fails, the MPSCopyAllocator (if any) will be invoked to create a new texture in which to write the results, allowing the filter to proceed reliably out-of-place. The original texture will be released, replaced with a pointer to the new texture and YES will be returned. If the allocator returns an invalid texture, it is released, *texture remains unmodified and NO is returned. Please see the MPSCopyAllocator definition for a sample allocator implementation. Sample usage with a copy allocator: @code id <MTLTexture> inPlaceTex = ...; MPSImageSobel *sobelFiler = [[MPSImageSobel alloc] initWithDevice: myDevice]; // With a fallback MPSCopyAllocator, failure should only occur in exceptional // conditions such as MTLTexture allocation failure or programmer error. // That is, the operation is roughly as robust as the MPSCopyAllocator. // Depending on the quality of that, we might decide we are justified here // in not checking the return value. [sobelFilter encodeToCommandBuffer: myCommandBuffer inPlaceTexture: &inPlaceTex // may be replaced! fallbackCopyAllocator: myAllocator]; // If myAllocator was not called: // // inPlaceTex holds the original texture with the result pixels in it // // else, // // 1) myAllocator creates a new texture. // 2) The new texture pixel data is overwritten by MPSUnaryImageKernel. // 3) The old texture passed in *inPlaceTex is released once. // 4) *inPlaceTex = the new texture // // In either case, the caller should now hold one reference to the texture now held in // inPlaceTex, whether it was replaced or not. Most of the time that means that nothing // further needs to be done here, and you can proceed to the next image encoding operation. // However, if other agents held references to the original texture, they still hold them // and may need to be alerted that the texture has been replaced so that they can retain // the new texture and release the old one. [sobelFilter release]; // if not ARC, clean up the MPSImageSobel object @endcode Note: Image filters that look at neighboring pixel values may actually consume more memory when operating in place than out of place. Many such operations are tiled internally to save intermediate texture storage, but can not tile when operating in place. The memory savings for tiling is however very short term, typically the lifetime of the MTLCommandBuffer. @abstract Attempt to apply a MPSKernel to a texture in place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param texture A pointer to a valid MTLTexture containing source image. On success, the image contents and possibly texture itself will be replaced with the result image. @param copyAllocator An optional block to allocate a new texture to hold the results, in case in-place operation is not possible. The allocator may use a different MTLPixelFormat or size than the original texture. You may enqueue operations on the provided MTLCommandBuffer using the provided MTLComputeCommandEncoder to initialize the texture contents. @return On success, YES is returned. The texture may have been replaced with a new texture if a copyAllocator was provided. On failure, NO is returned. The texture is unmodified.

func (*MPSUnaryImageKernel) EncodeToCommandBufferSourceImageDestinationImage ¶

func (o *MPSUnaryImageKernel) EncodeToCommandBufferSourceImageDestinationImage(commandBuffer metal.MTLCommandBuffer, sourceImage *mpscore.MPSImage, destinationImage *mpscore.MPSImage)

@abstract Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceImage A valid MPSImage containing the source image. @param destinationImage A valid MPSImage to be overwritten by result image. DestinationImage may not alias sourceImage.

func (*MPSUnaryImageKernel) EncodeToCommandBufferSourceTextureDestinationTexture ¶

func (o *MPSUnaryImageKernel) EncodeToCommandBufferSourceTextureDestinationTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, destinationTexture metal.MTLTexture)

@abstract Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place. @param commandBuffer A valid MTLCommandBuffer to receive the encoded filter @param sourceTexture A valid MTLTexture containing the source image. @param destinationTexture A valid MTLTexture to be overwritten by result image. DestinationTexture may not alias sourceTexture.

func (*MPSUnaryImageKernel) InitWithCoderDevice ¶

func (o *MPSUnaryImageKernel) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSUnaryImageKernel

@abstract NSSecureCoding compatability @discussion 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. @param aDecoder The NSCoder subclass with your serialized MPSKernel @param device The MTLDevice on which to make the MPSKernel @return A new MPSKernel object, or nil if failure.

func (*MPSUnaryImageKernel) InitWithDevice ¶

func (o *MPSUnaryImageKernel) InitWithDevice(device metal.MTLDevice) *MPSUnaryImageKernel

@abstract Standard init with default properties per filter type @param device The device that the filter will be used on. May not be NULL. @result 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.

func (*MPSUnaryImageKernel) Offset ¶

func (o *MPSUnaryImageKernel) Offset() mpscore.MPSOffset

@property offset @abstract The position of the destination clip rectangle origin relative to the source buffer. @discussion The offset is defined to be the position of clipRect.origin in source coordinates. Default: {0,0,0}, indicating that the top left corners of the clipRect and source image align. See Also: @ref MetalPerformanceShaders.h subsubsection_mpsoffset

func (*MPSUnaryImageKernel) SetClipRect ¶

func (o *MPSUnaryImageKernel) SetClipRect(clipRect metal.MTLRegion)

func (*MPSUnaryImageKernel) SetEdgeMode ¶

func (o *MPSUnaryImageKernel) SetEdgeMode(edgeMode mpscore.MPSImageEdgeMode)

func (*MPSUnaryImageKernel) SetOffset ¶

func (o *MPSUnaryImageKernel) SetOffset(offset mpscore.MPSOffset)

func (*MPSUnaryImageKernel) SourceRegionForDestinationSize ¶

func (o *MPSUnaryImageKernel) SourceRegionForDestinationSize(destinationSize metal.MTLSize) mpscore.MPSRegion

sourceRegionForDestinationSize: is used to determine which region of the sourceTexture will be read by encodeToCommandBuffer:sourceTexture:destinationTexture (and similar) when the filter runs. This information may be needed if the source image is broken into multiple textures. The size of the full (untiled) destination image is provided. The region of the full (untiled) source image that will be read is returned. You can then piece together an appropriate texture containing that information for use in your tiled context. The function will consult the MPSUnaryImageKernel offset and clipRect parameters, to determine the full region read by the function. Other parameters such as sourceClipRect, kernelHeight and kernelWidth will be consulted as necessary. All properties should be set to intended values prior to calling sourceRegionForDestinationSize:. Caution: This function operates using global image coordinates, but -encodeToCommandBuffer:... uses coordinates local to the source and destination image textures. Consequently, the offset and clipRect attached to this object will need to be updated using a global to local coordinate transform before -encodeToCommandBuffer:... is called. @abstract Determine the region of the source texture that will be read for a encode operation @param destinationSize The size of the full virtual destination image. @return The area in the virtual source image that will be read.

func (Mach_vm_range_flags_t) String ¶

func (e Mach_vm_range_flags_t) String() string

func (Mach_vm_range_flavor_t) String ¶

func (e Mach_vm_range_flavor_t) String() string

func (Mach_vm_range_tag_t) String ¶

func (e Mach_vm_range_tag_t) String() string

func (Mpo_flags_t) String ¶

func (e Mpo_flags_t) String() string

func (Os_clockid_t) String ¶

func (e Os_clockid_t) String() string

func (Ptrauth_key) String ¶

func (e Ptrauth_key) String() string

func (Qos_class_t) String ¶

func (e Qos_class_t) String() string

func (Virtual_memory_guard_exception_code_t) String ¶

func (e Virtual_memory_guard_exception_code_t) String() string

func (Xpc_listener_create_flags_t) String ¶

func (e Xpc_listener_create_flags_t) String() string

func (Xpc_session_create_flags_t) String ¶

func (e Xpc_session_create_flags_t) String() string