GDImage

public class GDImage

Show on GitHub

FlipMode
See more
Declaration
Swift

public enum FlipMode
Show on GitHub
internalImage
Declaration
Swift

var internalImage: gdImagePtr!
Show on GitHub
size
Declaration
Swift

public var size: Size { get }
Show on GitHub


                    
                    
                    transparent

Declaration

Swift

public var transparent: Bool { get set }

Show on GitHub

ImageType
See more
Declaration
Swift

public enum ImageType
Show on GitHub


                    
                    
                    init(width:height:type:)

Declaration

Swift

public init?(width: Int, height: Int, type: ImageType = .truecolor)

Show on GitHub

init(gdImage:)
Declaration
Swift

public init(gdImage: gdImagePtr)
Show on GitHub


                    
                    
                    resizedTo(width:height:applySmoothing:)

Declaration

Swift

public func resizedTo(width: Int, height: Int, applySmoothing: Bool = true) -> GDImage?

Show on GitHub


                    
                    
                    resizedTo(width:applySmoothing:)

Declaration

Swift

public func resizedTo(width: Int, applySmoothing: Bool = true) -> GDImage?

Show on GitHub


                    
                    
                    resizedTo(height:applySmoothing:)

Declaration

Swift

public func resizedTo(height: Int, applySmoothing: Bool = true) -> GDImage?

Show on GitHub


                    
                    
                    cropped(to:)

Declaration

Swift

public func cropped(to rect: Rectangle) -> GDImage?

Show on GitHub


                    
                    
                    applyInterpolation(enabled:currentSize:newSize:)

Declaration

Swift

public func applyInterpolation(enabled: Bool, currentSize: Size, newSize: Size)

Show on GitHub


                    
                    
                    renderText(_:from:fontList:color:size:angle:)

Renders an UTF-8 string onto the image.

The text will be rendered from the specified basepoint:

let basepoint = Point(x: 20, y: 200) image.renderText( “SwiftGD”, from: basepoint, fontList: [“SFCompact”], color: .red, size: 100, angle: .degrees(90) )

Declaration

Swift

@discardableResult
public func renderText(
	_ text: String,
	from: Point,
	fontList: [String],
	color: Color,
	size: Double,
	angle: Angle = .zero
) -> (upperLeft: Point, upperRight: Point, lowerRight: Point, lowerLeft: Point)

Parameters

`text`	The string to render.
`from`	The basepoint (roughly the lower left corner) of the first letter.
`fontList`	A list of font filenames to look for. The first match will be used.
`color`	The font color.
`size`	The height of the font in typographical points (pt).
`angle`	The angle to rotate the rendered text from the basepoint perspective. Positive angles rotate clockwise.

Return Value

The rendered text bounding box. You can use this output to render the text off-image first, and then render it again, on the image, with the bounding box information (e.g., to center-align the text).

Show on GitHub


                    
                    
                    fill(from:color:)

Declaration

Swift

public func fill(from: Point, color: Color)

Show on GitHub


                    
                    
                    drawLine(from:to:color:)

Declaration

Swift

public func drawLine(from: Point, to: Point, color: Color)

Show on GitHub


                    
                    
                    set(pixel:to:)

Declaration

Swift

public func set(pixel: Point, to color: Color)

Show on GitHub

get(pixel:)
Declaration
Swift

public func get(pixel: Point) -> Color
Show on GitHub


                    
                    
                    strokeEllipse(center:size:color:)

Declaration

Swift

public func strokeEllipse(center: Point, size: Size, color: Color)

Show on GitHub


                    
                    
                    fillEllipse(center:size:color:)

Declaration

Swift

public func fillEllipse(center: Point, size: Size, color: Color)

Show on GitHub


                    
                    
                    strokeRectangle(topLeft:bottomRight:color:)

Declaration

Swift

public func strokeRectangle(topLeft: Point, bottomRight: Point, color: Color)

Show on GitHub


                    
                    
                    fillRectangle(topLeft:bottomRight:color:)

Declaration

Swift

public func fillRectangle(topLeft: Point, bottomRight: Point, color: Color)

Show on GitHub

flip(_:)
Declaration
Swift

public func flip(_ mode: FlipMode)
Show on GitHub
pixelate(blockSize:)
Declaration
Swift

public func pixelate(blockSize: Int)
Show on GitHub
blur(radius:)
Declaration
Swift

public func blur(radius: Int)
Show on GitHub
colorize(using:)
Declaration
Swift

public func colorize(using color: Color)
Show on GitHub
desaturate()
Declaration
Swift

public func desaturate()
Show on GitHub


                    
                    
                    reduceColors(max:shouldDither:)

Reduces Image to an indexed palette of colors from larger color spaces. Index Images only make sense with 2 or more colors, and will throw nonsense values

Declaration

Swift

public func reduceColors(max numberOfColors: Int, shouldDither: Bool = true) throws

Parameters

`numberOfColors`	maximum number of colors
`shouldDither`	true will apply GD’s internal dithering algorithm

Show on GitHub

deinit
Declaration
Swift

deinit
Show on GitHub

Import & Export

init(url:)
Declaration
Swift

public convenience init?(url: URL)
Show on GitHub


                    
                    
                    write(to:quality:allowOverwrite:)

Declaration

Swift

@discardableResult
public func write(to url: URL, quality: Int = 100, allowOverwrite: Bool = false) -> Bool

Show on GitHub


                    
                    
                    init(data:as:)

Initializes a new Image instance from given image data in specified raster format. If DefaultImportableRasterFormat is omitted, all supported raster formats will be evaluated.

Throws

GDError if data in rasterFormat could not be converted

Declaration

Swift

public convenience init(data: Data, as format: ImportableFormat = .any) throws

Parameters

`data`	The image data
`rasterFormat`	The raster format of image data (e.g. png, webp, …). Defaults to `.any`

Show on GitHub


                    
                    
                    export(as:)

Exports the image as Data object in specified raster format.

Throws

GDError if the export of self in specified raster format failed.

Declaration

Swift

public func export(as format: ExportableFormat = .png) throws -> Data

Parameters


                                format

The raster format of the returning image data (e.g. as jpg, png, …). Defaults to .png

Return Value

The image data

Show on GitHub