Skip to content

Latest commit

 

History

History
112 lines (89 loc) · 1.61 KB

README.md

File metadata and controls

112 lines (89 loc) · 1.61 KB

erl_gm

An Erlang GraphicsMagick wrapper

USAGE

% Crop image into 100x100 tiles
gm:convert("/some/image.jpg", "tile", [{crop, 100, 100}]).

% Get multiple identify properties (returns a list of key value pairs
% to be parsed by proplist:get_value
gm:identify_explicit("/some/image.jpg", [width, height, filename, type]).

% Crazytown
gm:convert("/some/image.jpg", "/something/crazy.jpg", [
  flip,
  magnify,
  {rotate, 45},
  {blur, 7, 3},
  {crop, 300, 300, 150, 130},
  {edge, 3}
]).

% Resize
gm:convert("/some/image.jpg", "/something/resized.jpg", [{resize, 240, 240}]).

ELIXIR INSTALLATION

Add erl_gm to your mix.exs dependencies:

def deps do
  [{:gm, git: "https://github.com/nuex/erl_gm"}]
end

List the :gm application as your application dependency (from Elixir version 1.4.0 may not be necessary)

def application do
  [applications: [:gm]]
end

ELIXIR USAGE

iex> :gm.convert('/some/image.jpg', '/some/cropped.jpg', [{:crop, 100, 100}])

AVAILABLE GM FUNCTIONS

gm:composite
gm:convert
gm:identify
gm:mogrify
gm:montage
gm:version

AVAILABLE GM OPTIONS

-adjoin
-background
-blur
-create_directories
-crop
-define
-dissolve
-draw
-edge
-extent
-flatten
-fill
-flip
-format
-geometry
-gravity
-interlace
-magnify
+matte
-matte
-negate
-opaque
-output_directory
-quality
-resize
-rotate
-size
-transparent
-thumbnail
-type
-watermark

AVAILABLE SHORTCUTS

gm:identify_explicit

EXTENDING

New options can be added to gm_options.erl to broaden option support. Just open a pull request and I'll merge in additions.

LICENSE

MIT