CIVignetteEffect Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A filter that modifies the brightness of the outside of an image.
public class CIVignetteEffect : CoreImage.CIFilter, CoreImage.ICIVignetteEffectProtocol, IDisposabletype CIVignetteEffect = class
inherit CIFilter
interface ICIVignetteEffectProtocol
interface INativeObject
interface IDisposable
interface ICIFilterProtocol- Inheritance
- Implements
Remarks
The following example shows this filter in use
// Create the CIImage from a file
CIImage flower = CIImage.FromCGImage (UIImage.FromFile ("flower.png").CGImage);
// Create a CIVignetteEffect filter with the input image
var vignette_effect = new CIVignetteEffect()
{
Image = flower,
Center = new CIVector (flower.Extent.Width * .3f, flower.Extent.Width * .35f),
Intensity = .6f,
Radius = flower.Extent.Width * .20f,
};
// Get the altered image from the filter
var output = vignette_effect.OutputImage;
// To render the results, we need to create a context, and then
// use one of the context rendering APIs, in this case, we render the
// result into a CoreGraphics image, which is merely a useful representation
//
var context = CIContext.FromOptions (null);
var cgimage = context.CreateCGImage (output, output.Extent);
// The above cgimage can be added to a screen view, for example, this
// would add it to a UIImageView on the screen:
myImageView.Image = UIImage.FromImage (cgimage);
With the following image input:
Produces the following output:
"Flower" © 2012 Milica Sekulic, used under a Creative Commons Attribution-ShareAlike license: https://creativecommons.org/licenses/by-sa/3.0/
Constructors
| Name | Description |
|---|---|
| CIVignetteEffect() |
Creates a new CIVignetteEffect with default values. |
| CIVignetteEffect(NativeHandle) |
A constructor used when creating managed representations of unmanaged objects. Called by the runtime. |
| CIVignetteEffect(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| CIVignetteEffect(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
Properties
| Name | Description |
|---|---|
| AccessibilityAttributedUserInputLabels | (Inherited from NSObject) |
| AccessibilityRespondsToUserInteraction | (Inherited from NSObject) |
| AccessibilityTextualContext | (Inherited from NSObject) |
| AccessibilityUserInputLabels | (Inherited from NSObject) |
| Attributes |
Configurable attributes of the filter. (Inherited from CIFilter) |
| Class | (Inherited from NSObject) |
| ClassHandle |
The Objective-C class handle for this class. (Inherited from CIFilter) |
| DebugDescription | (Inherited from NSObject) |
| Description | (Inherited from NSObject) |
| ExposedBindings | (Inherited from NSObject) |
| Falloff |
The rate of decay of the effect. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| InputCenter |
Gets or sets the point about which the image will be vignetted. |
| InputImage |
Gets or sets an image to filter. |
| InputKeys |
Gets an array that contains the names of the input keys for the filter. (Inherited from CIFilter) |
| Intensity |
Gets or sets the intensity of the vignette. |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| Item[NSString] |
Gets the value that is identified by |
| Name |
Gets the filter name. (Inherited from CIFilter) |
| OutputImage | |
| OutputKeys |
Gets an array that contains the names of the output keys for the filter. (Inherited from CIFilter) |
| Radius |
Gets or sets the radius of the area that will not be obscured. |
| RetainCount | (Inherited from NSObject) |
| Self | (Inherited from NSObject) |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| Zone | (Inherited from NSObject) |