- Classes
- Namespaces
- Interfaces
- Traits
- Index

Interface

# Imagine\Image\ImagineInterface

interface ImagineInterface

The imagine interface

## Constants

VERSION |

## Methods

ImageInterface | create(BoxInterface $size, ColorInterface $color = null) Creates a new empty image with an optional background color |
ImageInterface | open(string $path) Opens an existing image from $path |
ImageInterface | load(string $string) Loads an image from a binary $string |
ImageInterface | read(resource $resource) Loads an image from a resource $resource |
FontInterface | font(string $file, integer $size, ColorInterface $color) Constructs a font with specified $file, $size and $color |

## Details

###
at line 36
`public ImageInterface create(BoxInterface $size, ColorInterface $color = null)`

Creates a new empty image with an optional background color

#### Parameters

BoxInterface | $size |
ColorInterface | $color |

#### Return Value

ImageInterface |

#### Exceptions

InvalidArgumentException |
RuntimeException |

###
at line 47
`public ImageInterface open(string $path)`

Opens an existing image from $path

#### Parameters

string | $path |

#### Return Value

ImageInterface |

#### Exceptions

RuntimeException |

###
at line 59
`public ImageInterface load(string $string)`

Loads an image from a binary $string

#### Parameters

string | $string |

#### Return Value

ImageInterface |

#### Exceptions

RuntimeException |

###
at line 70
`public ImageInterface read(resource $resource)`

Loads an image from a resource $resource

#### Parameters

resource | $resource |

#### Return Value

ImageInterface |

#### Exceptions

RuntimeException |

###
at line 83
`public FontInterface font(string $file, integer $size, ColorInterface $color)`

Constructs a font with specified $file, $size and $color

The font size is to be specified in points (e.g. 10pt means 10)

#### Parameters

string | $file |
integer | $size |
ColorInterface | $color |

#### Return Value

FontInterface |