MPSBinaryImageKernel (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.metalperformanceshaders.MPSKernel
      - apple.metalperformanceshaders.MPSBinaryImageKernel

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

Direct Known Subclasses:

MPSImageArithmetic
```
public class MPSBinaryImageKernel
extends MPSKernel
```
MPSBinaryImageKernel [@dependency] This depends on Metal.framework
A MPSBinaryImageKernel consumes two MTLTextures and produces one MTLTexture.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MPSBinaryImageKernel.Block_encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator`
`static interface`	`MPSBinaryImageKernel.Block_encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator`

Nested classes/interfaces inherited from class apple.NSObject
NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

protected MPSBinaryImageKernel(org.moe.natj.general.Pointer peer)

Constructors
Modifier	Constructor and Description
`protected`	`MPSBinaryImageKernel(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`_supportsSecureCoding()` This property must return YES on all classes that allow secure coding.
`static boolean`	`accessInstanceVariablesDirectly()`
`static MPSBinaryImageKernel`	`alloc()`
`static MPSBinaryImageKernel`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`static void`	`cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)`
`static void`	`cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)`
`static NSArray<java.lang.String>`	`classFallbacksForKeyedArchiver()`
`static org.moe.natj.objc.Class`	`classForKeyedUnarchiver()`
`MTLRegion`	`clipRect()` [@property] clipRect
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`boolean`	`encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator(MTLCommandBuffer commandBuffer, org.moe.natj.general.ptr.Ptr<org.moe.natj.objc.ObjCObject> inPlacePrimaryTexture, MTLTexture secondaryTexture, MPSBinaryImageKernel.Block_encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator copyAllocator)` Attempt to apply a MPSKernel to a texture in place.
`void`	`encodeToCommandBufferPrimaryImageSecondaryImageDestinationImage(MTLCommandBuffer commandBuffer, MPSImage primaryImage, MPSImage secondaryImage, MPSImage destinationImage)` Encode a MPSKernel into a command Buffer.
`boolean`	`encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator(MTLCommandBuffer commandBuffer, MTLTexture primaryTexture, org.moe.natj.general.ptr.Ptr<org.moe.natj.objc.ObjCObject> inPlaceSecondaryTexture, MPSBinaryImageKernel.Block_encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator copyAllocator)` This method attempts to apply the MPSKernel in place on a texture.
`void`	`encodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture(MTLCommandBuffer commandBuffer, MTLTexture primaryTexture, MTLTexture secondaryTexture, MTLTexture destinationTexture)` Encode a MPSKernel into a command Buffer.
`static long`	`hash_static()`
`MPSBinaryImageKernel`	`init()`
`MPSBinaryImageKernel`	`initWithCoder(NSCoder aDecoder)` NS_DESIGNATED_INITIALIZER
`MPSBinaryImageKernel`	`initWithCoderDevice(NSCoder aDecoder, java.lang.Object device)` NSSecureCoding compatability
`MPSBinaryImageKernel`	`initWithDevice(java.lang.Object device)` Standard init with default properties per filter type
`static NSObject.Function_instanceMethodForSelector_ret`	`instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)`
`static NSMethodSignature`	`instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`static MPSBinaryImageKernel`	`new_objc()`
`long`	`primaryEdgeMode()` [@property] primaryEdgeMode
`MPSOffset`	`primaryOffset()` [@property] primaryOffset
`MPSRegion`	`primarySourceRegionForDestinationSize(MTLSize destinationSize)` 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.
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`long`	`secondaryEdgeMode()` [@property] secondaryEdgeMode
`MPSOffset`	`secondaryOffset()` [@property] secondaryOffset
`MPSRegion`	`secondarySourceRegionForDestinationSize(MTLSize destinationSize)` 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.
`void`	`setClipRect(MTLRegion value)` [@property] clipRect
`void`	`setPrimaryEdgeMode(long value)` [@property] primaryEdgeMode
`void`	`setPrimaryOffset(MPSOffset value)` [@property] primaryOffset
`void`	`setSecondaryEdgeMode(long value)` [@property] secondaryEdgeMode
`void`	`setSecondaryOffset(MPSOffset value)` [@property] secondaryOffset
`static void`	`setVersion_static(long aVersion)`
`static org.moe.natj.objc.Class`	`superclass_static()`
`static boolean`	`supportsSecureCoding()`
`static long`	`version_static()`

Methods inherited from class apple.metalperformanceshaders.MPSKernel
copyWithZone, copyWithZoneDevice, device, encodeWithCoder, label, options, setLabel, setOptions

Methods inherited from class apple.NSObject
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject
equals, toString

Methods inherited from class org.moe.natj.general.NativeObject
finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MPSBinaryImageKernel
```
protected MPSBinaryImageKernel(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - accessInstanceVariablesDirectly
```
public static boolean accessInstanceVariablesDirectly()
```
  - alloc
```
public static MPSBinaryImageKernel alloc()
```
  - allocWithZone
```
public static MPSBinaryImageKernel allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
  - automaticallyNotifiesObserversForKey
```
public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)
```
  - cancelPreviousPerformRequestsWithTarget
```
public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
```
  - cancelPreviousPerformRequestsWithTargetSelectorObject
```
public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)
```
  - classFallbacksForKeyedArchiver
```
public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
```
  - classForKeyedUnarchiver
```
public static org.moe.natj.objc.Class classForKeyedUnarchiver()
```
  - debugDescription_static
```
public static java.lang.String debugDescription_static()
```
  - description_static
```
public static java.lang.String description_static()
```
  - hash_static
```
public static long hash_static()
```
  - instanceMethodForSelector
```
public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
```
  - instanceMethodSignatureForSelector
```
public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
```
  - instancesRespondToSelector
```
public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
```
  - isSubclassOfClass
```
public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)
```
  - keyPathsForValuesAffectingValueForKey
```
public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)
```
  - new_objc
```
public static MPSBinaryImageKernel new_objc()
```
  - resolveClassMethod
```
public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)
```
  - resolveInstanceMethod
```
public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)
```
  - setVersion_static
```
public static void setVersion_static(long aVersion)
```
  - superclass_static
```
public static org.moe.natj.objc.Class superclass_static()
```
  - version_static
```
public static long version_static()
```
  - clipRect
```
public MTLRegion clipRect()
```
    [@property] clipRect
    An optional clip rectangle to use when writing data. Only the pixels in the rectangle will be overwritten.
    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
  - encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator
```
public boolean encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator(MTLCommandBuffer commandBuffer,
                                                                                               org.moe.natj.general.ptr.Ptr<org.moe.natj.objc.ObjCObject> inPlacePrimaryTexture,
                                                                                               MTLTexture secondaryTexture,
                                                                                               MPSBinaryImageKernel.Block_encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator copyAllocator)
```
    Attempt to apply a MPSKernel to a texture in place.
    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.
    
    Parameters:
    
    commandBuffer - A valid MTLCommandBuffer to receive the encoded filter
    
    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.
    
    secondaryTexture - A pointer to a valid MTLTexture containing the primary source image. It will not be overwritten.
    
    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.
    
    Returns:
    
    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.
  - encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator
```
public boolean encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator(MTLCommandBuffer commandBuffer,
                                                                                               MTLTexture primaryTexture,
                                                                                               org.moe.natj.general.ptr.Ptr<org.moe.natj.objc.ObjCObject> inPlaceSecondaryTexture,
                                                                                               MPSBinaryImageKernel.Block_encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator copyAllocator)
```
    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.
    Attempt to apply a MPSKernel to a texture in place.
    
    Parameters:
    
    commandBuffer - A valid MTLCommandBuffer to receive the encoded filter
    
    primaryTexture - A pointer to a valid MTLTexture containing the primary source image. It will not be overwritten.
    
    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.
    
    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.
    
    Returns:
    
    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.
  - encodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture
```
public void encodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture(MTLCommandBuffer commandBuffer,
                                                                                  MTLTexture primaryTexture,
                                                                                  MTLTexture secondaryTexture,
                                                                                  MTLTexture destinationTexture)
```
    Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place.
    
    Parameters:
    
    commandBuffer - A valid MTLCommandBuffer to receive the encoded filter
    
    primaryTexture - A valid MTLTexture containing the primary source image.
    
    secondaryTexture - A valid MTLTexture containing the secondary source image.
    
    destinationTexture - A valid MTLTexture to be overwritten by result image. destinationTexture may not alias the source textures.
  - init
```
public MPSBinaryImageKernel init()
```
    Overrides:
    
    init in class MPSKernel
  - initWithDevice
```
public MPSBinaryImageKernel initWithDevice(java.lang.Object device)
```
    Standard init with default properties per filter type
    
    Overrides:
    
    initWithDevice in class MPSKernel
    
    Parameters:
    
    device - The device that the filter will be used on. May not be NULL.
    
    Returns:
    
    a pointer to the newly initialized object. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.
  - primaryEdgeMode
```
public long primaryEdgeMode()
```
    [@property] primaryEdgeMode
    The MPSImageEdgeMode to use when texture reads stray off the edge of the primary source image
    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
  - primaryOffset
```
public MPSOffset primaryOffset()
```
    [@property] primaryOffset
    The position of the destination clip rectangle origin relative to the primary source buffer.
    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
  - primarySourceRegionForDestinationSize
```
public MPSRegion primarySourceRegionForDestinationSize(MTLSize destinationSize)
```
    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.
    Determine the region of the source texture that will be read for a encode operation
    
    Parameters:
    
    destinationSize - The size of the full virtual destination image.
    
    Returns:
    
    The area in the virtual source image that will be read.
  - secondaryEdgeMode
```
public long secondaryEdgeMode()
```
    [@property] secondaryEdgeMode
    The MPSImageEdgeMode to use when texture reads stray off the edge of the secondary source image
    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
  - secondaryOffset
```
public MPSOffset secondaryOffset()
```
    [@property] secondaryOffset
    The position of the destination clip rectangle origin relative to the secondary source buffer.
    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
  - secondarySourceRegionForDestinationSize
```
public MPSRegion secondarySourceRegionForDestinationSize(MTLSize destinationSize)
```
    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.
    Determine the region of the source texture that will be read for a encode operation
    
    Parameters:
    
    destinationSize - The size of the full virtual destination image.
    
    Returns:
    
    The area in the virtual source image that will be read.
  - setClipRect
```
public void setClipRect(MTLRegion value)
```
    [@property] clipRect
    An optional clip rectangle to use when writing data. Only the pixels in the rectangle will be overwritten.
    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
  - setPrimaryEdgeMode
```
public void setPrimaryEdgeMode(long value)
```
    [@property] primaryEdgeMode
    The MPSImageEdgeMode to use when texture reads stray off the edge of the primary source image
    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
  - setPrimaryOffset
```
public void setPrimaryOffset(MPSOffset value)
```
    [@property] primaryOffset
    The position of the destination clip rectangle origin relative to the primary source buffer.
    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
  - setSecondaryEdgeMode
```
public void setSecondaryEdgeMode(long value)
```
    [@property] secondaryEdgeMode
    The MPSImageEdgeMode to use when texture reads stray off the edge of the secondary source image
    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
  - setSecondaryOffset
```
public void setSecondaryOffset(MPSOffset value)
```
    [@property] secondaryOffset
    The position of the destination clip rectangle origin relative to the secondary source buffer.
    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
  - encodeToCommandBufferPrimaryImageSecondaryImageDestinationImage
```
public void encodeToCommandBufferPrimaryImageSecondaryImageDestinationImage(MTLCommandBuffer commandBuffer,
                                                                            MPSImage primaryImage,
                                                                            MPSImage secondaryImage,
                                                                            MPSImage destinationImage)
```
    Encode a MPSKernel into a command Buffer. The operation shall proceed out-of-place.
    
    Parameters:
    
    commandBuffer - A valid MTLCommandBuffer to receive the encoded filter
    
    primaryImage - A valid MPSImage containing the primary source image.
    
    secondaryImage - A valid MPSImage containing the secondary source image.
    
    destinationImage - A valid MPSImage to be overwritten by result image. destinationImage may not alias the source images.
  - initWithCoder
```
public MPSBinaryImageKernel initWithCoder(NSCoder aDecoder)
```
    Description copied from interface: NSCoding
    
    NS_DESIGNATED_INITIALIZER
    
    Specified by:
    
    initWithCoder in interface NSCoding
    
    Overrides:
    
    initWithCoder in class MPSKernel
  - initWithCoderDevice
```
public MPSBinaryImageKernel initWithCoderDevice(NSCoder aDecoder,
                                                java.lang.Object device)
```
    NSSecureCoding compatability
    While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.
    
    Overrides:
    
    initWithCoderDevice in class MPSKernel
    
    Parameters:
    
    aDecoder - The NSCoder subclass with your serialized MPSKernel
    
    device - The MTLDevice on which to make the MPSKernel
    
    Returns:
    
    A new MPSKernel object, or nil if failure.
  - supportsSecureCoding
```
public static boolean supportsSecureCoding()
```
  - _supportsSecureCoding
```
public boolean _supportsSecureCoding()
```
    Description copied from interface: NSSecureCoding
    
    This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
    
    Specified by:
    
    _supportsSecureCoding in interface NSSecureCoding
    
    Overrides:
    
    _supportsSecureCoding in class MPSKernel

Class MPSBinaryImageKernel

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.metalperformanceshaders.MPSKernel

Methods inherited from class apple.NSObject

Methods inherited from class org.moe.natj.objc.ObjCObject

Methods inherited from class org.moe.natj.general.NativeObject

Methods inherited from class java.lang.Object

Constructor Detail

MPSBinaryImageKernel

Method Detail

accessInstanceVariablesDirectly

alloc

allocWithZone

automaticallyNotifiesObserversForKey

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

debugDescription_static

description_static

hash_static

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

new_objc

resolveClassMethod

resolveInstanceMethod

setVersion_static

superclass_static

version_static

clipRect

encodeToCommandBufferInPlacePrimaryTextureSecondaryTextureFallbackCopyAllocator

encodeToCommandBufferPrimaryTextureInPlaceSecondaryTextureFallbackCopyAllocator

encodeToCommandBufferPrimaryTextureSecondaryTextureDestinationTexture

init

initWithDevice

primaryEdgeMode

primaryOffset

primarySourceRegionForDestinationSize

secondaryEdgeMode

secondaryOffset

secondarySourceRegionForDestinationSize

setClipRect

setPrimaryEdgeMode

setPrimaryOffset

setSecondaryEdgeMode

setSecondaryOffset

encodeToCommandBufferPrimaryImageSecondaryImageDestinationImage

initWithCoder

initWithCoderDevice

supportsSecureCoding

_supportsSecureCoding