Classes

A GradientView shows a linear gradient from its top to its bottom.

The CropAspect class is used to specify the available crop aspect ratios for the TransformToolController.

The default FrameToolControllerOptionsBuilder for FrameToolControllerOptions.

Options for configuring a FrameToolController.

A CropHandleView represents the interactive, draggable part of a crop rect.

The default StickerOptionsToolControllerOptionsBuilder for StickerOptionsToolControllerOptions.

Options for configuring a StickerOptionsToolController.

A SeparatorCollectionViewCell is a cell that shows a single 1 pt wide vertical line. It is usually used to represent a seperator between other cells.

The HandleButton is used in the TextFontToolController to expand the FontSelectorView. It is a standard Button that uses its tintColor as its backgroundColor.

A TextFontToolController is responsible for displaying the UI to adjust the font of text that has been added to an image.

The default logger provided by the SDK. It will log into the xcode console.

This class represents a group of the images.

The configuration for the build engine.

A framebuilder for custom patches. Each patch consists of four groups. There are two basic layouts. The first one places the top and bottom group above the full width of the image, and the left and right group in between. The second layout works the other way around.

A FocusToolController is reponsible for displaying the UI to adjust the focus of an image.

The CanvasView is responsible for presenting a painting and handling touch events related to paintings.

This filter adds or takes away clarity of an image.

The PhotoEffect class describes an effect that can be applied to a photo.

A ModeCollectionViewCell is a cell that displays a label within a frame

A sticker category data source provides the sticker categories that should be displayed in the sticker tool.

A LabelBorderedCollectionViewCell is a cell that shows a border around the cell and a label in its center.

An SpriteController manages all sprites that have been added to an image and hosts the sprite’s container view.

The CameraViewController class provides a dialog to perform serveral tasks regarding the camera. These include taking photos, switching on the flash, and such.

A ColorCollectionViewCell is a cell that shows a solid color and an image view on top of that color when the cell is selected. It also has a selectionIndicator to show whether or not the cell is currently selected.

This class represents a gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

AnimationDelegate can be used as the delegate of a CAAnimation to easily specify a completion block.

Applies a linear focus to an instance of CIImage.

Options for configuring a TextOptionsToolController.

The default TextOptionsToolControllerOptionsBuilder for TextOptionsToolControllerOptions.

Applies a radial focus to an instance of CIImage.

An OverlayButton is used inside the workspaceView of a StackLayoutToolController. It is a regular button with a translucent black background.

A CropMaskView is a view that blurs the content behind it.

Options for configuring a ColorToolController.

The default ColorToolControllerOptionsBuilder for ColorToolControllerOptions.

A BrushColorToolController is reponsible for displaying the UI to adjust the color of the brush that will be drawn on the image.

A StampGenerator is responsible for generating a stamp image that is used by a brush to draw a stroke.

A StackLayoutToolController presents a workspace view at the top and an accessory view at the bottom. The accessory view is usually used for the menu, while the workspace view hosts any other controls.

Options for configuring a PhotoEditToolController.

The default ToolControllerOptionsBuilder for ToolControllerOptions.

A SliderTooltip object is a visual element that displays a Slider’s current value above the thumb image while dragging.

Options for configuring an AdjustToolController.

The default AdjustToolControllerOptionsBuilder for AdjustToolControllerOptions.

Options for configuring a StickerToolController.

The default StickerToolControllerOptionsBuilder for StickerToolControllerOptions.

A TransformToolController is reponsible for displaying the UI to transform an image.

A FrameImageView is currently just a dummy class. Its purpose is to find out if we are dealing with the frame view during serialization.

A _ObjCMenuItem wraps a MenuItem so that it can be used from Objective-C. Please see the documentation of MenuItem for more details.

This class provides the methods to generate the dynamic frame-builders provided by the SDK.

Options for configuring a FocusToolController.

The default FocusToolControllerOptionsBuilder for FocusToolControllerOptions.

This class represents a circle gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

The default CameraViewControllerOptionsBuilder for CameraViewControllerOptions.

Options for configuring a CameraViewController.

An ActivityBorderedCollectionViewCell is a cell that shows a border around the cell and an activity indicator in its center.

A TextToolController is reponsible for displaying the UI to add text to an image.

A concrete implementation of AnalyticsClient that dispatches events to all registered clients on a background queue.

A _ObjCPhotoEditModel holds information about any modification that should be applied to an image. The actual PhotoEditModel is a struct and not exposable to Objective-C. This class boxes the actual PhotoEditModel for Objective-C compatibility.

A Brush holds all information needed to render a stroke.

A FreehandTool is responsible for creating vertices for a freehand drawing.

A FilterCollectionViewCell is a cell that shows an image (usually with a filter applied to it) and a label at the bottom. When selected the cell has an overlay, a label for the intensity and an selection indicator.

A Button is a subclass of UIButton, which supports running a closure for a given control event and has the ability to specify a touch area inset.

The default BrushToolControllerOptionsBuilder for BrushToolControllerOptions.

Options for configuring an BrushToolController.

A ProgressView is an activity indicator that is shown on top of all other views in a HUD style and temporarily blocks all user interaction with other views.

An Overlay represents a unique overlay that can be added to a photo.

A BrushToolController is reponsible for displaying the UI to draw a painting on top of an image.

A VideoRecordButton is a button that can be used to start a video recording. It animates between a ‘Start recording’ and a ‘Stop recording’ state.

The CropAndStraightenView class provides support for displaying, zooming, rotating and cropping an image.

A PhotoEditRenderer takes a CIImage and a PhotoEditModel as input and takes care of applying all necessary effects and filters to the image. The output image can then be rendered into an EAGLContext or converted into a CGImage instance.

Options for configuring a OverlayToolController.

The default OverlayToolControllerOptionsBuilder for OverlayToolControllerOptions.

Options for configuring a TextFontToolController.

The default TextFontToolControllerOptionsBuilder for TextFontToolControllerOptions.

A RoundGenerator generates a round stamp image with a given hardness.

The ColorPickerView provides a way to pick colors. It contains three elements - a hue picker, a brightness and saturation picker and an alpha picker. It has full support for wide colors.

A TouchingGestureRecognizer is a simple UIGestureRecognizer subclass that counts the number of touches on the associated view.

A TextLabel is used to show text that has been added to an image and provides improved support for accessibility.

A StickerColorToolController is responsible for displaying the UI to adjust the color of a sticker that has been added to an image.

A StickerToolController is reponsible for displaying the UI to add stickers to an image.

The MasterLogger manages and deploys loggers. That means it holds all instances of loggers, and delegates incoming log messages to each of them. Also it takes case of threading, to keep logging efficient. More loggers can be added using the add method. All child loggers must implement the LoggerProtocol.

An StickerOptionsToolController is reponsible for displaying the UI to edit a sticker.

Options for configuring a PhotoEditViewController.

The default PhotoEditViewControllerOptionsBuilder for PhotoEditViewControllerOptions.

A TextColorToolController is reponsible for displaying the UI to adjust the text color of text that has been added to an image.

Provides functions to import fonts added as resources. It also registers them, so that the application can load them like any other pre-installed font.

A ModeSelectionView is a subclass of UICollectionView configured to be used as the menu of a tool controller.

A sticker data source provides the stickers that should be displayed in the sticker tool.

A LabelCaptionCollectionViewCell is a cell that displays two labels, one at the top and one at the bottom.

A Toolbar is used inside a ToolbarController to display ToolbarItems.

An IconBorderedCollectionViewCell is a cell that shows a border around the cell and an image in its center.

A ScalePicker provides an UI element to pick values.

A StickerImageView displays an instance of Sticker and provides improved support for accessibility.

A PhotoEffectThumbnailRenderer can be used to generate thumbnails of a given input image for multiple photo effects.

Options for configuring a TextToolController.

The default TextToolControllerOptionsBuilder for TextToolControllerOptions.

A FrameToolController is reponsible for displaying the UI to add a frame to an image.

This class represents a rectangle gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

A LicenseModel represents all properties of a license.

Options for configuring a TransformToolController.

The default TransformToolControllerOptionsBuilder for TransformToolControllerOptions.

A Texture manages an OpenGL texture. It is responsible for allocating and deallocting the necessary memory.

This class provides tools to create and manipulate color matrices. These can be passed into a CIKernel.

The CameraController class provides functions for serveral camera related tasks, including setup, flash control, and such.

An AdjustToolController is reponsible for displaying the UI to adjust the brightness, contrast and saturation of an image.

Applies clarity to an instance of CIImage.

Options for configuring a TextColorToolController.

The default TextColorToolControllerOptionsBuilder for TextColorToolControllerOptions.

A TooltipSlider object is a visual control used to select a single value from a continuous range of values. Sliders are always displayed as horizontal bars. An indicator, or thumb, notes the current value of the slider and can be moved by the user to change the setting. A vertical indicator, or neutral point, notes the default, unchanged value of the slider. Additionally a TooltipSlider also presents a tooltip above the thumb image that displays the current selected value while dragging.

A PhotoEditViewController is responsible for presenting and rendering an edited image.

This filter is used to colorize stickers.

A ToolbarController is the container view controller for a PhotoEditViewController and its associated tool controllers. It usually displays a toolbar at bottom and has methods to transition between various tools. If it is embedded inside a UINavigationController it uses the navigation controllers navigation bar instead of its own toolbar at the bottom.

A Frame represents a unique frame, which can have multiple images for different aspect ratios. The matching image for the current aspect ratio will be used automatically. Each frame neeeds at least one image and one thumbnail image. If no thumbnail is provide, it is automatically generated.

A FilterToolController is reponsible for displaying the UI to apply an effect filter to an image.

A TextOptionsToolController is reponsible for displaying the UI to adjust text that has been added to an image.

An icon generator can be used to generate various icons.

A ToolbarItem hosts views which are displayed in the toolbar of a ToolbarController. If the toolbar controller is embedded into an UINavigationController, those views are added to the navigation controller’s navigation bar.

A DefaultToolbarItem is a toolbar item with a label in the center and a default discard button on the left and apply button on the right. It is used in most tool controllers.

This filter adds or takes away clarity of an image.

A Painting manages the shaders, textures, vertices and framebuffers involved in a single painting.

Used to determine device orientation even if orientation lock is active.

A PhotoEditToolController is the base class for any tool controllers. Subclass this class if you want to add additional tools to the editor.

A ToolbarButton should be used within an instance of Toolbar. It automatically styles itself to display touch events.

A view that extends the default UIView by passthrough views.

A FilterSelectionController contains everything that is needed to display a list of available filters.

An IconCaptionCollectionViewCell is a cell that shows an icon and a label.

A MenuCollectionView is a subclass of UICollectionView configured to be used as the menu of a tool controller.

A TextButton is used within a FontSelectorView to present different fonts and their names.

A LabelIconBorderedCollectionViewCell extends a LabelBorderedCollectionViewCell by an image view that displays an icon instead of the label when required.

A Tool is an abstract base class. Currently FreehandTool is the only concrete subclass and it is used to handle touch events and draw primitives.

A ColorToolController is reponsible for displaying the UI to adjust the color of an element that has been added to an image.

A StickerCategory represents one category of stickers. Each category has a preview image and multiple stickers associated with it. To support accessibility you should also set its accessibilityLabel.

UndoController is a general-purpose recorder of operations for undo and redo.

A Sticker represents a single sticker in a sticker category. Each sticker needs an image and a thumbnail image. If no thumbnail is provided, it is automatically generated.

The CropOverlayView is added above the CropAndStraightenView to display the UI elements to adjust the crop rect and hosts the mask views to dim the content that is outside the crop rect.

This class provides our own implementation of adjustment filters. Using these we get more consistant results across the several platforms.

A StickerCollectionViewCell is a cell that has an image view and an activity indicator in its center.

A Slider object is a visual control used to select a single value from a continuous range of values. Sliders are always displayed as horizontal bars. An indicator, or thumb, notes the current value of the slider and can be moved by the user to change the setting. A vertical indicator, or neutral point, notes the default, unchanged value of the slider.

A BorderedCollectionViewCell is a cell that shows a border around the cell.

A OverlayToolController is reponsible for displaying the UI to apply a overlay to an image.

The FontSelectorView is a subclass of UIScrollView that presents a scrollable list of fonts.

An Configuration defines behaviour and look of all view controllers provided by the PhotoEditorSDK. It uses the builder pattern to create an immutable object via a closure. To configure the different editors and viewControllers contained in the SDK, edit their options in the corresponding configure*ViewController method of the ConfigurationBuilder.

The configuration builder object offers all properties of Configuration in a mutable version, in order to build an immutable Configuration object. To further configure the different viewcontrollers, use the configureXYZViewController methods to edit the given options.

A frame data source provides the frames that should be displayed in the frame tool.

A Font represents meta information about a font, that should be loaded into the SDK. If a font has a long name, the displayName can be used to substitude it within the UI. The font name is used by iOS to identify the font. This is usualy the filename of the font. But it can be different. To be sure use the font in a sandbox project, and get its ‘fontName’ attribute.

Options for configuring a FilterToolController.

The default FilterToolControllerOptionsBuilder for FilterToolControllerOptions.

A OverlayelectionController contains everything that is needed to display a list of available filters.

A FrameImageView is currently just a dummy class. Its purpose is to find out if we are dealing with the frame view during serialization.

This class is out to provide an easy service to get images, either from a local or remote source.