Instance Method


Sets the selector Core Image uses to query the region of interest for image processing with the kernel.


func setROISelector(_ method: Selector)



A selector name.


When applying a filter kernel, the region of interest (ROI) is the area of source image pixels that must be processed to produce a given area of destination image pixels. For a more detailed definition, see The Region of Interest.

The aMethod argument must use the signature that is defined for the regionOf:destRect:userInfo: method, which is as follows:

- (CGRect) regionOf:(int)samplerIndex destRect:(CGRect)r userInfo:obj;


  • samplerIndex defines the sampler to query

  • destRect is the extent of the region, in working space coordinates, to render.

  • userInfo is the object associated with the kCIApplyOptionUserInfo option when the kernel is applied to its arguments (with the apply(_:arguments:options:) method of a CIFilter object using the kernel). The userInfo is important because instance variables can’t be used by the defining class. Instance variables must be passed through the userInfo argument.

The regionOf:destRect:userInfo: method of the CIFilter object is called by the framework. This method returns the rectangle that contains the region of the sampler that the kernel needs to render the specified destination rectangle.

A sample regionOf:destRect:userInfo: method might look as follows:

- (CGRect)regionOf:(int)sampler destRect:(CGRect)r userInfo:params
  float scale = fabs ([params X]);
  return CGRectInset (r, scale * -1.3333, scale * -1.3333);

If your kernel does not need the image at index to produce output in the rectangle rect, your method should return null.

In the filter code, you set the selector using the following:

[kernel setROISelector:@selector(regionOf:destRect:userInfo:)]

Alternatively, use the apply(extent:roiCallback:arguments:) method to directly apply a kernel to create an output image, specifying the ROI callback as a block or closure.

See Also

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software