Class: Magick::Pixel
- Inherits:
-
Object
- Object
- Magick::Pixel
- Includes:
- Comparable
- Defined in:
- ext/RMagick/rmmain.c
Class Method Summary collapse
-
.from_color(name) ⇒ Object
Method: Magick::Pixel.from_color(string) Purpose: Construct an Magick::Pixel corresponding to the given color name.
-
.from_HSL(hsl) ⇒ Object
Method: Pixel.from_HSL *** DEPRECATED *** Purpose: Constructs an RGB pixel from the array [hue, saturation, luminosity].
-
.from_hsla(*args) ⇒ Object
Method: Pixel#from_hsla(hue, saturation, lightness, alpha=1) Purpose: Replace brain-dead from_HSL, above.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Method: Pixel#<=> Purpose: Support Comparable mixin.
-
#===(other) ⇒ Object
Method: Pixel#=== Purpose: “Case equal” operator for Pixel.
-
#clone ⇒ Object
Method: Pixel#clone Notes: see dup, init_copy.
- #dup ⇒ Object
-
#eql?(other) ⇒ Boolean
Method: Pixel#eql? Purpose: For use with Hash.
-
#fcmp(*args) ⇒ Object
Method: Pixel#fcmp(other[, fuzz[, colorspace]]) Purpose: Compare pixel values for equality.
-
#hash ⇒ Object
Method: Pixel#hash Notes: INT2FIX left-shifts 1 bit.
-
#initialize(*args) ⇒ Object
constructor
Method: Pixel#initialize(red=0,green=0,blue=0,opacity=0) Notes: For backward compatibility, arguments may be nil.
-
#initialize_copy(orig) ⇒ Object
Method: Pixel#initialize_copy Purpose: initialize clone, dup methods.
-
#intensity ⇒ Object
Method: Pixel#intensity Purpose: Return the “intensity” of a pixel.
-
#marshal_dump ⇒ Object
Method: Pixel#marshal_dump Purpose: Support Marshal.dump.
-
#marshal_load(dpixel) ⇒ Object
Method: Pixel#marshal_load Purpose: Support Marshal.load.
-
#to_color(*args) ⇒ Object
Method: Magick::Pixel#to_color(compliance=AllCompliance, matte=false, depth=QuantumDepth, hex=false) Purpose: return the color name corresponding to the pixel values Notes: the conversion respects the value of the ‘opacity’ field in the Pixel.
-
#to_HSL ⇒ Object
Method: Pixel#to_HSL *** DEPRECATED *** Purpose: Converts an RGB pixel to the array [hue, saturation, luminosity].
-
#to_hsla ⇒ Object
Method: Pixel#to_hsla() Purpose: Replace brain-dead to_HSL, above.
-
#to_s ⇒ Object
Method: Magick::Pixel#to_s Purpose: Create a string representation of a Magick::Pixel.
Constructor Details
#initialize(*args) ⇒ Object
Method: Pixel#initialize(red=0,green=0,blue=0,opacity=0) Notes: For backward compatibility, arguments may be nil.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'ext/RMagick/rmpixel.c', line 485
VALUE
Pixel_initialize(int argc, VALUE *argv, VALUE self)
{
Pixel *pixel;
Data_Get_Struct(self, Pixel, pixel);
switch(argc)
{
case 4:
if (argv[3] != Qnil)
{
pixel->opacity = APP2QUANTUM(argv[3]);
}
case 3:
if (argv[2] != Qnil)
{
pixel->blue = APP2QUANTUM(argv[2]);
}
case 2:
if (argv[1] != Qnil)
{
pixel->green = APP2QUANTUM(argv[1]);
}
case 1:
if (argv[0] != Qnil)
{
pixel->red = APP2QUANTUM(argv[0]);
}
case 0:
break;
default:
rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 to 4)", argc);
}
return self;
}
|
Class Method Details
.from_color(name) ⇒ Object
Method: Magick::Pixel.from_color(string) Purpose: Construct an Magick::Pixel corresponding to the given color name. Notes: the “inverse” is Image *#to_color, b/c the conversion of a pixel
to a color name requires both a color depth and if the opacity
value has meaning (i.e. whether image->matte == True or not).
Also see Magick::Pixel#to_color, below.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'ext/RMagick/rmpixel.c', line 279
VALUE
Pixel_from_color(VALUE class, VALUE name)
{
PixelPacket pp;
ExceptionInfo exception;
MagickBooleanType okay;
class = class; // defeat "never referenced" message from icc
GetExceptionInfo(&exception);
okay = QueryColorDatabase(StringValuePtr(name), &pp, &exception);
CHECK_EXCEPTION()
(void) DestroyExceptionInfo(&exception);
if (!okay)
{
rb_raise(rb_eArgError, "invalid color name: %s", StringValuePtr(name));
}
return Pixel_from_PixelPacket(&pp);
}
|
.from_HSL(hsl) ⇒ Object
Method: Pixel.from_HSL *** DEPRECATED *** Purpose: Constructs an RGB pixel from the array
[hue, saturation, luminosity].
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'ext/RMagick/rmpixel.c', line 377
VALUE
Pixel_from_HSL(VALUE class, VALUE hsl)
{
PixelPacket rgb;
double hue, saturation, luminosity;
class = class; // defeat "never referenced" message from icc
memset(&rgb, 0, sizeof(rgb));
hsl = rb_Array(hsl); // Ensure array
if (RARRAY_LEN(hsl) < 3)
{
rb_raise(rb_eArgError, "array argument must have at least 3 elements");
}
hue = NUM2DBL(rb_ary_entry(hsl, 0));
saturation = NUM2DBL(rb_ary_entry(hsl, 1));
luminosity = NUM2DBL(rb_ary_entry(hsl, 2));
rb_warning("Pixel#from_HSL is deprecated; use from_hsla");
ConvertHSLToRGB(hue, saturation, luminosity,
&rgb.red, &rgb.green, &rgb.blue);
return Pixel_from_PixelPacket(&rgb);
}
|
.from_hsla(*args) ⇒ Object
Method: Pixel#from_hsla(hue, saturation, lightness, alpha=1) Purpose: Replace brain-dead from_HSL, above. Notes: 0 <= hue < 360, 0 <= saturation <= 1, 0 <= lightness <= 1
0 <= alpha <= 1 (0 is transparent, 1 is opaque)
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 367 368 369 |
# File 'ext/RMagick/rmpixel.c', line 308
VALUE
Pixel_from_hsla(int argc, VALUE *argv, VALUE class)
{
double h, s, l, a = 1.0;
MagickPixelPacket pp;
ExceptionInfo exception;
char name[50];
MagickBooleanType alpha = MagickFalse;
class = class; // defeat "unused parameter" message.
switch (argc)
{
case 4:
a = NUM2DBL(argv[3]);
alpha = MagickTrue;
case 3:
l = NUM2DBL(argv[2]);
s = NUM2DBL(argv[1]);
h = NUM2DBL(argv[0]);
break;
default:
rb_raise(rb_eArgError, "wrong number of arguments (%d for 3 or 4)", argc);
break;
}
if (alpha && (a < 0.0 || a > 1.0))
{
rb_raise(rb_eRangeError, "alpha %g out of range [0.0, 1.0]", a);
}
if (l < 0.0 || l > 100.0)
{
rb_raise(rb_eRangeError, "lightness %g out of range [0.0, 100.0]", l);
}
if (s < 0.0 || s > 100.0)
{
rb_raise(rb_eRangeError, "saturation %g out of range [0.0, 100.0]", s);
}
if (h < 0.0 || h >= 360.0)
{
rb_raise(rb_eRangeError, "hue %g out of range [0.0, 360.0)", h);
}
memset(name, 0, sizeof(name));
if (alpha)
{
sprintf(name, "hsla(%-2.1f,%-2.1f,%-2.1f,%-2.1f)", h, s, l, a);
}
else
{
sprintf(name, "hsl(%-2.1f,%-2.1f,%-2.1f)", h, s, l);
}
GetExceptionInfo(&exception);
(void) QueryMagickColor(name, &pp, &exception);
CHECK_EXCEPTION()
(void) DestroyExceptionInfo(&exception);
return Pixel_from_MagickPixelPacket(&pp);
}
|
Instance Method Details
#<=>(other) ⇒ Object
Method: Pixel#<=> Purpose: Support Comparable mixin
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 |
# File 'ext/RMagick/rmpixel.c', line 586
VALUE
Pixel_spaceship(VALUE self, VALUE other)
{
Pixel *this, *that;
Data_Get_Struct(self, Pixel, this);
Data_Get_Struct(other, Pixel, that);
if (this->red != that->red)
{
return INT2NUM((this->red - that->red)/abs(this->red - that->red));
}
else if(this->green != that->green)
{
return INT2NUM((this->green - that->green)/abs(this->green - that->green));
}
else if(this->blue != that->blue)
{
return INT2NUM((this->blue - that->blue)/abs(this->blue - that->blue));
}
else if(this->opacity != that->opacity)
{
return INT2NUM((this->opacity - that->opacity)/abs(this->opacity - that->opacity));
}
// Values are equal, check class.
return rb_funcall(CLASS_OF(self), rb_intern("<=>"), 1, CLASS_OF(other));
}
|
#===(other) ⇒ Object
Method: Pixel#=== Purpose: “Case equal” operator for Pixel
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'ext/RMagick/rmpixel.c', line 143
VALUE
Pixel_case_eq(VALUE self, VALUE other)
{
Pixel *this, *that;
if (CLASS_OF(self) == CLASS_OF(other))
{
Data_Get_Struct(self, Pixel, this);
Data_Get_Struct(other, Pixel, that);
return (this->red == that->red
&& this->blue == that->blue
&& this->green == that->green
&& this->opacity == that->opacity) ? Qtrue : Qfalse;
}
return Qfalse;
}
|
#clone ⇒ Object
Method: Pixel#clone Notes: see dup, init_copy
166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'ext/RMagick/rmpixel.c', line 166
VALUE
Pixel_clone(VALUE self)
{
volatile VALUE clone;
clone = Pixel_dup(self);
if (OBJ_FROZEN(self))
{
OBJ_FREEZE(clone);
}
return clone;
}
|
#dup ⇒ Object
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'ext/RMagick/rmpixel.c', line 181
VALUE
Pixel_dup(VALUE self)
{
Pixel *pixel;
volatile VALUE dup;
pixel = ALLOC(Pixel);
memset(pixel, '\0', sizeof(Pixel));
dup = Data_Wrap_Struct(CLASS_OF(self), NULL, destroy_Pixel, pixel);
if (rb_obj_tainted(self))
{
(void) rb_obj_taint(dup);
}
return rb_funcall(dup, rm_ID_initialize_copy, 1, self);
}
|
#eql?(other) ⇒ Boolean
Method: Pixel#eql? Purpose: For use with Hash
202 203 204 205 206 |
# File 'ext/RMagick/rmpixel.c', line 202
VALUE
Pixel_eql_q(VALUE self, VALUE other)
{
return NUM2INT(Pixel_spaceship(self, other)) == 0 ? Qtrue : Qfalse;
}
|
#fcmp(*args) ⇒ Object
Method: Pixel#fcmp(other[, fuzz[, colorspace]]) Purpose: Compare pixel values for equality
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 |
# File 'ext/RMagick/rmpixel.c', line 213
VALUE
Pixel_fcmp(int argc, VALUE *argv, VALUE self)
{
Image *image;
Info *info;
Pixel *this, *that;
ColorspaceType colorspace = RGBColorspace;
double fuzz = 0.0;
unsigned int equal;
switch (argc)
{
case 3:
VALUE_TO_ENUM(argv[2], colorspace, ColorspaceType);
case 2:
fuzz = NUM2DBL(argv[1]);
case 1:
// Allow 1 argument
break;
default:
rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 to 3)", argc);
break;
}
Data_Get_Struct(self, Pixel, this);
Data_Get_Struct(argv[0], Pixel, that);
// The IsColorSimilar function expects to get the
// colorspace and fuzz parameters from an Image structure.
info = CloneImageInfo(NULL);
if (!info)
{
rb_raise(rb_eNoMemError, "not enough memory to continue");
}
image = AcquireImage(info);
// Delete Info now in case we have to raise an exception
(void) DestroyImageInfo(info);
if (!image)
{
rb_raise(rb_eNoMemError, "not enough memory to continue");
}
image->colorspace = colorspace;
image->fuzz = fuzz;
equal = IsColorSimilar(image, this, that);
(void) DestroyImage(image);
return equal ? Qtrue : Qfalse;
}
|
#hash ⇒ Object
Method: Pixel#hash Notes: INT2FIX left-shifts 1 bit. Sacrifice 1 bit
from the opacity attribute to the FIXNUM_FLAG.
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
# File 'ext/RMagick/rmpixel.c', line 444
VALUE
Pixel_hash(VALUE self)
{
Pixel *pixel;
unsigned int hash;
Data_Get_Struct(self, Pixel, pixel);
hash = ScaleQuantumToChar(pixel->red) << 24;
hash += ScaleQuantumToChar(pixel->green) << 16;
hash += ScaleQuantumToChar(pixel->blue) << 8;
hash += ScaleQuantumToChar(pixel->opacity);
hash >>= 1;
return INT2FIX(hash);
}
|
#initialize_copy(orig) ⇒ Object
Method: Pixel#initialize_copy Purpose: initialize clone, dup methods
467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'ext/RMagick/rmpixel.c', line 467
VALUE
Pixel_init_copy(VALUE self, VALUE orig)
{
Pixel *copy, *original;
Data_Get_Struct(orig, Pixel, original);
Data_Get_Struct(self, Pixel, copy);
*copy = *original;
return self;
}
|
#intensity ⇒ Object
Method: Pixel#intensity Purpose: Return the “intensity” of a pixel
528 529 530 531 532 533 534 535 536 537 538 539 540 541 |
# File 'ext/RMagick/rmpixel.c', line 528
VALUE
Pixel_intensity(VALUE self)
{
Pixel *pixel;
Quantum intensity;
Data_Get_Struct(self, Pixel, pixel);
intensity = ROUND_TO_QUANTUM((0.299*pixel->red)
+ (0.587*pixel->green)
+ (0.114*pixel->blue));
return QUANTUM2NUM((unsigned long) intensity);
}
|
#marshal_dump ⇒ Object
Method: Pixel#marshal_dump Purpose: Support Marshal.dump
548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'ext/RMagick/rmpixel.c', line 548
VALUE
Pixel_marshal_dump(VALUE self)
{
Pixel *pixel;
volatile VALUE dpixel;
Data_Get_Struct(self, Pixel, pixel);
dpixel = rb_hash_new();
rb_hash_aset(dpixel, CSTR2SYM("red"), QUANTUM2NUM(pixel->red));
rb_hash_aset(dpixel, CSTR2SYM("green"), QUANTUM2NUM(pixel->green));
rb_hash_aset(dpixel, CSTR2SYM("blue"), QUANTUM2NUM(pixel->blue));
rb_hash_aset(dpixel, CSTR2SYM("opacity"), QUANTUM2NUM(pixel->opacity));
return dpixel;
}
|
#marshal_load(dpixel) ⇒ Object
Method: Pixel#marshal_load Purpose: Support Marshal.load
568 569 570 571 572 573 574 575 576 577 578 579 |
# File 'ext/RMagick/rmpixel.c', line 568
VALUE
Pixel_marshal_load(VALUE self, VALUE dpixel)
{
Pixel *pixel;
Data_Get_Struct(self, Pixel, pixel);
pixel->red = NUM2QUANTUM(rb_hash_aref(dpixel, CSTR2SYM("red")));
pixel->green = NUM2QUANTUM(rb_hash_aref(dpixel, CSTR2SYM("green")));
pixel->blue = NUM2QUANTUM(rb_hash_aref(dpixel, CSTR2SYM("blue")));
pixel->opacity = NUM2QUANTUM(rb_hash_aref(dpixel, CSTR2SYM("opacity")));
return self;
}
|
#to_color(*args) ⇒ Object
Method: Magick::Pixel#to_color(compliance=AllCompliance, matte=false,
depth=QuantumDepth, hex=false)
Purpose: return the color name corresponding to the pixel values Notes: the conversion respects the value of the ‘opacity’ field
in the Pixel.
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 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 |
# File 'ext/RMagick/rmpixel.c', line 685
VALUE
Pixel_to_color(int argc, VALUE *argv, VALUE self)
{
Info *info;
Image *image;
Pixel *pixel;
MagickPixelPacket mpp;
MagickBooleanType hex = MagickFalse;
char name[MaxTextExtent];
ExceptionInfo exception;
ComplianceType compliance = AllCompliance;
unsigned int matte = MagickFalse;
unsigned int depth = QuantumDepth;
switch (argc)
{
case 4:
hex = RTEST(argv[3]);
case 3:
depth = NUM2UINT(argv[2]);
// Ensure depth is appropriate for the way xMagick was compiled.
switch (depth)
{
case 8:
#if QuantumDepth == 16 || QuantumDepth == 32
case 16:
#endif
#if QuantumDepth == 32
case 32:
#endif
break;
default:
rb_raise(rb_eArgError, "invalid depth (%d)", depth);
break;
}
case 2:
matte = RTEST(argv[1]);
case 1:
VALUE_TO_ENUM(argv[0], compliance, ComplianceType);
case 0:
break;
default:
rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 to 2)", argc);
}
Data_Get_Struct(self, Pixel, pixel);
info = CloneImageInfo(NULL);
image = AcquireImage(info);
image->depth = depth;
image->matte = matte;
(void) DestroyImageInfo(info);
GetMagickPixelPacket(image, &mpp);
rm_set_magick_pixel_packet(pixel, &mpp);
GetExceptionInfo(&exception);
#if defined(HAVE_NEW_QUERYMAGICKCOLORNAME)
// Support for hex-format color names moved out of QueryMagickColorname
// in 6.4.1-9. The 'hex' argument was removed as well.
if (hex)
{
if (compliance == XPMCompliance)
{
mpp.matte = MagickFalse;
mpp.depth = (unsigned long) min(1.0 * image->depth, 16.0);
}
(void) GetColorTuple(&mpp, MagickTrue, name);
}
else
{
(void) QueryMagickColorname(image, &mpp, compliance, name, &exception);
}
#else
(void) QueryMagickColorname(image, &mpp, compliance, hex, name, &exception);
#endif
(void) DestroyImage(image);
CHECK_EXCEPTION()
(void) DestroyExceptionInfo(&exception);
// Always return a string, even if it's ""
return rb_str_new2(name);
}
|
#to_HSL ⇒ Object
Method: Pixel#to_HSL *** DEPRECATED *** Purpose: Converts an RGB pixel to the array
[hue, saturation, luminosity].
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'ext/RMagick/rmpixel.c', line 659
VALUE
Pixel_to_HSL(VALUE self)
{
Pixel *pixel;
double hue, saturation, luminosity;
volatile VALUE hsl;
Data_Get_Struct(self, Pixel, pixel);
rb_warning("Pixel#to_HSL is deprecated; use to_hsla");
ConvertRGBToHSL(pixel->red, pixel->green, pixel->blue, &hue, &saturation, &luminosity);
hsl = rb_ary_new3(3, rb_float_new(hue), rb_float_new(saturation),
rb_float_new(luminosity));
return hsl;
}
|
#to_hsla ⇒ Object
Method: Pixel#to_hsla() Purpose: Replace brain-dead to_HSL, above. Notes: Returns [hue, saturation, lightness, alpha] in the same ranges as from_hsla()
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
# File 'ext/RMagick/rmpixel.c', line 623
VALUE
Pixel_to_hsla(VALUE self)
{
double hue, sat, lum, alpha;
Pixel *pixel;
volatile VALUE hsla;
Data_Get_Struct(self, Pixel, pixel);
ConvertRGBToHSL(pixel->red, pixel->green, pixel->blue, &hue, &sat, &lum);
hue *= 360.0;
sat *= 100.0;
lum *= 100.0;
if (pixel->opacity == OpaqueOpacity)
{
alpha = 1.0;
}
else if (pixel->opacity == TransparentOpacity)
{
alpha = 0.0;
}
else
{
alpha = ROUND_TO_QUANTUM(QuantumRange - (pixel->opacity / QuantumRange));
}
hsla = rb_ary_new3(4, rb_float_new(hue), rb_float_new(sat), rb_float_new(lum), rb_float_new(alpha));
return hsla;
}
|
#to_s ⇒ Object
Method: Magick::Pixel#to_s Purpose: Create a string representation of a Magick::Pixel
776 777 778 779 780 781 782 783 784 785 786 |
# File 'ext/RMagick/rmpixel.c', line 776
VALUE
Pixel_to_s(VALUE self)
{
Pixel *pixel;
char buff[100];
Data_Get_Struct(self, Pixel, pixel);
sprintf(buff, "red=" QuantumFormat ", green=" QuantumFormat ", blue=" QuantumFormat ", opacity=" QuantumFormat
, pixel->red, pixel->green, pixel->blue, pixel->opacity);
return rb_str_new2(buff);
}
|