Class: Magick::Image::Info

Inherits:
Object
  • Object
show all
Defined in:
ext/RMagick/rmmain.c

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object #initialize {|Magick::Image::Info| ... } ⇒ Object

If an initializer block is present, run it.

Overloads:



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
 
# File 'ext/RMagick/rminfo.c', line 2412

VALUE
Info_initialize(VALUE self)
{
    if (rb_block_given_p())
    {
        if (rb_proc_arity(rb_block_proc()) == 0)
        {
            // Run the block in self's context
            rb_warn("passing a block without an image argument is deprecated");
            rb_obj_instance_eval(0, NULL, self);
        }
        else
        {
            rb_yield(self);
        }
    }
    return self;
}

Instance Method Details

#[](format, key) ⇒ String #[](key) ⇒ String

Get the value of the specified option for the specified format.

  • The 2 argument form is the original form. Added support for a single argument after ImageMagick started using Set/GetImageOption for options that aren’t represented by fields in the ImageInfo structure.

Overloads:

  • #[](format, key) ⇒ String

    Parameters:

    • format (String) —

      An image format name such as “ps” or “tiff”.

    • key (String) —

      A string that identifies the option.

  • #[](key) ⇒ String

    Parameters:

    • key (String) —

      A string that identifies the option.

Returns:

  • (String) —

    The value of the option.



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
 
# File 'ext/RMagick/rminfo.c', line 243

VALUE
Info_aref(int argc, VALUE *argv, VALUE self)
{
    Info *info;
    char *format_p, *key_p;
    long format_l, key_l;
    const char *value;
    char fkey[MaxTextExtent];

    switch (argc)
    {
        case 2:
            format_p = rm_str2cstr(argv[0], &format_l);
            key_p = rm_str2cstr(argv[1], &key_l);
            if (format_l > MAX_FORMAT_LEN || format_l + key_l > MaxTextExtent-1)
            {
                rb_raise(rb_eArgError, "can't reference %.60s:%.1024s - too long", format_p, key_p);
            }

            snprintf(fkey, sizeof(fkey), "%.60s:%.*s", format_p, (int)(MaxTextExtent-61), key_p);
            break;

        case 1:
            strlcpy(fkey, StringValueCStr(argv[0]), sizeof(fkey));
            break;

        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 or 2)", argc);
            break;

    }

    Data_Get_Struct(self, Info, info);
    value = GetImageOption(info, fkey);
    if (!value)
    {
        return Qnil;
    }

    return rb_str_new2(value);
}

#[]=(format, key) ⇒ Magick::Image::Info #[]=(key) ⇒ Magick::Image::Info

Define an option. An alternative to #define. Use this method to set options for reading or writing certain image formats.

  • Essentially the same function as #define but paired with #[]

  • If the value is nil it is equivalent to #undefine.

Overloads:

  • #[]=(format, key) ⇒ Magick::Image::Info

    Parameters:

    • format (String) —

      An image format name such as “ps” or “tiff”.

    • key (String) —

      A string that identifies the option.

  • #[]=(key) ⇒ Magick::Image::Info

    Parameters:

    • key (String) —

      A string that identifies the option.

Returns:

See Also:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'ext/RMagick/rminfo.c', line 305

VALUE
Info_aset(int argc, VALUE *argv, VALUE self)
{
    Info *info;
    VALUE value;
    char *format_p, *key_p, *value_p = NULL;
    long format_l, key_l;
    char ckey[MaxTextExtent];

    Data_Get_Struct(self, Info, info);

    switch (argc)
    {
        case 3:
            format_p = rm_str2cstr(argv[0], &format_l);
            key_p = rm_str2cstr(argv[1], &key_l);

            if (format_l > MAX_FORMAT_LEN || format_l+key_l > MaxTextExtent-1)
            {
                rb_raise(rb_eArgError, "%.60s:%.1024s not defined - too long", format_p, key_p);
            }

            snprintf(ckey, sizeof(ckey), "%.60s:%.*s", format_p, (int)(sizeof(ckey)-MAX_FORMAT_LEN), key_p);

            value = argv[2];
            break;

        case 2:
            strlcpy(ckey, StringValueCStr(argv[0]), sizeof(ckey));

            value = argv[1];
            break;

        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 2 or 3)", argc);
            break;
    }

    if (NIL_P(value))
    {
        DeleteImageOption(info, ckey);
    }
    else
    {
        unsigned int okay;

        /* Allow any argument that supports to_s */
        value = rb_String(value);
        value_p = StringValueCStr(value);

        okay = SetImageOption(info, ckey, value_p);
        if (!okay)
        {
            rb_warn("`%s' not defined - SetImageOption failed.", ckey);
            return Qnil;
        }
    }

    RB_GC_GUARD(value);

    return self;
}

#antialias ⇒ Boolean

Get antialias value

Returns:

  • (Boolean) —

    true if antialias is enabled



206
207
208
209
210
 
# File 'ext/RMagick/rminfo.c', line 206

VALUE
Info_antialias(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, antialias, boolean);
}

#antialias=(val) ⇒ Boolean

Set antialias value

Parameters:

  • val (Boolean) —

    true or false

Returns:

  • (Boolean) —

    the given value



218
219
220
221
222
 
# File 'ext/RMagick/rminfo.c', line 218

VALUE
Info_antialias_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, antialias, boolean);
}

#attenuate ⇒ Float

Get the attenuate value.

Returns:

  • (Float) —

    the attenuate



374
375
376
377
378
 
# File 'ext/RMagick/rminfo.c', line 374

VALUE
Info_attenuate(VALUE self)
{
    return get_dbl_option(self, "attenuate");
}

#attenuate=(value) ⇒ Float

Set the attenuate value.

Parameters:

  • value (Float) —

    the attenuate

Returns:

  • (Float) —

    the attenuate



387
388
389
390
391
 
# File 'ext/RMagick/rminfo.c', line 387

VALUE
Info_attenuate_eq(VALUE self, VALUE value)
{
    return set_dbl_option(self, "attenuate", value);
}

#authenticate ⇒ String

Get the authenticate value.

Returns:

  • (String) —

    the authenticate



399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'ext/RMagick/rminfo.c', line 399

VALUE
Info_authenticate(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
#if defined(IMAGEMAGICK_7)
    return C_str_to_R_str(GetImageOption(info, "authenticate"));
#else
    return C_str_to_R_str(info->authenticate);
#endif
}

#authenticate=(passwd_arg) ⇒ String

Set the authenticate value.

Parameters:

  • passwd_arg (String) —

    the authenticating password

Returns:

  • (String) —

    the given value



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'ext/RMagick/rminfo.c', line 419

VALUE
Info_authenticate_eq(VALUE self, VALUE passwd_arg)
{
    Info *info;
    char *passwd = NULL;

    Data_Get_Struct(self, Info, info);

    if (!NIL_P(passwd_arg))
    {
        passwd = StringValueCStr(passwd_arg);
    }

#if defined(IMAGEMAGICK_7)
    if (passwd)
    {
        SetImageOption(info, "authenticate", passwd);
    }
    else
    {
        RemoveImageOption(info, "authenticate");
    }
#else
    if (info->authenticate)
    {
        magick_free(info->authenticate);
        info->authenticate = NULL;
    }
    if (passwd)
    {
        magick_clone_string(&info->authenticate, passwd);
    }
#endif

    return passwd_arg;
}

#background_color ⇒ String

Return the name of the background color as a String

Returns:

  • (String) —

    the name of the background color

See Also:



463
464
465
466
467
468
469
470
 
# File 'ext/RMagick/rminfo.c', line 463

VALUE
Info_background_color(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return rm_pixelcolor_to_color_name_info(info, &info->background_color);
}

#background_color=(bc_arg) ⇒ Magick::Pixel, String

Set the background color.

Parameters:

Returns:



479
480
481
482
483
484
485
486
487
488
 
# File 'ext/RMagick/rminfo.c', line 479

VALUE
Info_background_color_eq(VALUE self, VALUE bc_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    Color_to_PixelColor(&info->background_color, bc_arg);

    return bc_arg;
}

#border_color ⇒ String

Return the name of the border color as a String.

Returns:

  • (String) —

    the border color name

See Also:



496
497
498
499
500
501
502
503
 
# File 'ext/RMagick/rminfo.c', line 496

VALUE
Info_border_color(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return rm_pixelcolor_to_color_name_info(info, &info->border_color);
}

#border_color=(bc_arg) ⇒ Magick::Pixel, String

set the border color

Parameters:

Returns:



511
512
513
514
515
516
517
518
519
520
 
# File 'ext/RMagick/rminfo.c', line 511

VALUE
Info_border_color_eq(VALUE self, VALUE bc_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    Color_to_PixelColor(&info->border_color, bc_arg);

    return bc_arg;
}

#caption ⇒ String

Get a caption of image

Returns:

  • (String) —

    the caption



529
530
531
532
533
 
# File 'ext/RMagick/rminfo.c', line 529

VALUE
Info_caption(VALUE self)
{
    return get_option(self, "caption");
}

#caption=(caption) ⇒ String

Assigns a caption to an image.

Parameters:

  • caption (String) —

    the caption

Returns:

  • (String) —

    the given value



543
544
545
546
547
 
# File 'ext/RMagick/rminfo.c', line 543

VALUE
Info_caption_eq(VALUE self, VALUE caption)
{
    return set_option(self, "caption", caption);
}

#channel(channel = Magick::AllChannels) ⇒ Magick::Image::Info #channel(*channels) ⇒ Magick::Image::Info

Set the channels

Overloads:

  • #channel(channel = Magick::AllChannels) ⇒ Magick::Image::Info

    Parameters:

    • channel (Magick::ChannelType) (defaults to: Magick::AllChannels) —

      the channel

  • #channel(*channels) ⇒ Magick::Image::Info

    Parameters:

    • channels (Magick::ChannelType) —

      the multiple arguments of channel

Returns:



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'ext/RMagick/rminfo.c', line 561

VALUE
Info_channel(int argc, VALUE *argv, VALUE self)
{
    Info *info;
    ChannelType channels;

    channels = extract_channels(&argc, argv);

    // Ensure all arguments consumed.
    if (argc > 0)
    {
        raise_ChannelType_error(argv[argc-1]);
    }

    Data_Get_Struct(self, Info, info);

    info->channel = channels;
    return self;
}

#colorspace ⇒ Magick::ColorspaceType

Get the colorspace type.

Returns:

  • (Magick::ColorspaceType) —

    the colorspace type



587
588
589
590
591
592
593
594
 
# File 'ext/RMagick/rminfo.c', line 587

VALUE
Info_colorspace(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return ColorspaceType_find(info->colorspace);
}

#colorspace=(colorspace) ⇒ Magick::ColorspaceType

Set the colorspace type

Parameters:

  • colorspace (Magick::ColorspaceType) —

    the colorspace type

Returns:

  • (Magick::ColorspaceType) —

    the given colorspace



602
603
604
605
606
607
608
609
610
 
# File 'ext/RMagick/rminfo.c', line 602

VALUE
Info_colorspace_eq(VALUE self, VALUE colorspace)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(colorspace, info->colorspace, ColorspaceType);
    return colorspace;
}

#comment ⇒ String

Get the comment.

Returns:

  • (String) —

    the comment



617
618
619
620
 
# File 'ext/RMagick/rminfo.c', line 617

VALUE Info_comment(VALUE self)
{
    return get_option(self, "Comment");
}

#comment=(string) ⇒ String

Set the comment

Parameters:

  • string (String) —

    the comment

Returns:

  • (String) —

    the given comment



628
629
630
631
 
# File 'ext/RMagick/rminfo.c', line 628

VALUE Info_comment_eq(VALUE self, VALUE string)
{
    return set_option(self, "Comment", string);
}

#compression ⇒ Magick::CompressionType

Get the compression type.

Returns:

  • (Magick::CompressionType) —

    the compression type



638
639
640
641
642
643
644
645
 
# File 'ext/RMagick/rminfo.c', line 638

VALUE
Info_compression(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return CompressionType_find(info->compression);
}

#compression=(type) ⇒ Magick::CompressionType

Set the compression type

Parameters:

  • type (Magick::CompressionType) —

    the compression type

Returns:

  • (Magick::CompressionType) —

    the given type



653
654
655
656
657
658
659
660
661
 
# File 'ext/RMagick/rminfo.c', line 653

VALUE
Info_compression_eq(VALUE self, VALUE type)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(type, info->compression, CompressionType);
    return type;
}

#Info ⇒ Magick::Image::Info

Define an option.

Parameters:

  • format (String) —

    An image format name such as “ps” or “tiff”.

  • key (String) —

    A string that identifies the option.

  • value (String) —

    A value of option

Returns:



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'ext/RMagick/rminfo.c', line 673

VALUE
Info_define(int argc, VALUE *argv, VALUE self)
{
    Info *info;
    char *format, *key;
    const char *value = "";
    long format_l, key_l;
    char ckey[100];
    unsigned int okay;
    VALUE fmt_arg;

    Data_Get_Struct(self, Info, info);

    switch (argc)
    {
        case 3:
            /* Allow any argument that supports to_s */
            fmt_arg = rb_String(argv[2]);
            value = (const char *)StringValueCStr(fmt_arg);
        case 2:
            key = rm_str2cstr(argv[1], &key_l);
            format = rm_str2cstr(argv[0], &format_l);
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 2 or 3)", argc);
    }

    if (2 + format_l + key_l > (long)sizeof(ckey))
    {
        rb_raise(rb_eArgError, "%.20s:%.20s not defined - format or key too long", format, key);
    }
    snprintf(ckey, sizeof(ckey), "%s:%s", format, key);

    DeleteImageOption(info, ckey);
    okay = SetImageOption(info, ckey, value);
    if (!okay)
    {
        rb_warn("%.20s=\"%.78s\" not defined - SetImageOption failed.", ckey, value);
        return Qnil;
    }

    RB_GC_GUARD(fmt_arg);

    return self;
}

#delay ⇒ Numeric?

Get the delay value.

Returns:

  • (Numeric, nil) —

    the delay



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'ext/RMagick/rminfo.c', line 724

VALUE
Info_delay(VALUE self)
{
    Info *info;
    const char *delay;
    char *p;

    Data_Get_Struct(self, Info, info);

    delay = GetImageOption(info, "delay");
    if (delay)
    {
        long d;

        d = strtol(delay, &p, 10);
        if (*p != '\0')
        {
            rb_raise(rb_eRangeError, "failed to convert %s to Numeric", delay);
        }
        return LONG2NUM(d);
    }
    return Qnil;
}

#delay=(string) ⇒ String

Set the delay value.

Parameters:

  • string (String) —

    the delay

Returns:

  • (String) —

    the given value



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'ext/RMagick/rminfo.c', line 768

VALUE
Info_delay_eq(VALUE self, VALUE string)
{
    Info *info;
    int not_num;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(string))
    {
        DeleteImageOption(info, "delay");
    }
    else
    {
        char dstr[20];
        int delay;

        not_num = 0;
        rb_protect(arg_is_integer, string, &not_num);
        if (not_num)
        {
            rb_raise(rb_eTypeError, "failed to convert %s into Integer", rb_class2name(CLASS_OF(string)));
        }
        delay = NUM2INT(string);
        snprintf(dstr, sizeof(dstr), "%d", delay);
        SetImageOption(info, "delay", dstr);
    }
    return string;
}

#density ⇒ String

Get the density value

Returns:

  • (String) —

    the density



803
804
805
806
807
 
# File 'ext/RMagick/rminfo.c', line 803

VALUE
Info_density(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, density, str);
}

#density=(density_arg) ⇒ String

Set the text rendering density geometry

Parameters:

  • density_arg (String) —

    the density

Returns:

  • (String) —

    the given value

See Also:



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'ext/RMagick/rminfo.c', line 816

VALUE
Info_density_eq(VALUE self, VALUE density_arg)
{
    Info *info;
    VALUE density;
    char *dens;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(density_arg))
    {
        magick_free(info->density);
        info->density = NULL;
        return self;
    }

    density = rb_String(density_arg);
    dens = StringValueCStr(density);
    if (!IsGeometry(dens))
    {
        rb_raise(rb_eArgError, "invalid density geometry: %s", dens);
    }

    magick_clone_string(&info->density, dens);

    RB_GC_GUARD(density);

    return density_arg;
}

#depth ⇒ Numeric

Get the depth value

Returns:

  • (Numeric) —

    the depth



851
852
853
854
855
 
# File 'ext/RMagick/rminfo.c', line 851

VALUE
Info_depth(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, depth, int);
}

#depth=(depth) ⇒ Numeric

Set the depth (8, 16, 32, 64).

Parameters:

  • depth (Numeric) —

    the depth

Returns:

  • (Numeric) —

    the given depth



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'ext/RMagick/rminfo.c', line 863

VALUE
Info_depth_eq(VALUE self, VALUE depth)
{
    Info *info;
    unsigned long d;

    Data_Get_Struct(self, Info, info);
    d = NUM2ULONG(depth);
    switch (d)
    {
        case 8:                     // always okay
#if MAGICKCORE_QUANTUM_DEPTH == 16 || MAGICKCORE_QUANTUM_DEPTH == 32 || MAGICKCORE_QUANTUM_DEPTH == 64
        case 16:
#if MAGICKCORE_QUANTUM_DEPTH == 32 || MAGICKCORE_QUANTUM_DEPTH == 64
        case 32:
#if MAGICKCORE_QUANTUM_DEPTH == 64
        case 64:
#endif
#endif
#endif
            break;
        default:
            rb_raise(rb_eArgError, "invalid depth (%lu)", d);
            break;
    }

    info->depth = d;
    return depth;
}

#dispose ⇒ Magick::DisposeType

Retrieve the dispose option string and convert it to a DisposeType enumerator.

Returns:

  • (Magick::DisposeType) —

    a DisposeType enumerator



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'ext/RMagick/rminfo.c', line 946

VALUE
Info_dispose(VALUE self)
{
    Info *info;
    ID dispose_id;
    const char *dispose;

    Data_Get_Struct(self, Info, info);

    dispose_id = rb_intern("UndefinedDispose");

    // Map the dispose option string to a DisposeType enumerator.
    dispose = GetImageOption(info, "dispose");
    if (dispose)
    {
        for (int x = 0; x < N_DISPOSE_OPTIONS; x++)
        {
            if (strcmp(dispose, Dispose_Option[x].string) == 0)
            {
                dispose_id = rb_intern(Dispose_Option[x].enum_name);
                break;
            }
        }
    }

    return rb_const_get(Module_Magick, dispose_id);
}

#dispose=(disp) ⇒ Magic::DisposeType

Convert a DisposeType enumerator into the equivalent dispose option string.

Parameters:

  • disp (Magic::DisposeType) —

    the DisposeType enumerator

Returns:

  • (Magic::DisposeType) —

    the given value



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'ext/RMagick/rminfo.c', line 980

VALUE
Info_dispose_eq(VALUE self, VALUE disp)
{
    Info *info;
    DisposeType dispose;
    const char *option;
    int x;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(disp))
    {
        DeleteImageOption(info, "dispose");
        return self;
    }

    VALUE_TO_ENUM(disp, dispose, DisposeType);
    option = "Undefined";

    for (x = 0; x < N_DISPOSE_OPTIONS; x++)
    {
        if (dispose == Dispose_Option[x].enumerator)
        {
            option = Dispose_Option[x].string;
            break;
        }
    }

    SetImageOption(info, "dispose", option);
    return disp;
}

#dither ⇒ Boolean

Get dither value

Returns:

  • (Boolean) —

    true if dither is enabled



1017
1018
1019
1020
1021
 
# File 'ext/RMagick/rminfo.c', line 1017

VALUE
Info_dither(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, dither, boolean);
}

#dither=(val) ⇒ Boolean

Set dither value

Parameters:

  • val (Boolean) —

    true if dither will be enabled

Returns:

  • (Boolean) —

    true if dither is enabled



1029
1030
1031
1032
1033
 
# File 'ext/RMagick/rminfo.c', line 1029

VALUE
Info_dither_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, dither, boolean);
}

#endian ⇒ Magick::EndianType

Get the endian value.

Returns:

  • (Magick::EndianType) —

    the endian



1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'ext/RMagick/rminfo.c', line 1041

VALUE
Info_endian(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return EndianType_find(info->endian);
}

#endian=(endian) ⇒ Magick::EndianType

Set the endian value.

Parameters:

  • endian (Magick::EndianType) —

    the endian

Returns:

  • (Magick::EndianType) —

    the given endian



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'ext/RMagick/rminfo.c', line 1057

VALUE
Info_endian_eq(VALUE self, VALUE endian)
{
    Info *info;
    EndianType type = UndefinedEndian;

    if (endian != Qnil)
    {
        VALUE_TO_ENUM(endian, type, EndianType);
    }

    Data_Get_Struct(self, Info, info);
    info->endian = type;
    return endian;
}

#extract ⇒ String

Get the extract geometry, e.g. “200x200+100+100”

Returns:

  • (String) —

    the extract string

See Also:



1080
1081
1082
1083
1084
 
# File 'ext/RMagick/rminfo.c', line 1080

VALUE
Info_extract(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, extract, str);
}

#extract=(extract_arg) ⇒ String

Set the extract geometry.

Parameters:

  • extract_arg (String) —

    the extract string

Returns:

  • (String) —

    the given value

See Also:



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'ext/RMagick/rminfo.c', line 1093

VALUE
Info_extract_eq(VALUE self, VALUE extract_arg)
{
    Info *info;
    char *extr;
    VALUE extract;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(extract_arg))
    {
        magick_free(info->extract);
        info->extract = NULL;
        return self;
    }

    extract = rb_String(extract_arg);
    extr = StringValueCStr(extract);
    if (!IsGeometry(extr))
    {
        rb_raise(rb_eArgError, "invalid extract geometry: %s", extr);
    }

    magick_clone_string(&info->extract, extr);

    RB_GC_GUARD(extract);

    return extract_arg;
}

#filename ⇒ String

Note:

Only used for Image#capture

Get the “filename” value.

Returns:

  • (String) —

    the file name (“” if filename not set)

See Also:

  • Image#capture


1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'ext/RMagick/rminfo.c', line 1131

VALUE
Info_filename(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return rb_str_new2(info->filename);
}

#filename=(filename) ⇒ String

Note:

Only used for Image#capture

Set the “filename” value.

Parameters:

  • filename (String) —

    the file name

Returns:

  • (String) —

    the given file name

See Also:

  • Image#capture


1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'ext/RMagick/rminfo.c', line 1148

VALUE
Info_filename_eq(VALUE self, VALUE filename)
{
    Info *info;

    Data_Get_Struct(self, Info, info);

    // Allow "nil" - remove current filename
    if (NIL_P(filename) || StringValueCStr(filename) == NULL)
    {
        info->filename[0] = '\0';
    }
    else
    {
        char *fname;

        // Otherwise copy in filename
        fname = StringValueCStr(filename);
        strlcpy(info->filename, fname, sizeof(info->filename));
    }
    return filename;
}

#fill ⇒ String

Return the fill color as a String.

Returns:

  • (String) —

    the fill color



1177
1178
1179
1180
1181
 
# File 'ext/RMagick/rminfo.c', line 1177

VALUE
Info_fill(VALUE self)
{
    return get_option(self, "fill");
}

#fill=(color) ⇒ String

Set the fill color

Parameters:

  • color (String) —

    the fill color

Returns:

  • (String) —

    the given value



1189
1190
1191
1192
1193
 
# File 'ext/RMagick/rminfo.c', line 1189

VALUE
Info_fill_eq(VALUE self, VALUE color)
{
    return set_color_option(self, "fill", color);
}

#font ⇒ String

Get the text font.

Returns:

  • (String) —

    the font



1201
1202
1203
1204
1205
 
# File 'ext/RMagick/rminfo.c', line 1201

VALUE
Info_font(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, font, str);
}

#font=(font_arg) ⇒ String

Set the text font.

Parameters:

  • font_arg (String) —

    the font

Returns:

  • (String) —

    the given font



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'ext/RMagick/rminfo.c', line 1213

VALUE
Info_font_eq(VALUE self, VALUE font_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    if (NIL_P(font_arg) || StringValueCStr(font_arg) == NULL)
    {
        magick_free(info->font);
        info->font = NULL;
    }
    else
    {
        char *font;

        font = StringValueCStr(font_arg);
        magick_clone_string(&info->font, font);
    }
    return font_arg;
}

#format ⇒ String?

Return the image encoding format.

Returns:

  • (String, nil) —

    the encoding format



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'ext/RMagick/rminfo.c', line 1239

VALUE Info_format(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    if (*info->magick)
    {
        const MagickInfo *magick_info;
        ExceptionInfo *exception;

        exception = AcquireExceptionInfo();
        magick_info = GetMagickInfo(info->magick, exception);
        DestroyExceptionInfo(exception);

        return magick_info ? rb_str_new2(magick_info->name) : Qnil;
    }

    return Qnil;
}

#format=(magick) ⇒ String

Set the image encoding format.

Parameters:

  • magick (String) —

    the encoding format

Returns:

  • (String) —

    the given format



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'ext/RMagick/rminfo.c', line 1265

VALUE
Info_format_eq(VALUE self, VALUE magick)
{
    Info *info;
    const MagickInfo *m;
    char *mgk;
    ExceptionInfo *exception;

    Data_Get_Struct(self, Info, info);

    mgk = StringValueCStr(magick);

    exception = AcquireExceptionInfo();
    m = GetMagickInfo(mgk, exception);
    CHECK_EXCEPTION();
    DestroyExceptionInfo(exception);

    if (!m)
    {
        rb_raise(rb_eArgError, "unknown format: %s", mgk);
    }

    strlcpy(info->magick, m->name, sizeof(info->magick));
    return magick;
}

#freeze ⇒ Object

Overrides freeze in classes that can’t be frozen.

No Ruby usage (internal function)

Raises:

  • (TypeError) 


306
307
308
309
310
 
# File 'ext/RMagick/rmutil.c', line 306

VALUE
rm_no_freeze(VALUE obj)
{
    rb_raise(rb_eTypeError, "can't freeze %s", rb_class2name(CLASS_OF(obj)));
}

#fuzz ⇒ Float

Get the fuzz.

Returns:

  • (Float) —

    the fuzz

See Also:



1297
1298
1299
1300
1301
 
# File 'ext/RMagick/rminfo.c', line 1297

VALUE
Info_fuzz(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, fuzz, dbl);
}

#fuzz=(fuzz) ⇒ Float, String

Set the fuzz.

Parameters:

  • fuzz (Float, String) —

    the fuzz with Float or percent format “xx%” with String

Returns:

  • (Float, String) —

    the given value

See Also:



1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'ext/RMagick/rminfo.c', line 1311

VALUE
Info_fuzz_eq(VALUE self, VALUE fuzz)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    info->fuzz = rm_fuzz_to_dbl(fuzz);
    return fuzz;
}

#gravity ⇒ Magick::GravityType

Return the value of the gravity option as a GravityType enumerator.

Returns:

  • (Magick::GravityType) —

    the gravity enumerator



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'ext/RMagick/rminfo.c', line 1377

VALUE Info_gravity(VALUE self)
{
    Info *info;
    const char *gravity;
    ID gravity_id;

    Data_Get_Struct(self, Info, info);

    gravity_id = rb_intern("UndefinedGravity");

    // Map the gravity option string to a GravityType enumerator.
    gravity = GetImageOption(info, "gravity");
    if (gravity)
    {
        for (int x = 0; x < N_GRAVITY_OPTIONS; x++)
        {
            if (strcmp(gravity, Gravity_Option[x].string) == 0)
            {
                gravity_id = rb_intern(Gravity_Option[x].enum_name);
                break;
            }
        }
    }

    return rb_const_get(Module_Magick, gravity_id);
}

#gravity=(grav) ⇒ Magick::GravityType

Convert a GravityType enum to a gravity option name and store in the Info structure.

Parameters:

  • grav (Magick::GravityType) —

    the gravity enumerator

Returns:

  • (Magick::GravityType) —

    the given gravity



1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'ext/RMagick/rminfo.c', line 1411

VALUE
Info_gravity_eq(VALUE self, VALUE grav)
{
    Info *info;
    GravityType gravity;
    const char *option;
    int x;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(grav))
    {
        DeleteImageOption(info, "gravity");
        return self;
    }

    VALUE_TO_ENUM(grav, gravity, GravityType);
    option = "Undefined";

    for (x = 0; x < N_GRAVITY_OPTIONS; x++)
    {
        if (gravity == Gravity_Option[x].enumerator)
        {
            option = Gravity_Option[x].string;
            break;
        }
    }

    SetImageOption(info, "gravity", option);
    return grav;
}

#image_type ⇒ Magick::ImageType

Get the classification type.

Returns:

  • (Magick::ImageType) —

    the classification type



1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'ext/RMagick/rminfo.c', line 1449

VALUE
Info_image_type(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return ImageType_find(info->type);
}

#image_type=(type) ⇒ Magick::ImageType

Set the classification type.

Parameters:

  • type (Magick::ImageType) —

    the classification type

Returns:

  • (Magick::ImageType) —

    the given type



1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'ext/RMagick/rminfo.c', line 1464

VALUE
Info_image_type_eq(VALUE self, VALUE type)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(type, info->type, ImageType);
    return type;
}

#interlace ⇒ Magick::InterlaceType

Get the interlace type.

Returns:

  • (Magick::InterlaceType) —

    the interlace type



1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'ext/RMagick/rminfo.c', line 1479

VALUE
Info_interlace(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return InterlaceType_find(info->interlace);
}

#interlace=(inter) ⇒ Magick::InterlaceType

Set the interlace type

Parameters:

  • inter (Magick::InterlaceType) —

    the interlace type

Returns:

  • (Magick::InterlaceType) —

    the given interlace



1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'ext/RMagick/rminfo.c', line 1494

VALUE
Info_interlace_eq(VALUE self, VALUE inter)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(inter, info->interlace, InterlaceType);
    return inter;
}

#label ⇒ String

Get the label.

Returns:

  • (String) —

    the label



1509
1510
1511
1512
 
# File 'ext/RMagick/rminfo.c', line 1509

VALUE Info_label(VALUE self)
{
    return get_option(self, "Label");
}

#label=(string) ⇒ String

Set the label.

Parameters:

  • string (String) —

    the label

Returns:

  • (String) —

    the given label



1520
1521
1522
1523
 
# File 'ext/RMagick/rminfo.c', line 1520

VALUE Info_label_eq(VALUE self, VALUE string)
{
    return set_option(self, "Label", string);
}

#matte_color ⇒ String

Return the name of the matte color as a String.

Returns:

  • (String) —

    the name of the matte color

See Also:



1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'ext/RMagick/rminfo.c', line 1531

VALUE
Info_matte_color(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return rm_pixelcolor_to_color_name_info(info, &info->matte_color);
}

#matte_color=(matte_arg) ⇒ Magick::Pixel, String

Set the matte color.

Parameters:

  • matte_arg (Magick::Pixel, String) —

    the name of the matte as a String

Returns:



1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
 
# File 'ext/RMagick/rminfo.c', line 1546

VALUE
Info_matte_color_eq(VALUE self, VALUE matte_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    Color_to_PixelColor(&info->matte_color, matte_arg);

    return matte_arg;
}

#monitor=(monitor) ⇒ Proc

Establish a progress monitor.

Parameters:

  • monitor (Proc) —

    the monitor

Returns:

  • (Proc) —

    monitor

See Also:



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'ext/RMagick/rminfo.c', line 1564

VALUE
Info_monitor_eq(VALUE self, VALUE monitor)
{
    Info *info;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(monitor))
    {
        info->progress_monitor = NULL;
    }
    else
    {
        SetImageInfoProgressMonitor(info, rm_progress_monitor, (void *)monitor);
    }

    return monitor;
}

#monochrome ⇒ Boolean

Get the monochrome value.

Returns:

  • (Boolean) —

    true or false



1588
1589
1590
1591
1592
 
# File 'ext/RMagick/rminfo.c', line 1588

VALUE
Info_monochrome(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, monochrome, boolean);
}

#monochrome=(val) ⇒ Boolean

Set the monochrome value.

Parameters:

  • val (Boolean) —

    true or false

Returns:

  • (Boolean) —

    the given value



1600
1601
1602
1603
1604
 
# File 'ext/RMagick/rminfo.c', line 1600

VALUE
Info_monochrome_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, monochrome, boolean);
}

#number_scenes ⇒ Numeric

Get the scene number of an image or the first image in a sequence.

Returns:

  • (Numeric) —

    the scene number



1611
1612
1613
1614
1615
 
# File 'ext/RMagick/rminfo.c', line 1611

VALUE
Info_number_scenes(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, number_scenes, ulong);
}

#number_scenes=(val) ⇒ Numeric

Set the scene number of an image or the first image in a sequence.

Parameters:

  • val (Numeric) —

    the scene number

Returns:

  • (Numeric) —

    the given value



1623
1624
1625
1626
1627
 
# File 'ext/RMagick/rminfo.c', line 1623

VALUE
Info_number_scenes_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, number_scenes, ulong);
}

#orientation ⇒ Magick::OrientationType

Return the orientation attribute as an OrientationType enum value.

Returns:

  • (Magick::OrientationType) —

    the orientation



1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'ext/RMagick/rminfo.c', line 1634

VALUE
Info_orientation(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return OrientationType_find(info->orientation);
}

#orientation=(inter) ⇒ Magick::OrientationType

Set the Orientation type.

Parameters:

  • inter (Magick::OrientationType) —

    the orientation type as an OrientationType enum value

Returns:

  • (Magick::OrientationType) —

    the given value



1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'ext/RMagick/rminfo.c', line 1650

VALUE
Info_orientation_eq(VALUE self, VALUE inter)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(inter, info->orientation, OrientationType);
    return inter;
}

#origin ⇒ String

Return origin geometry.

Returns:

  • (String) —

    the origin geometry

See Also:



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'ext/RMagick/rminfo.c', line 1667

VALUE
Info_origin(VALUE self)
{
    Info *info;
    const char *origin;

    Data_Get_Struct(self, Info, info);

    origin = GetImageOption(info, "origin");
    return origin ? rb_str_new2(origin) : Qnil;
}

#origin=(origin_arg) ⇒ String

Set origin geometry. Argument may be a Geometry object as well as a geometry string.

The geometry format is

+-x+-y

Parameters:

  • origin_arg (String) —

    the origin geometry

Returns:

  • (String) —

    the given value

See Also:



1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'ext/RMagick/rminfo.c', line 1691

VALUE
Info_origin_eq(VALUE self, VALUE origin_arg)
{
    Info *info;
    VALUE origin_str;
    char *origin;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(origin_arg))
    {
        DeleteImageOption(info, "origin");
        return self;
    }

    origin_str = rb_String(origin_arg);
    origin = GetPageGeometry(StringValueCStr(origin_str));

    if (IsGeometry(origin) == MagickFalse)
    {
        magick_free(origin);
        rb_raise(rb_eArgError, "invalid origin geometry");
    }

    SetImageOption(info, "origin", origin);
    magick_free(origin);

    RB_GC_GUARD(origin_str);

    return origin_arg;
}

#page ⇒ String

Get the Postscript page geometry.

Returns:

  • (String) —

    the page geometry



1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'ext/RMagick/rminfo.c', line 1729

VALUE
Info_page(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return info->page ? rb_str_new2(info->page) : Qnil;

}

#page=(page_arg) ⇒ String

Store the Postscript page geometry. Argument may be a Geometry object as well as a geometry string.

Parameters:

  • page_arg (String) —

    the geometry

Returns:

  • (String) —

    the given value

See Also:



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'ext/RMagick/rminfo.c', line 1747

VALUE
Info_page_eq(VALUE self, VALUE page_arg)
{
    Info *info;
    VALUE geom_str;
    char *geometry;

    Data_Get_Struct(self, Info, info);
    if (NIL_P(page_arg))
    {
        magick_free(info->page);
        info->page = NULL;
        return self;
    }
    geom_str = rb_String(page_arg);
    geometry = GetPageGeometry(StringValueCStr(geom_str));
    if (*geometry == '\0')
    {
        magick_free(info->page);
        info->page = NULL;
        return self;
    }
    info->page = geometry;

    RB_GC_GUARD(geom_str);

    return page_arg;
}

#pointsize ⇒ Float

Get the point size.

Returns:

  • (Float) —

    the point size



1781
1782
1783
1784
1785
 
# File 'ext/RMagick/rminfo.c', line 1781

VALUE
Info_pointsize(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, pointsize, dbl);
}

#pointsize=(val) ⇒ Float

Set the point size.

Parameters:

  • val (Float) —

    the point size

Returns:

  • (Float) —

    the given value



1793
1794
1795
1796
1797
 
# File 'ext/RMagick/rminfo.c', line 1793

VALUE
Info_pointsize_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, pointsize, dbl);
}

#quality ⇒ Numeric

Get the compression level for JPEG, etc.

Returns:

  • (Numeric) —

    the compression level



1804
1805
1806
1807
1808
 
# File 'ext/RMagick/rminfo.c', line 1804

VALUE
Info_quality(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, quality, ulong);
}

#quality=(val) ⇒ Numeric

Get the compression level for JPEG, etc.

Parameters:

  • val (Numeric) —

    the compression level

Returns:

  • (Numeric) —

    the given value



1816
1817
1818
1819
1820
 
# File 'ext/RMagick/rminfo.c', line 1816

VALUE
Info_quality_eq(VALUE self, VALUE val)
{
    IMPLEMENT_ATTR_WRITER(Info, quality, ulong);
}

#sampling_factor ⇒ String?

Get sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.

Returns:

  • (String, nil) —

    the sampling factors



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'ext/RMagick/rminfo.c', line 1827

VALUE
Info_sampling_factor(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    if (info->sampling_factor)
    {
        return rb_str_new2(info->sampling_factor);
    }
    else
    {
        return Qnil;
    }
}

#sampling_factor=(sampling_factor) ⇒ String

Set sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.

Parameters:

  • sampling_factor (String) —

    the sampling factors

Returns:

  • (String) —

    the given value



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'ext/RMagick/rminfo.c', line 1849

VALUE
Info_sampling_factor_eq(VALUE self, VALUE sampling_factor)
{
    Info *info;
    char *sampling_factor_p = NULL;
    long sampling_factor_len = 0;

    Data_Get_Struct(self, Info, info);

    if (!NIL_P(sampling_factor))
    {
        sampling_factor_p = rm_str2cstr(sampling_factor, &sampling_factor_len);
    }

    if (info->sampling_factor)
    {
        magick_free(info->sampling_factor);
        info->sampling_factor = NULL;
    }
    if (sampling_factor_len > 0)
    {
        magick_clone_string(&info->sampling_factor, sampling_factor_p);
    }

    return sampling_factor;
}

#scene ⇒ Numeric

Get the scene number.

Returns:

  • (Numeric) —

    the scene number



1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'ext/RMagick/rminfo.c', line 1882

VALUE
Info_scene(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return  ULONG2NUM(info->scene);
}

#scene=(scene) ⇒ Numeric

Set the scene number.

Parameters:

  • scene (Numeric) —

    the scene number

Returns:

  • (Numeric) —

    the given value



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'ext/RMagick/rminfo.c', line 1898

VALUE
Info_scene_eq(VALUE self, VALUE scene)
{
    Info *info;
    char buf[25];

    Data_Get_Struct(self, Info, info);
    info->scene = NUM2ULONG(scene);

    snprintf(buf, sizeof(buf), "%"RMIuSIZE"", info->scene);
    SetImageOption(info, "scene", buf);

    return scene;
}

#server_name ⇒ String

Get the server name.

Returns:

  • (String) —

    the server name



1919
1920
1921
1922
1923
 
# File 'ext/RMagick/rminfo.c', line 1919

VALUE
Info_server_name(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, server_name, str);
}

#server_name=(server_arg) ⇒ String

Set the server name.

Parameters:

  • server_arg (String) —

    the server name

Returns:

  • (String) —

    the given value



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'ext/RMagick/rminfo.c', line 1932

VALUE
Info_server_name_eq(VALUE self, VALUE server_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    if (NIL_P(server_arg) || StringValueCStr(server_arg) == NULL)
    {
        magick_free(info->server_name);
        info->server_name = NULL;
    }
    else
    {
        char *server;

        server = StringValueCStr(server_arg);
        magick_clone_string(&info->server_name, server);
    }
    return server_arg;
}

#size ⇒ String

Get ths size

Returns:

  • (String) —

    the size as a Geometry object

See Also:



1959
1960
1961
1962
1963
 
# File 'ext/RMagick/rminfo.c', line 1959

VALUE
Info_size(VALUE self)
{
    IMPLEMENT_ATTR_READER(Info, size, str);
}

#size=(size_arg) ⇒ String

Set the size (either as a Geometry object or a Geometry string

Parameters:

  • size_arg (String) —

    the size

Returns:

  • (String) —

    the given value

See Also:



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
 
# File 'ext/RMagick/rminfo.c', line 1972

VALUE
Info_size_eq(VALUE self, VALUE size_arg)
{
    Info *info;
    VALUE size;
    char *sz;

    Data_Get_Struct(self, Info, info);

    if (NIL_P(size_arg))
    {
        magick_free(info->size);
        info->size = NULL;
        return self;
    }

    size = rb_String(size_arg);
    sz = StringValueCStr(size);
    if (!IsGeometry(sz))
    {
        rb_raise(rb_eArgError, "invalid size geometry: %s", sz);
    }

    magick_clone_string(&info->size, sz);

    RB_GC_GUARD(size);

    return size_arg;
}

#stroke ⇒ String

Return the stroke color as a String.

Returns:

  • (String) —

    the stroke color



2008
2009
2010
2011
2012
 
# File 'ext/RMagick/rminfo.c', line 2008

VALUE
Info_stroke(VALUE self)
{
    return get_option(self, "stroke");
}

#stroke=(color) ⇒ String

Set the stroke color

Parameters:

  • color (String) —

    the stroke color

Returns:

  • (String) —

    the given value



2020
2021
2022
2023
2024
 
# File 'ext/RMagick/rminfo.c', line 2020

VALUE
Info_stroke_eq(VALUE self, VALUE color)
{
    return set_color_option(self, "stroke", color);
}

#stroke_width ⇒ Float

Get stroke width.

Returns:

  • (Float) —

    the stroke width



2032
2033
2034
2035
2036
 
# File 'ext/RMagick/rminfo.c', line 2032

VALUE
Info_stroke_width(VALUE self)
{
    return get_dbl_option(self, "strokewidth");
}

#stroke_width=(stroke_width) ⇒ Float

Set stroke width.

Parameters:

  • stroke_width (Float) —

    the stroke width

Returns:

  • (Float) —

    the given value



2045
2046
2047
2048
2049
 
# File 'ext/RMagick/rminfo.c', line 2045

VALUE
Info_stroke_width_eq(VALUE self, VALUE stroke_width)
{
    return set_dbl_option(self, "strokewidth", stroke_width);
}

#texture=(texture) ⇒ Magick::Image

Set name of texture to tile onto the image background.

Parameters:

Returns:



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'ext/RMagick/rminfo.c', line 2058

VALUE
Info_texture_eq(VALUE self, VALUE texture)
{
    Info *info;
    Image *image;
    char name[MaxTextExtent];

    Data_Get_Struct(self, Info, info);

    // Delete any existing texture file
    if (info->texture)
    {
        rm_delete_temp_image(info->texture);
        magick_free(info->texture);
        info->texture = NULL;
    }

    // If argument is nil we're done
    if (texture == Qnil)
    {
        return texture;
    }

    // Create a temp copy of the texture and store its name in the texture field
    image = rm_check_destroyed(texture);
    rm_write_temp_image(image, name, sizeof(name));

    magick_clone_string(&info->texture, name);

    return texture;
}

#tile_offset ⇒ String?

Return tile_offset geometry.

Returns:

  • (String, nil) —

    the tile offset

See Also:



2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
 
# File 'ext/RMagick/rminfo.c', line 2097

VALUE
Info_tile_offset(VALUE self)
{
    Info *info;
    const char *tile_offset;

    Data_Get_Struct(self, Info, info);

    tile_offset = GetImageOption(info, "tile-offset");

    if (!tile_offset)
    {
        return Qnil;
    }

    return rb_str_new2(tile_offset);
}

#tile_offset=(offset) ⇒ String

Set tile offset geometry.

Parameters:

  • offset (String) —

    the offset geometry

Returns:

  • (String) —

    the given value

See Also:



2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
 
# File 'ext/RMagick/rminfo.c', line 2123

VALUE
Info_tile_offset_eq(VALUE self, VALUE offset)
{
    Info *info;
    VALUE offset_str;
    char *tile_offset;

    offset_str = rb_String(offset);
    tile_offset = StringValueCStr(offset_str);
    if (!IsGeometry(tile_offset))
    {
        rb_raise(rb_eArgError, "invalid tile offset geometry: %s", tile_offset);
    }

    Data_Get_Struct(self, Info, info);

    DeleteImageOption(info, "tile-offset");
    SetImageOption(info, "tile-offset", tile_offset);

    RB_GC_GUARD(offset_str);

    return offset;
}

#transparent_color ⇒ String

Return the name of the transparent color.

Returns:

  • (String) —

    the name of the transparent color

See Also:



2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'ext/RMagick/rminfo.c', line 2154

VALUE
Info_transparent_color(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return rm_pixelcolor_to_color_name_info(info, &info->transparent_color);
}

#transparent_color=(tc_arg) ⇒ Magick::Pixel, String

Set the transparent color.

Parameters:

  • tc_arg (String) —

    the transparent color

Returns:



2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
 
# File 'ext/RMagick/rminfo.c', line 2170

VALUE
Info_transparent_color_eq(VALUE self, VALUE tc_arg)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    Color_to_PixelColor(&info->transparent_color, tc_arg);

    return tc_arg;
}

#undefine(format, key) ⇒ Magick::Info

Undefine image option.

Parameters:

  • format (String) —

    the format

  • key (String) —

    the key

Returns:

  • (Magick::Info) —

    self



2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'ext/RMagick/rminfo.c', line 2189

VALUE
Info_undefine(VALUE self, VALUE format, VALUE key)
{
    Info *info;
    char *format_p, *key_p;
    long format_l, key_l;
    char fkey[MaxTextExtent];

    format_p = rm_str2cstr(format, &format_l);
    key_p = rm_str2cstr(key, &key_l);

    if (format_l > MAX_FORMAT_LEN || format_l + key_l > MaxTextExtent)
    {
        rb_raise(rb_eArgError, "can't undefine %.60s:%.1024s - too long", format_p, key_p);
    }

    snprintf(fkey, sizeof(fkey), "%.60s:%.*s", format_p, (int)(MaxTextExtent-61), key_p);

    Data_Get_Struct(self, Info, info);
    DeleteImageOption(info, fkey);

    return self;
}

#undercolor ⇒ String

Return the undercolor color.

Returns:

  • (String) —

    the undercolor



2219
2220
2221
2222
2223
 
# File 'ext/RMagick/rminfo.c', line 2219

VALUE
Info_undercolor(VALUE self)
{
    return get_option(self, "undercolor");
}

#undercolor=(color) ⇒ String

Set the undercolor color.

Parameters:

  • color (String) —

    the undercolor color

Returns:

  • (String) —

    the given value



2231
2232
2233
2234
2235
 
# File 'ext/RMagick/rminfo.c', line 2231

VALUE
Info_undercolor_eq(VALUE self, VALUE color)
{
    return set_color_option(self, "undercolor", color);
}

#units ⇒ Magick::ResolutionType

Get the resolution type.

Returns:

  • (Magick::ResolutionType) —

    the resolution type



2242
2243
2244
2245
2246
2247
2248
2249
 
# File 'ext/RMagick/rminfo.c', line 2242

VALUE
Info_units(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    return ResolutionType_find(info->units);
}

#units=(units) ⇒ Magick::ResolutionType

Set the resolution type

Parameters:

  • units (Magick::ResolutionType) —

    the resolution type

Returns:

  • (Magick::ResolutionType) —

    the given value



2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'ext/RMagick/rminfo.c', line 2257

VALUE
Info_units_eq(VALUE self, VALUE units)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
    VALUE_TO_ENUM(units, info->units, ResolutionType);
    return units;
}

#view ⇒ String

Get FlashPix viewing parameters.

Returns:

  • (String) —

    the viewing parameters



2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
 
# File 'ext/RMagick/rminfo.c', line 2272

VALUE
Info_view(VALUE self)
{
    Info *info;

    Data_Get_Struct(self, Info, info);
#if defined(IMAGEMAGICK_7)
    return C_str_to_R_str(GetImageOption(info, "fpx:view"));
#else
    return C_str_to_R_str(info->view);
#endif
}

#view=(view_arg) ⇒ String

Set FlashPix viewing parameters.

Parameters:

  • view_arg (String) —

    the viewing parameters

Returns:

  • (String) —

    the given value



2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'ext/RMagick/rminfo.c', line 2291

VALUE
Info_view_eq(VALUE self, VALUE view_arg)
{
    Info *info;
    char *view = NULL;

    Data_Get_Struct(self, Info, info);

    if (!NIL_P(view_arg))
    {
        view = StringValueCStr(view_arg);
    }

#if defined(IMAGEMAGICK_7)
    if (view)
    {
        SetImageOption(info, "fpx:view", view);
    }
    else
    {
        RemoveImageOption(info, "fpx:view");
    }
#else
    if (info->view)
    {
        magick_free(info->view);
        info->view = NULL;
    }
    if (view)
    {
        magick_clone_string(&info->view, view);
    }
#endif
    return view_arg;
}