User's Guide
Reference Manual
Release Notes
PDF
Top

Percept
Reference Manual
Version 0.8.4

Expand All
Contract All

Table of Contents

- egd
  - Top of manual page
  - color/1
  - create/2
  - destroy/1
  - filledEllipse/4
  - filledRectangle/4
  - line/4
  - rectangle/4
  - render/1
  - render/2
  - render/3
  - save/2
  - text/5
- percept
  - Top of manual page
  - analyze/1
  - profile/1
  - profile/2
  - profile/3
  - start_webserver/0
  - start_webserver/1
  - stop_profile/0
  - stop_webserver/0
- percept_profile
  - Top of manual page
  - start/1
  - start/2
  - start/3
  - stop/0

# egd

### MODULE

egd

### MODULE SUMMARY

egd - erlang graphical drawer.

### DESCRIPTION

egd - erlang graphical drawer

### DATA TYPES

color()
egd_image()
point() = {integer(), integer()}
render_option() = {render_engine, opaque} | {render_engine, alpha}

### EXPORTS

color(Color::Value | Name) -> color()

Types:

Value = {byte(), byte(), byte()} | {byte(), byte(), byte(), byte()}
Name = black | silver | gray | white | maroon | red | purple | fuchia | green | lime | olive | yellow | navy | blue | teal | aqua

Creates a color reference.

create(Width::integer(), Height::integer()) -> egd_image()

Creates an image area and returns its reference.

destroy(Image::egd_image()) -> ok

Destroys the image.

filledEllipse(Image::egd_image(), P1::point(), P2::point(), Color::color()) -> ok

Creates a filled ellipse object.

filledRectangle(Image::egd_image(), P1::point(), P2::point(), Color::color()) -> ok

Creates a filled rectangle object.

line(Image::egd_image(), P1::point(), P2::point(), Color::color()) -> ok

Creates a line object from P1 to P2 in the image.

rectangle(Image::egd_image(), P1::point(), P2::point(), Color::color()) -> ok

Creates a rectangle object.

render(Image::egd_image()) -> binary()

Equivalent to render(Image, png, [{render_engine, opaque}]).

render(Image::egd_image(), Type::png | raw_bitmap) -> binary()

Equivalent to render(Image, Type, [{render_engine, opaque}]).

render(Image::egd_image(), Type::png | raw_bitmap, Options::[render_option()]) -> binary()

Renders a binary from the primitives specified by egd_image(). The binary can either be a raw bitmap with rgb tripplets or a binary in png format.

save(Binary::binary(), Filename::string()) -> ok

Saves the binary to file.

text(Image::egd_image(), P::point(), Font::font(), Text::string(), Color::color()) -> ok

Creates a text object.