Skip to content

Commit

Permalink
Merge pull request #665 from okor/master
Browse files Browse the repository at this point in the history
add focal point docs
  • Loading branch information
guilhermef committed Feb 15, 2016
2 parents 6a1671b + 6887d77 commit bed348a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Filters
equalize
extract_focal_points
filling
focal
format
grayscale
max_bytes
Expand Down
41 changes: 41 additions & 0 deletions docs/focal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Focal
=====

Usage: focal(<left>x<top>:<right>x<bottom>)

Description
-----------

This filter adds a focal point, which is used in later transforms.

Arguments
---------

- left, top, right, bottom: All mandatory arguments in the ``<left>x<top>:<right>x<bottom>`` format.

Example
-------

``http://localhost:8888/unsafe/400x100/filters:focal(146x156:279x208)/http://i.imgur.com/cldZwwc.jpg``

Before

.. image:: ../tests/fixtures/filters/source.jpg
:alt: Picture after the RGB filter

After

.. image:: ../tests/fixtures/filters/focal.jpg
:alt: Picture after the RGB filter

Warning
-------

Unpredictable behavior may occur if using this filter with other functionality that set focal points, such as:

.. toctree::
:maxdepth: 1

extract_focal_points
available_detectors
metadata

0 comments on commit bed348a

Please sign in to comment.