apple.coreimage

Class CIKernel

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.coreimage.CIKernel

All Implemented Interfaces:

NSObject

Direct Known Subclasses:

CIColorKernel, CIWarpKernel

public class CIKernel
extends NSObject

CIKernel is an object that encapsulates a Core Image Kernel Language routine that generates a new images based on input images and agruments.

General kernel functions are declared akin to this example: kernel vec4 myColorKernel (sampler fore, sampler back, vec4 params)

The function must take a sampler argument for each input image. Additional arguments can be of type float, vec2, vec3, vec4, or __color. The destination pixel location is obtained by calling destCoord(). The kernel should call sample() with coordinates based on either samplerCoord() or samplerTransform() to read pixel values from input images. The function must return a vec4 pixel color.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CIKernel.Block_applyWithExtentRoiCallbackArguments

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CIKernel(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static CIKernel	alloc()
static CIKernel	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
CIImage	applyWithExtentRoiCallbackArguments(CGRect extent, CIKernel.Block_applyWithExtentRoiCallbackArguments callback, NSArray<?> args) Apply the receiver CIKernel to produce a new CIImage object.
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()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
CIKernel	init()
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 NSArray<java.lang.String>	kernelNamesFromMetalLibraryData(NSData data) This method will return an array of strings corresponding to names of all of the kernels contained within the underlying Metal library in the associated NSData.
static NSArray<? extends CIKernel>	kernelsWithMetalStringError(java.lang.String source, org.moe.natj.general.ptr.Ptr<NSError> error) The string argument should contain a program in the Metal Language.
static NSArray<? extends CIKernel>	kernelsWithString(java.lang.String string) The string argument should contain a program in the Core Image Kernel Language.
static CIKernel	kernelWithFunctionNameFromMetalLibraryDataError(java.lang.String name, NSData data, org.moe.natj.general.ptr.Ptr<NSError> error) The data argument should represent a metallib file compiled with the Core Image Standard Library and contain the given function written in the Metal Shading Language.
static CIKernel	kernelWithFunctionNameFromMetalLibraryDataOutputPixelFormatError(java.lang.String name, NSData data, int format, org.moe.natj.general.ptr.Ptr<NSError> error)
static CIKernel	kernelWithString(java.lang.String string) The string argument should contain a program with one kernel.
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
java.lang.String	name() The name of the kernel.
static CIKernel	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setROISelector(org.moe.natj.objc.SEL method) Sets the selector used by Core Image to ask what rectangles of a kernel's input images are needed to produce a desired rectangle of the kernel's output image.
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static long	version_static()

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

CIKernel

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static CIKernel alloc()

allocWithZone

public static CIKernel 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)

kernelWithString

public static CIKernel kernelWithString(java.lang.String string)

The string argument should contain a program with one kernel. On OSX 10.10 and before, this returns a CIKernel object. On OSX after 10.10, this returns a CIKernel, CIColorKernel, or CIWarpKernel object. On iOS this returns a CIKernel, CIColorKernel, or CIWarpKernel object.

kernelsWithString

public static NSArray<? extends CIKernel> kernelsWithString(java.lang.String string)

The string argument should contain a program in the Core Image Kernel Language. All the kernel functions in the program are converted to instances of a CIKernel objects and returned in an array. On OSX 10.10 and before, the array will contain instances of CIKernel class. On OSX after 10.10, the array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes. On iOS, the array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes.

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static CIKernel 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()

applyWithExtentRoiCallbackArguments

public CIImage applyWithExtentRoiCallbackArguments(CGRect extent,
                                                   CIKernel.Block_applyWithExtentRoiCallbackArguments callback,
                                                   NSArray<?> args)

Apply the receiver CIKernel to produce a new CIImage object.

The 'extent' is the bounding box of all non-clear pixels produced by the kernel.

The 'callback' is a block that should return the rectangle of each input image that is needed to produce a given rectangle in the coordinate space of the new image.

The 'args' is an array of parameters needed to describe the new image. The object types of the items in the array correspond to the argument types of the kernel function. For example, if the first argument in the kernel is a sampler, then the first object in the array must be a CIImage.

init

public CIKernel init()

Overrides:

init in class NSObject

name

public java.lang.String name()

The name of the kernel.

setROISelector

public void setROISelector(org.moe.natj.objc.SEL method)

Sets the selector used by Core Image to ask what rectangles of a kernel's input images are needed to produce a desired rectangle of the kernel's output image.

Using setROISelector: is suppoted but not recommended. The selector is only used if one the [CIFilter apply:...] methods is used. Instead, use one of the [CIKernel applyWithExtent:roiCallback:...] methods.

The method should have one of the following signatures: - (CGRect)regionOf:(int)samplerIndex destRect:(CGRect)r userInfo:obj; - (CGRect)regionOf:(int)samplerIndex destRect:(CGRect)r;

'samplerIndex' is the 0-based index specifying which of the kernel's input images is being queried. 'destRect' is the extent rectangle of kernel's output image being queried. 'userInfo' is the object associated with the kCIApplyOptionUserInfo when the kernel was applied.

The method should return the rectangle of the index'th input image that is needed to produce destRect. Returning CGRectNull indicates that the index'th input image is not needed to produce destRect.

kernelWithFunctionNameFromMetalLibraryDataError

public static CIKernel kernelWithFunctionNameFromMetalLibraryDataError(java.lang.String name,
                                                                       NSData data,
                                                                       org.moe.natj.general.ptr.Ptr<NSError> error)

The data argument should represent a metallib file compiled with the Core Image Standard Library and contain the given function written in the Metal Shading Language.

An optional output pixel format can be specified, and would be used if the output of the kernel needs to be written to an intermediate texture.

kernelWithFunctionNameFromMetalLibraryDataOutputPixelFormatError

public static CIKernel kernelWithFunctionNameFromMetalLibraryDataOutputPixelFormatError(java.lang.String name,
                                                                                        NSData data,
                                                                                        int format,
                                                                                        org.moe.natj.general.ptr.Ptr<NSError> error)

kernelNamesFromMetalLibraryData

public static NSArray<java.lang.String> kernelNamesFromMetalLibraryData(NSData data)

This method will return an array of strings corresponding to names of all of the kernels contained within the underlying Metal library in the associated NSData.

kernelsWithMetalStringError

public static NSArray<? extends CIKernel> kernelsWithMetalStringError(java.lang.String source,
                                                                      org.moe.natj.general.ptr.Ptr<NSError> error)

The string argument should contain a program in the Metal Language. All the kernel functions in the program are converted to instances of a CIKernel objects and returned in an array. The array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes. The kernels will only be usable on Metal-backed CIContext on a device that 'supportsDynamicLibraries'