Module: Magick

Defined in:

lib/rvg/rvg.rb,
lib/rvg/misc.rb,
lib/rvg/misc.rb,
lib/rvg/misc.rb,
lib/rvg/text.rb,
lib/rvg/paint.rb,
lib/rvg/units.rb,
lib/rvg/clippath.rb,
lib/rvg/pathdata.rb,
lib/rvg/stylable.rb,
lib/rvg/container.rb,
lib/rvg/deep_equal.rb,
lib/rmagick/version.rb,
lib/rvg/describable.rb,
lib/rvg/stretchable.rb,
lib/rmagick_internal.rb,
lib/rvg/embellishable.rb,
lib/rvg/transformable.rb,
ext/RMagick/rmmain.c

Overview

– $Id: transformable.rb,v 1.5 2009/02/28 23:52:28 rmagick Exp $ Copyright © 2009 Timothy P. Hunter ++

Defined Under Namespace

Modules: IPTC Classes: DestroyedImageError, Draw, Enum, FatalImageMagickError, Geometry, GeometryValue, GradientFill, HatchFill, Image, ImageList, ImageMagickError, KernelInfo, OptionalMethodArguments, Pixel, RVG, SolidFill, TextureFill

Constant Summary

VERSION =

'5.2.0'

MIN_RUBY_VERSION =

'2.3.0'

MIN_IM_VERSION =

'6.7.7'

IMAGEMAGICK_VERSION =

Magick::Magick_version.split[1].split('-').first

PercentGeometry =

GeometryValue.new(:PercentGeometry, 1).freeze

AspectGeometry =

GeometryValue.new(:AspectGeometry, 2).freeze

LessGeometry =

GeometryValue.new(:LessGeometry, 3).freeze

GreaterGeometry =

GeometryValue.new(:GreaterGeometry, 4).freeze

AreaGeometry =

GeometryValue.new(:AreaGeometry, 5).freeze

MinimumGeometry =

GeometryValue.new(:MinimumGeometry, 6).freeze

Magick_version =

str

Version =

str

Long_version =

str

Magick_features =

features

Class Method Summary

• .colors ⇒ Object

  If called with the optional block, iterates over the colors, otherwise returns an array of Color objects.

• .fonts ⇒ Object

  If called with the optional block, iterates over the fonts, otherwise returns an array of Font objects.

• .formats ⇒ Object

  Describes the image formats supported by ImageMagick.

• .init_formats ⇒ Hash

  Build the @@formats hash.

• .limit_resource(*args) ⇒ Numeric

  Get/set resource limits.

• .set_cache_threshold(threshold) ⇒ Object

  Set the amount of free memory allocated for the pixel cache.

• .set_log_event_mask(*args) ⇒ Object

  Set the log event mask.

• .set_log_format(format) ⇒ Object

  Set the format for log messages.

Class Method Details

.colors ⇒ Array<Magick::Color> .colors {|colorinfo| ... } ⇒ Object

If called with the optional block, iterates over the colors, otherwise returns an array of Color objects.

Overloads:

• .colors ⇒ Array<Magick::Color>

  Returns the array of Color.

  Returns:

  • (Array<Magick::Color>) —

    the array of Color

• .colors {|colorinfo| ... } ⇒ Object

  Yields:

  • (colorinfo)

  Yield Parameters:

  • colorinfo (Magick::Color) —

    the color

# File 'ext/RMagick/rmagick.c', line 44

VALUE
Magick_colors(VALUE class)
{
    const ColorInfo **color_info_list;
    size_t number_colors, x;
    VALUE ary;
    ExceptionInfo *exception;

    exception = AcquireExceptionInfo();

    color_info_list = GetColorInfoList("*", &number_colors, exception);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);


    if (rb_block_given_p())
    {
        for (x = 0; x < number_colors; x++)
        {
            rb_rescue(rm_yield_body, Import_ColorInfo(color_info_list[x]), rm_yield_handle_exception, (VALUE)color_info_list);
        }
        magick_free((void *)color_info_list);
        return class;
    }
    else
    {
        ary = rb_ary_new2((long) number_colors);
        for (x = 0; x < number_colors; x++)
        {
            rb_ary_push(ary, Import_ColorInfo(color_info_list[x]));
        }

        magick_free((void *)color_info_list);
        RB_GC_GUARD(ary);
        return ary;
    }
}

.fonts ⇒ Array<Magick::Font> .fonts {|fontinfo| ... } ⇒ Object

If called with the optional block, iterates over the fonts, otherwise returns an array of Font objects.

Overloads:

• .fonts ⇒ Array<Magick::Font>

  Returns the array of Font.

  Returns:

  • (Array<Magick::Font>) —

    the array of Font

• .fonts {|fontinfo| ... } ⇒ Object

  Yields:

  • (fontinfo)

  Yield Parameters:

  • fontinfo (Magick::Font) —

    the font

# File 'ext/RMagick/rmagick.c', line 95

VALUE
Magick_fonts(VALUE class)
{
    const TypeInfo **type_info;
    size_t number_types, x;
    VALUE ary;
    ExceptionInfo *exception;

    exception = AcquireExceptionInfo();
    type_info = GetTypeInfoList("*", &number_types, exception);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);

    if (rb_block_given_p())
    {
        for (x = 0; x < number_types; x++)
        {
            rb_rescue(rm_yield_body, Import_TypeInfo((const TypeInfo *)type_info[x]), rm_yield_handle_exception, (VALUE)type_info);
        }
        magick_free((void *)type_info);
        return class;
    }
    else
    {
        ary = rb_ary_new2((long)number_types);
        for (x = 0; x < number_types; x++)
        {
            rb_ary_push(ary, Import_TypeInfo((const TypeInfo *)type_info[x]));
        }
        magick_free((void *)type_info);
        RB_GC_GUARD(ary);
        return ary;
    }

}

.formats ⇒ Hash .formats {|k, v| ... } ⇒ Magick

Describes the image formats supported by ImageMagick. If the optional block is present, calls the block once for each image format. The first argument, k, is the format name. The second argument, v, is the properties string described below.

• B is “*” if the format has native blob support, or “ ” otherwise.

• R is “r” if ImageMagick can read that format, or “-” otherwise.

• W is “w” if ImageMagick can write that format, or “-” otherwise.

• A is “+” if the format supports multi-image files, or “-” otherwise.

Examples:

p Magick.formats
=> {"3FR"=>" r-+", "3G2"=>" r-+", "3GP"=>" r-+", "A"=>"*rw+",
...

Overloads:

• .formats ⇒ Hash

  Returns the formats hash.

  Returns:

  • (Hash) —

    the formats hash

• .formats {|k, v| ... } ⇒ Magick

  Yields:

  • (k, v)

  Yield Parameters:

  • k (String) —

    the format name

  • v (String) —

    the properties string

  Returns:

  • (Magick)

# File 'lib/rmagick_internal.rb', line 54

def formats
  formats = init_formats

  if block_given?
    formats.each { |k, v| yield k, v }
    self
  else
    formats
  end
end

.init_formats ⇒ Hash

Build the @@formats hash. The hash keys are image formats. The hash values specify the format “mode string”, i.e. a description of what ImageMagick can do with that format. The mode string is in the form “BRWA”, where

• “B” is “*” if the format has native blob support, or “ ” otherwise.

• “R” is “r” if ImageMagick can read that format, or “-” otherwise.

• “W” is “w” if ImageMagick can write that format, or “-” otherwise.

• “A” is “+” if the format supports multi-image files, or “-” otherwise.

Returns:

• (Hash) —

  the formats hash.

# File 'ext/RMagick/rmagick.c', line 172

VALUE
Magick_init_formats(VALUE class ATTRIBUTE_UNUSED)
{
    const MagickInfo **magick_info;
    size_t number_formats, x;
    VALUE formats;
    ExceptionInfo *exception;

    formats = rb_hash_new();

    // IM 6.1.3 added an exception argument to GetMagickInfoList
    exception = AcquireExceptionInfo();
    magick_info = GetMagickInfoList("*", &number_formats, exception);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);


    for (x = 0; x < number_formats; x++)
    {
        rb_hash_aset(formats,
                     rb_str_new2(magick_info[x]->name),
                     MagickInfo_to_format((const MagickInfo *)magick_info[x]));
    }
    magick_free((void *)magick_info);
    RB_GC_GUARD(formats);
    return formats;
}

.limit_resource(resource) ⇒ Numeric .limit_resource(resource, limit) ⇒ Numeric

Get/set resource limits. If a limit is specified the old limit is set to the new value. Either way the current/old limit is returned.

Overloads:

• .limit_resource(resource) ⇒ Numeric

  Get resource limits.

  Parameters:

  • resource (String, Symbol) —

    the type of resource

• .limit_resource(resource, limit) ⇒ Numeric

  Set resource limits.

  Parameters:

  • resource (String, Symbol) —

    the type of resource

  • limit (Numeric) —

    the new limit number

Returns:

• (Numeric) —

  the old limit.

# File 'ext/RMagick/rmagick.c', line 216

VALUE
Magick_limit_resource(int argc, VALUE *argv, VALUE class)
{
    VALUE resource, limit;
    ResourceType res = UndefinedResource;
    char *str;
    ID id;
    unsigned long cur_limit;

    rb_scan_args(argc, argv, "11", &resource, &limit);

    switch (TYPE(resource))
    {
        case T_NIL:
            return class;

        case T_SYMBOL:
            id = (ID)SYM2ID(resource);
            if (id == rb_intern("area"))
            {
                res = AreaResource;
            }
            else if (id == rb_intern("memory"))
            {
                res = MemoryResource;
            }
            else if (id == rb_intern("map"))
            {
                res = MapResource;
            }
            else if (id == rb_intern("disk"))
            {
                res = DiskResource;
            }
            else if (id == rb_intern("file"))
            {
                res = FileResource;
            }
            else if (id == rb_intern("time"))
            {
                res = TimeResource;
            }
            else
            {
                rb_raise(rb_eArgError, "unknown resource: `:%s'", rb_id2name(id));
            }
            break;

        default:
            str = StringValueCStr(resource);
            if (*str == '\0')
            {
                return class;
            }
            else if (rm_strcasecmp("area", str) == 0)
            {
                res = AreaResource;
            }
            else if (rm_strcasecmp("memory", str) == 0)
            {
                res = MemoryResource;
            }
            else if (rm_strcasecmp("map", str) == 0)
            {
                res = MapResource;
            }
            else if (rm_strcasecmp("disk", str) == 0)
            {
                res = DiskResource;
            }
            else if (rm_strcasecmp("file", str) == 0)
            {
                res = FileResource;
            }
            else if (rm_strcasecmp("time", str) == 0)
            {
                res = TimeResource;
            }
            else
            {
                rb_raise(rb_eArgError, "unknown resource: `%s'", str);
            }
            break;
    }

    RB_GC_GUARD(resource);

    cur_limit = GetMagickResourceLimit(res);

    if (argc > 1)
    {
        SetMagickResourceLimit(res, (MagickSizeType)NUM2ULONG(limit));
    }

    RB_GC_GUARD(limit);

    return ULONG2NUM(cur_limit);
}

.set_cache_threshold(threshold) ⇒ Object

Set the amount of free memory allocated for the pixel cache. Once this threshold is exceeded, all subsequent pixels cache operations are to/from disk.

Parameters:

• threshold (Numeric) —

  the number of megabytes to set.

# File 'ext/RMagick/rmagick.c', line 323

VALUE
Magick_set_cache_threshold(VALUE class, VALUE threshold)
{
    unsigned long thrshld = NUM2ULONG(threshold);
    SetMagickResourceLimit(MemoryResource, (MagickSizeType)thrshld);
    SetMagickResourceLimit(MapResource, (MagickSizeType)(2*thrshld));
    return class;
}

.set_log_event_mask(*args) ⇒ Object

Set the log event mask.

The arguments are one of:

• “all”

• “annotate”

• “blob”

• “cache”

• “coder”

• “configure”

• “deprecate”

• “locale”

• “none”

• “render”

• “transform”

• “user”

• “x11”

Multiple events can be specified as the aruments. Event names may be capitalized.

Parameters:

• args (String) —

  the mask of log event.

# File 'ext/RMagick/rmagick.c', line 356

VALUE
Magick_set_log_event_mask(int argc, VALUE *argv, VALUE class)
{
    int x;

    if (argc == 0)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (at least 1 required)");
    }
    for (x = 0; x < argc; x++)
    {
        SetLogEventMask(StringValueCStr(argv[x]));
    }
    return class;
}

.set_log_format(format) ⇒ Object

Set the format for log messages.

Format is a string containing one or more of:

• %t - current time

• %r - elapsed time

• %u - user time

• %p - pid

• %m - module (source file name)

• %f - function name

• %l - line number

• %d - event domain (one of the events listed above)

• %e - event name

• Plus other characters, including \n, etc.

Parameters:

• format (String) —

  the format to set.

# File 'ext/RMagick/rmagick.c', line 390

VALUE
Magick_set_log_format(VALUE class, VALUE format)
{
    SetLogFormat(StringValueCStr(format));
    return class;
}