Nuke Documentation Beta

Classes

Data​Cache

Data cache backed by a local storage.

Data​Loader

Provides basic networking using URLSession.

Image​Cache

Memory cache with LRU cleanup policy (least recently used are removed first).

Image​Decoders.​Default

The default decoder which supports all of the formats natively supported by the system.

Image​Decoder​Registry

A register of image codecs (only decoding).

Image​Pipeline

ImagePipeline loads and decodes image data, processes loaded images and stores them in caches.

Image​Preheater

Prefetches and caches image to eliminate delays when requesting the same images later.

Image​Task

A task performed by the ImagePipeline. The pipeline maintains a strong reference to the task until the request finishes or fails; you do not need to maintain a reference to the task unless it is useful to do so for your app’s internal bookkeeping purposes.

Image​Response

Represents a response of a particular image task.

Structures

Image​Decoders.​Empty

A decoder which returns an empty placeholder image and attaches image data to the image container.

Image​Decoding​Context

Image decoding context used when selecting which decoder to use.

Image​Type

A uniform type identifier (UTI).

Image​Encoding​Context

Image encoding context used when selecting which encoder to use.

Image​Encoders.​Default

A default adaptive encoder which uses best encoder available depending on the input image and its configuration.

Image​Encoders.​Image​IO

An Image I/O based encoder.

Image​Pipeline.​Configuration
Image​Pipeline.​Configuration.​Data​Cache​Options
Image​Processing​Context

Image processing context used when selecting which processor to use.

Image​Processors.​Resize

Scales an image to a specified size.

Image​Processors.​Circle

Rounds the corners of an image into a circle. If the image is not a square, crops it to a square first.

Image​Processors.​Rounded​Corners

Rounds the corners of an image to the specified radius.

Image​Processors.​Core​Image​Filter

Applies Core Image filter (CIFilter) to the image.

Image​Processors.​Gaussian​Blur

Blurs an image using CIGaussianBlur filter.

Image​Processors.​Composition

Composes multiple processors.

Image​Processors.​Anonymous

Processed an image using a specified closure.

Image​Processing​Options.​Border

Draws a border.

Image​Request

Represents an image request.

Image​Request​Options
Image​Request​Options.​Memory​Cache​Options

The policy to use when reading or writing images to the memory cache.

Image​Container
Image​Loading​Options

A range of options that control how the image is loaded and displayed.

Image​Loading​Options.​Content​Modes

Custom content modes to be used for each image type (placeholder, success, failure).

Image​Loading​Options.​Transition

An animated image transition.

Image​Loading​Options.​Transition

An animated image transition.

Enumerations

Data​Loader.​Error

Errors produced by DataLoader.

Data​Task​Event
Image​Decoders
Image​Encoders
Image​Pipeline.​Error

Represents all possible image pipeline errors.

Image​Pipeline.​Data​Cache​Item
Image​Task​Event
Image​Preheater.​Destination

Prefetching destination.

Image​Processors

A namespace for all processors that implement ImageProcessing protocol.

Image​Processors.​Resize.​Content​Mode

An option for how to resize the image.

Image​Processing​Options
Image​Processing​Options.​Unit
Image​Request.​Priority

The execution priority of the request. The priority affects the order in which the image requests are executed.

Protocols

Data​Caching

Data cache.

Cancellable
Data​Loading
Data​Loader​Observing

Allows you to tap into internal events of the data loader. Events are delivered on the internal serial operation queue.

Image​Caching

In-memory image cache.

Image​Decoding

An image decoder.

Image​Decoder​Registering

An image decoder which supports automatically registering in the decoder register.

Image​Encoding
Image​Pipeline​Observing

Allows you to tap into internal events of the image pipeline. Events are delivered on the internal serial dispatch queue.

Image​Processing

Performs image processing.

Nuke_Image​Displaying

Displays images. Add the conformance to this protocol to your views to make them compatible with Nuke image loading extensions.

Typealiases

Image
Image​Processor
Image​Decoder
Image​Encoder
Platform​Image

Alias for UIImage.

Platform​Image

Alias for NSImage.

Image​Displaying​View

A UIView that implements ImageDisplaying protocol.

Image​Displaying​View

An NSView that implements ImageDisplaying protocol.

Image​Displaying​View

An NSView that implements ImageDisplaying protocol.

Functions

load​Image(with:​options:​into:​progress:​completion:​)

Loads an image with the given URL and displays it in the view.

load​Image(with:​options:​into:​progress:​completion:​)

Loads an image with the given request and displays it in the view.

cancel​Request(for:​)

Cancels an outstanding request associated with the view.