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, OptionalMethodArguments, Pixel, RVG, SolidFill, TextureFill

Constant Summary collapse

VERSION = 
'2.15.2'
MIN_RUBY_VERSION = 
'1.8.5'
MIN_IM_VERSION = 
'6.4.9'
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
MANAGED_MEMORY = 
Qfalse
AlphaChannel = 
_enum
DefaultChannels = 
_enum
HueChannel = 
_enum
LuminosityChannel = 
_enum
SaturationChannel = 
_enum
AffineMatrix = 
Class_AffineMatrix
Primary = 
Class_Primary
Chromaticity = 
Class_Chromaticity
Color = 
Class_Color
Point = 
Class_Point
Rectangle = 
Class_Rectangle
Segment = 
Class_Segment
Font = 
Class_Font
TypeMetric = 
Class_TypeMetric
Magick_version = 
str
Version = 
str
Long_version = 
str
Magick_features = 
features

Class Method Summary collapse

Class Method Details

.colors ⇒ Object

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

Ruby usage:

- @verbatim Magick::colors @endverbatim
- @verbatim Magick::colors { |colorinfo| } @endverbatim

Notes:

- There are 3 implementations.

Parameters:

  • class —

    the class on which the method is run.

Returns:

  • either the input class (if a block was given) or the array of colors.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'ext/RMagick/rmagick.c', line 32

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()
    (void) DestroyExceptionInfo(exception);


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

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

.fonts ⇒ Object

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

Ruby usage:

- @verbatim Magick::fonts @endverbatim
- @verbatim Magick::fonts { |fontinfo| } @endverbatim

Parameters:

  • class —

    the class on which the method is run.

Returns:

  • either the input class (if a block was given) or the array of fonts.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'ext/RMagick/rmagick.c', line 82

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()
    (void) DestroyExceptionInfo(exception);

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

}

.formats(&block) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rmagick_internal.rb', line 20

def formats(&block)
  @formats ||= init_formats

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

.init_formats ⇒ Object

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.

Ruby usage:

- @verbatim Magick.init_formats @endverbatim

Notes:

- Only called once.
- There are 3 implementations.

Parameters:

  • class —

    the class on which the method is run.

Returns:

  • the formats hash.

See Also:

  • MagickInfo_to_format


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'ext/RMagick/rmagick.c', line 167

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

    class = class;      // defeat "never referenced" message from icc
    formats = rb_hash_new();

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


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

.limit_resource(*args) ⇒ Object

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.

Ruby usage:

- @verbatim Magick.limit_resource(resource) @endverbatim
- @verbatim Magick.limit_resource(resource, limit) @endverbatim

Parameters:

  • argc —

    number of input arguments.

  • argv —

    array of input arguments.

  • class —

    the class on which the method is run.

Returns:

  • the current/old limit.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'ext/RMagick/rmagick.c', line 209

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
            {
                rb_raise(rb_eArgError, "unknown resource: `:%s'", rb_id2name(id));
            }
            break;

        default:
            str = StringValuePtr(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
            {
                rb_raise(rb_eArgError, "unknown resource: `%s'", str);
            }
            break;
    }

    RB_GC_GUARD(resource);

    cur_limit = GetMagickResourceLimit(res);

    if (argc > 1)
    {
        (void) 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.

Ruby usage:

- @verbatim Magick.set_cache_threshold(megabytes) @endverbatim

Notes:

- singleton method

Parameters:

  • class —

    the class on which the method is run.

  • threshold —

    the number of megabytes to set.

Returns:

  • the class.



316
317
318
319
320
321
322
323
 
# File 'ext/RMagick/rmagick.c', line 316

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

.set_log_event_mask(*args) ⇒ Object

Set the log event mask.

Ruby usage:

- @verbatim Magick.set_log_event_mask(event) @endverbatim
- @verbatim Magick.set_log_event_mask(event,...) @endverbatim

Notes:

- "event" is one of
  - "all"
  - "annotate"
  - "blob"
  - "cache"
  - "coder"
  - "configure"
  - "deprecate"
  - "locale"
  - "none"
  - "render"
  - "transform"
  - "user"
  - "x11"
- Multiple events can be specified.
- Event names may be capitalized.

Parameters:

  • argc —

    number of input arguments.

  • argv —

    array of input arguments.

  • class —

    the class on which the method is run.

Returns:

  • the class.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# 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++)
    {
        (void) SetLogEventMask(StringValuePtr(argv[x]));
    }
    return class;
}

.set_log_format(format) ⇒ Object

Set the format for log messages.

Ruby usage:

- @verbatim Magick.set_log_format(format) @endverbatim

Notes:

- 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:

  • class —

    the class on which the method is run.

  • format —

    the format to set.

Returns:

  • the class.



395
396
397
398
399
400
 
# File 'ext/RMagick/rmagick.c', line 395

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

.trace_proc=(p) ⇒ Object

remove reference to the proc at exit



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rmagick_internal.rb', line 32

def trace_proc=(p)
  m = Mutex.new
  m.synchronize do
    if @trace_proc.nil? && !p.nil? && !@exit_block_set_up
      at_exit { @trace_proc = nil }
      @exit_block_set_up = true
    end

    @trace_proc = p
  end
end