You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
128 lines
3.7 KiB
128 lines
3.7 KiB
save_png |
|
======== |
|
|
|
Saves the given range of cards to a PNG |
|
|
|
Options |
|
------- |
|
|
|
dir |
|
default: ``'_output'`` |
|
|
|
the directory for the output to be sent to. Will be created if it doesn't exist. |
|
|
|
prefix |
|
default ``'card_'`` |
|
|
|
the prefix of all the filenames saved |
|
|
|
count_format |
|
default: ``'%02d'`` |
|
|
|
the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for ``Kernel::sprintf`` for specifics) |
|
|
|
suffix |
|
default: ``''`` |
|
|
|
the suffix of all the filenames saved, just before the `.png` extension. |
|
|
|
rotate |
|
default: ``false`` |
|
|
|
If ``true``, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait. Possible values: ``true``, ``false``, ``:clockwise``, ``:counterclockwise`` |
|
|
|
trim |
|
default: ``0`` |
|
|
|
the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports :doc:`/units`. |
|
|
|
trim_radius |
|
default: ``0`` |
|
|
|
the rounded rectangle radius around the card to trim before saving. |
|
|
|
shadow_radius |
|
default: ``nil`` |
|
|
|
adds a drop shadow behind the card just before rendering, when non-nil. Does nothing when set to nil. |
|
|
|
A larger radius extends the blur's spread, making it softer. A radius of 0 still enables the shadow, but has no blur. |
|
|
|
Recommended range: 3-10 pixels. |
|
|
|
See :ref:`shadow` section below for more details. |
|
|
|
shadow_offset_x |
|
default: ``3`` |
|
|
|
the horizontal distance that the drop shadow will be shifted beneath the final image. |
|
Ignored when ``shadow_radius`` is ``nil``. |
|
|
|
See :ref:`shadow` section below for more details. |
|
|
|
Supports :doc:`/units`. |
|
|
|
shadow_offset_y |
|
default: ``3`` |
|
|
|
Ignored when `shadow_radius` is ``nil``. See ``shadow_radius`` above for drop shadow details. |
|
|
|
See :ref:`shadow` section below for more details. |
|
|
|
Supports :doc:`/units`. |
|
|
|
shadow_trim |
|
default: ``0`` |
|
|
|
the space around the lower right and bottom edge of the output image to be trimmed when a drop shadow is drawn. Can also enlarge the image if it is negative. |
|
|
|
Ignored when `shadow_radius` is ``nil``. See :ref:`shadow` section below for more details. |
|
|
|
Supports :doc:`/units`. |
|
|
|
shadow_color |
|
default: ``:black`` |
|
|
|
the color or gradient of the drop shadow. See :doc:`/colors`. |
|
|
|
`Note about gradients:` Squib still does blurring, but gradients give you fine control over the softness of the shadow. See example below of doing a custom gradient for customizing your look. |
|
|
|
See :ref:`shadow` section below for more details. |
|
|
|
.. include:: /args/range.rst |
|
|
|
.. _shadow: |
|
|
|
Drop Shadow |
|
----------- |
|
|
|
Drop shadows don't modify the original image. Instead, this will paint your existing card images onto a shadow of themselves. The final image will have the following dimensions: |
|
|
|
* ``final_width = card_w + shadow_offset_x + (3 * shadow_radius) - (2 * shadow_trim) - (2 * trim)`` |
|
* ``final_height = card_h + shadow_offset_y + (3 * shadow_radius) - (2 * shadow_trim) - (2 * trim)`` |
|
|
|
A shadow of your card graphic is created using your ``shadow_color``. |
|
|
|
See https://github.com/rcairo/rcairo/blob/master/lib/cairo/context/blur.rb for details on blur implementation. Supports :doc:`/units`. |
|
|
|
Examples |
|
-------- |
|
|
|
This sample `lives here <https://github.com/andymeneely/squib/tree/master/samples/shadows>`_. |
|
|
|
.. literalinclude:: ../../samples/shadows/_shadow.rb |
|
:language: ruby |
|
:linenos: |
|
|
|
.. image:: ../../samples/shadows/with_shadow_00_expected.png |
|
``with_shadow_00.png`` |
|
|
|
.. image:: ../../samples/shadows/no_blur_00_expected.png |
|
``no_blur_00.png`` |
|
|
|
.. image:: ../../samples/shadows/gradient_blur_00_expected.png |
|
``gradient_blur_00.png`` |
|
|
|
|
|
.. image:: ../../samples/shadows/transparent_bg_shadow_00_expected.png |
|
``transparent_bg_shadow_00.png``
|
|
|