Class: Cairo::Surface

Inherits:
Object
  • Object
show all
Defined in:
lib/cairo.rb,
lib/cairo/surface.rb,
ext/cairo/rb_cairo_surface.c

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object 



431
432
433
434
435
436
437
438
439
 
# File 'ext/cairo/rb_cairo_surface.c', line 431

static VALUE
cr_surface_initialize (int argc, VALUE *argv, VALUE self)
{
  rb_raise(rb_eNotImpError,
           "%s class creation isn't supported on this cairo installation",
           rb_obj_classname(self));

  return Qnil;
}

Class Method Details

.gl_supported? ⇒ Boolean

Returns:

  • (Boolean) 


325
326
327
328
329
330
331
332
333
 
# File 'ext/cairo/rb_cairo_surface.c', line 325

static VALUE
cr_surface_gl_supported_p (VALUE klass)
{
#ifdef RB_CAIRO_HAS_GL_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.gl_texture_supported? ⇒ Boolean

Returns:

  • (Boolean) 


335
336
337
338
339
 
# File 'ext/cairo/rb_cairo_surface.c', line 335

static VALUE
cr_surface_gl_texture_supported_p (VALUE klass)
{
  return cr_surface_gl_supported_p(klass);
}

.image_supported? ⇒ Boolean

Returns:

  • (Boolean) 


229
230
231
232
233
 
# File 'ext/cairo/rb_cairo_surface.c', line 229

static VALUE
cr_surface_image_supported_p (VALUE klass)
{
  return Qtrue;
}

.pdf_supported? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
239
240
241
242
243
 
# File 'ext/cairo/rb_cairo_surface.c', line 235

static VALUE
cr_surface_pdf_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_PDF_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.ps_supported? ⇒ Boolean

Returns:

  • (Boolean) 


245
246
247
248
249
250
251
252
253
 
# File 'ext/cairo/rb_cairo_surface.c', line 245

static VALUE
cr_surface_ps_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_PS_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.quartz_image_supported? ⇒ Boolean

Returns:

  • (Boolean) 


295
296
297
298
299
300
301
302
303
 
# File 'ext/cairo/rb_cairo_surface.c', line 295

static VALUE
cr_surface_quartz_image_supported_p (VALUE klass)
{
#ifdef RB_CAIRO_HAS_QUARTZ_IMAGE_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.quartz_supported? ⇒ Boolean

Returns:

  • (Boolean) 


255
256
257
258
259
260
261
262
263
 
# File 'ext/cairo/rb_cairo_surface.c', line 255

static VALUE
cr_surface_quartz_supported_p (VALUE klass)
{
#ifdef RB_CAIRO_HAS_QUARTZ_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.recording_supported? ⇒ Boolean

Returns:

  • (Boolean) 


315
316
317
318
319
320
321
322
323
 
# File 'ext/cairo/rb_cairo_surface.c', line 315

static VALUE
cr_surface_recording_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_RECORDING_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.script_supported? ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
308
309
310
311
312
313
 
# File 'ext/cairo/rb_cairo_surface.c', line 305

static VALUE
cr_surface_script_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_SCRIPT_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.supported?(type) ⇒ Boolean

Returns:

  • (Boolean) 


4
5
6
7
8
 
# File 'lib/cairo/surface.rb', line 4

def supported?(type)
  supported_predicate = "#{type.to_s.downcase}_supported?"
  return false unless respond_to?(supported_predicate)
  send(supported_predicate)
end

.svg_supported? ⇒ Boolean

Returns:

  • (Boolean) 


275
276
277
278
279
280
281
282
283
 
# File 'ext/cairo/rb_cairo_surface.c', line 275

static VALUE
cr_surface_svg_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_SVG_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.tee_supported? ⇒ Boolean

Returns:

  • (Boolean) 


341
342
343
344
345
346
347
348
349
 
# File 'ext/cairo/rb_cairo_surface.c', line 341

static VALUE
cr_surface_tee_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_TEE_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.win32_printing_supported? ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
288
289
290
291
292
293
 
# File 'ext/cairo/rb_cairo_surface.c', line 285

static VALUE
cr_surface_win32_printing_supported_p (VALUE klass)
{
#ifdef RB_CAIRO_HAS_WIN32_PRINTING_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.win32_supported? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
268
269
270
271
272
273
 
# File 'ext/cairo/rb_cairo_surface.c', line 265

static VALUE
cr_surface_win32_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_WIN32_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

.xml_supported? ⇒ Boolean

Returns:

  • (Boolean) 


351
352
353
354
355
356
357
358
359
 
# File 'ext/cairo/rb_cairo_surface.c', line 351

static VALUE
cr_surface_xml_supported_p (VALUE klass)
{
#ifdef CAIRO_HAS_XML_SURFACE
  return Qtrue;
#else
  return Qfalse;
#endif
}

Instance Method Details

#clone ⇒ Object

Raises:

  • (NotImplementedError) 


72
73
74
 
# File 'lib/cairo.rb', line 72

def clone
  raise NotImplementedError
end

#content ⇒ Object 



645
646
647
648
649
 
# File 'ext/cairo/rb_cairo_surface.c', line 645

static VALUE
cr_surface_get_content (VALUE self)
{
  return INT2NUM (cairo_surface_get_content (_SELF));
}

#copy_page ⇒ Object 



862
863
864
865
866
867
868
 
# File 'ext/cairo/rb_cairo_surface.c', line 862

static VALUE
cr_surface_copy_page (VALUE self)
{
  cairo_surface_copy_page (_SELF);
  cr_surface_check_status (_SELF);
  return self;
}

#create_similar ⇒ Object 



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
 
# File 'ext/cairo/rb_cairo_surface.c', line 490

static VALUE
cr_surface_create_similar (int argc, VALUE *argv, VALUE self)
{
  cairo_surface_t *surface, *similar_surface;
  cairo_content_t content;
  int width, height;
  VALUE arg1, arg2, arg3;

  rb_scan_args (argc, argv, "21", &arg1, &arg2, &arg3);

  surface = _SELF;
  if (argc == 2)
    {
      content = cairo_surface_get_content (surface);
      width = NUM2INT (arg1);
      height = NUM2INT (arg2);
    }
  else
    {
      content = RVAL2CRCONTENT (arg1);
      width = NUM2INT (arg2);
      height = NUM2INT (arg3);
    }

  similar_surface = cairo_surface_create_similar (surface, content,
                                                  width, height);
  cr_surface_check_status (similar_surface);
  return CRSURFACE2RVAL_WITH_DESTROY (similar_surface);
}

#create_similar_image ⇒ Object 



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'ext/cairo/rb_cairo_surface.c', line 521

static VALUE
cr_surface_create_similar_image (int argc, VALUE *argv, VALUE self)
{
  cairo_surface_t *surface, *similar_image;
  cairo_format_t format;
  int width, height;
  VALUE arg1, arg2, arg3;

  rb_scan_args (argc, argv, "21", &arg1, &arg2, &arg3);

  surface = _SELF;
  if (argc == 2)
    {
      if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_IMAGE)
        {
          format = cairo_image_surface_get_format (surface);
        }
      else
        {
          format = CAIRO_FORMAT_ARGB32;
        }
      width = NUM2INT (arg1);
      height = NUM2INT (arg2);
    }
  else
    {
      format = RVAL2CRFORMAT (arg1);
      width = NUM2INT (arg2);
      height = NUM2INT (arg3);
    }

  similar_image = cairo_surface_create_similar_image (surface, format,
                                                      width, height);
  cr_surface_check_status (similar_image);
  return CRSURFACE2RVAL_WITH_DESTROY (similar_image);
}

#destroy ⇒ Object

Surface manipulation



442
443
444
445
446
447
448
449
450
451
452
 
# File 'ext/cairo/rb_cairo_surface.c', line 442

static VALUE
cr_surface_destroy (VALUE self)
{
  cairo_surface_t *surface;

  surface = _SELF;
  cairo_surface_destroy (surface);
  DATA_PTR (self) = NULL;

  return self;
}

#device ⇒ Object 



638
639
640
641
642
 
# File 'ext/cairo/rb_cairo_surface.c', line 638

static VALUE
cr_surface_get_device (VALUE self)
{
  return CRDEVICE2RVAL (cairo_surface_get_device (_SELF));
}

#device_offset ⇒ Object 



822
823
824
825
826
827
828
829
830
 
# File 'ext/cairo/rb_cairo_surface.c', line 822

static VALUE
cr_surface_get_device_offset (VALUE self)
{
  double x_offset, y_offset;

  cairo_surface_get_device_offset (_SELF, &x_offset, &y_offset);
  cr_surface_check_status (_SELF);
  return rb_ary_new3 (2, rb_float_new (x_offset), rb_float_new (y_offset));
}

#dup ⇒ Object

Raises:

  • (NotImplementedError) 


69
70
71
 
# File 'lib/cairo.rb', line 69

def dup
  raise NotImplementedError
end

#fallback_resolution ⇒ Object 



845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'ext/cairo/rb_cairo_surface.c', line 845

static VALUE
cr_surface_get_fallback_resolution (VALUE self)
{
  double x_pixels_per_inch, y_pixels_per_inch;

  cairo_surface_get_fallback_resolution (_SELF,
                                         &x_pixels_per_inch,
                                         &y_pixels_per_inch);
  cr_surface_check_status (_SELF);
  return rb_ary_new3 (2,
                      rb_float_new (x_pixels_per_inch),
                      rb_float_new (y_pixels_per_inch));
}

#finish ⇒ Object 



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'ext/cairo/rb_cairo_surface.c', line 454

static VALUE
cr_surface_finish (VALUE self)
{
  cairo_surface_t *surface;
  rb_cairo__io_callback_closure_t *closure;

  surface = _SELF;
  closure = cairo_surface_get_user_data (surface, &cr_closure_key);

  cairo_surface_finish (surface);
  cairo_surface_set_user_data (surface, &cr_finished_key, (void *)CR_TRUE, NULL);
  cairo_surface_set_user_data (surface, &cr_object_holder_key, NULL, NULL);

  if (closure && !NIL_P (closure->error))
    rb_exc_raise (closure->error);
  cr_surface_check_status (surface);

  return self;
}

#flush ⇒ Object 



766
767
768
769
770
771
772
 
# File 'ext/cairo/rb_cairo_surface.c', line 766

static VALUE
cr_surface_flush (VALUE self)
{
  cairo_surface_flush (_SELF);
  cr_surface_check_status (_SELF);
  return self;
}

#font_options ⇒ Object 



756
757
758
759
760
761
762
763
764
 
# File 'ext/cairo/rb_cairo_surface.c', line 756

static VALUE
cr_surface_get_font_options (VALUE self)
{
  cairo_font_options_t *options = cairo_font_options_create();
  cairo_surface_get_font_options (_SELF, options);
  cr_surface_check_status (_SELF);
  rb_cairo_check_status (cairo_font_options_status (options));
  return CRFONTOPTIONS2RVAL (options);
}

#get_mime_data ⇒ Object 



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'ext/cairo/rb_cairo_surface.c', line 692

static VALUE
cr_surface_get_mime_data (VALUE self, VALUE mime_type)
{
  cairo_surface_t *surface;
  const unsigned char *data;
  unsigned long length;

  surface = _SELF;
  cairo_surface_get_mime_data (surface, StringValueCStr (mime_type),
                               &data, &length);
  if (data)
    return rb_str_new ((const char *)data, length);
  else
    return Qnil;
}

#map_to_image ⇒ Object 



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'ext/cairo/rb_cairo_surface.c', line 558

static VALUE
cr_surface_map_to_image (int argc, VALUE *argv, VALUE self)
{
  cairo_surface_t *surface, *mapped_image;
  cairo_rectangle_int_t extents_value;
  cairo_rectangle_int_t *extents = NULL;
  VALUE rb_extents;

  rb_scan_args (argc, argv, "01", &rb_extents);

  surface = _SELF;
  if (!NIL_P (rb_extents))
    {
      extents = &extents_value;
      if (rb_cairo__is_kind_of (rb_extents, rb_cCairo_Rectangle))
        {
          extents->x = NUM2INT (rb_iv_get (rb_extents, "@x"));
          extents->y = NUM2INT (rb_iv_get (rb_extents, "@y"));
          extents->width = NUM2INT (rb_iv_get (rb_extents, "@width"));
          extents->height = NUM2INT (rb_iv_get (rb_extents, "@height"));
        }
      else
        {
          VALUE *values;
          rb_extents = rb_convert_type (rb_extents, T_ARRAY, "Array", "to_ary");
          values = RARRAY_PTR (rb_extents);
          extents->x = NUM2INT (values[0]);
          extents->y = NUM2INT (values[1]);
          extents->height = NUM2INT (values[2]);
          extents->width = NUM2INT (values[3]);
        }
    }

  mapped_image = cairo_surface_map_to_image (surface, extents);
  cr_surface_check_status (mapped_image);
  return CRSURFACE2RVAL_WITH_DESTROY (mapped_image);
}

#mark_dirty ⇒ Object 



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'ext/cairo/rb_cairo_surface.c', line 774

static VALUE
cr_surface_mark_dirty (int argc, VALUE *argv, VALUE self)
{
  VALUE x, y, width, height;
  int n;

  n = rb_scan_args (argc, argv, "04", &x, &y, &width, &height);

  if (n == 0)
    {
      cairo_surface_mark_dirty (_SELF);
    }
  else if (n == 4)
    {
      cairo_surface_mark_dirty_rectangle (_SELF,
                                          NUM2INT (x), NUM2INT (y),
                                          NUM2INT (width), NUM2INT (height));
    }
  else
    {
      int i;
      VALUE args;

      args = rb_ary_new2 (n);
      for (i = 0; i < n; i++)
        {
          rb_ary_push (args, argv[i]);
        }

      rb_raise (rb_eArgError,
                "invalid argument (expect () or (x, y, width, height)): %s",
                rb_cairo__inspect (args));
    }

  cr_surface_check_status (_SELF);
  return self;
}

#set_device_offset ⇒ Object 



812
813
814
815
816
817
818
819
820
 
# File 'ext/cairo/rb_cairo_surface.c', line 812

static VALUE
cr_surface_set_device_offset (VALUE self, VALUE x_offset, VALUE y_offset)
{
  cairo_surface_set_device_offset (_SELF,
                                   NUM2DBL (x_offset),
                                   NUM2DBL (y_offset));
  cr_surface_check_status (_SELF);
  return self;
}

#set_fallback_resolution ⇒ Object 



832
833
834
835
836
837
838
839
840
841
842
 
# File 'ext/cairo/rb_cairo_surface.c', line 832

static VALUE
cr_surface_set_fallback_resolution (VALUE self,
                                    VALUE x_pixels_per_inch,
                                    VALUE y_pixels_per_inch)
{
  cairo_surface_set_fallback_resolution (_SELF,
                                         NUM2DBL (x_pixels_per_inch),
                                         NUM2DBL (y_pixels_per_inch));
  cr_surface_check_status (_SELF);
  return self;
}

#set_mime_data ⇒ Object 



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
 
# File 'ext/cairo/rb_cairo_surface.c', line 708

static VALUE
cr_surface_set_mime_data (VALUE self, VALUE rb_mime_type, VALUE rb_data)
{
  cairo_status_t status;
  cairo_surface_t *surface;
  const char *mime_type;

  surface = _SELF;
  mime_type = StringValueCStr (rb_mime_type);
  if (NIL_P (rb_data))
    {
      status = cairo_surface_set_mime_data (surface, mime_type,
                                            NULL, 0, NULL, NULL);
    }
  else
    {
      const char *raw_data;
      unsigned char *data;
      unsigned long length;

      raw_data = StringValuePtr (rb_data);
      length = RSTRING_LEN (rb_data);
      data = xmalloc (length);
      memcpy (data, raw_data, length);
      status = cairo_surface_set_mime_data (surface, mime_type,
                                            data, length,
                                            xfree, data);
    }
  rb_cairo_check_status (status);
  return Qnil;
}

#show_page ⇒ Object 



870
871
872
873
874
875
876
 
# File 'ext/cairo/rb_cairo_surface.c', line 870

static VALUE
cr_surface_show_page (VALUE self)
{
  cairo_surface_show_page (_SELF);
  cr_surface_check_status (_SELF);
  return self;
}

#sub_rectangle_surface ⇒ Object 



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'ext/cairo/rb_cairo_surface.c', line 617

static VALUE
cr_surface_create_sub_rectangle_surface (VALUE self, VALUE x, VALUE y,
                                         VALUE width, VALUE height)
{
  VALUE rb_surface;
  cairo_surface_t *surface;

  surface = cairo_surface_create_for_rectangle (RVAL2CRSURFACE (self),
                                                NUM2DBL (x),
                                                NUM2DBL (y),
                                                NUM2DBL (width),
                                                NUM2INT (height));
  cr_surface_check_status (surface);
  rb_surface = CRSURFACE2RVAL_WITH_DESTROY (surface);
  if (rb_block_given_p ())
    return rb_ensure (rb_yield, rb_surface,
                      cr_surface_destroy_with_destroy_check, rb_surface);
  else
    return rb_surface;
}

#supported_mime_type? ⇒ Boolean

Returns:

  • (Boolean) 


742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'ext/cairo/rb_cairo_surface.c', line 742

static VALUE
cr_surface_supported_mime_type_p (VALUE self, VALUE rb_mime_type)
{
  cairo_surface_t *surface;
  const char *mime_type;
  cairo_bool_t supported_p;

  surface = _SELF;
  mime_type = StringValueCStr (rb_mime_type);
  supported_p = cairo_surface_supports_mime_type (surface, mime_type);
  return CBOOL2RVAL (supported_p);
}

#unmap_image ⇒ Object 



596
597
598
599
600
601
602
603
604
605
 
# File 'ext/cairo/rb_cairo_surface.c', line 596

static VALUE
cr_surface_unmap_image (VALUE self, VALUE rb_mapped_image)
{
  cairo_surface_t *surface, *mapped_image;

  surface = _SELF;
  mapped_image = RVAL2CRSURFACE (rb_mapped_image);
  cairo_surface_unmap_image (surface, mapped_image);
  return Qnil;
}

#write_to_png ⇒ Object 



681
682
683
684
685
686
687
688
 
# File 'ext/cairo/rb_cairo_surface.c', line 681

static VALUE
cr_surface_write_to_png_generic (VALUE self, VALUE target)
{
  if (rb_respond_to (target, rb_cairo__io_id_write))
    return cr_surface_write_to_png_stream (self, target);
  else
    return cr_surface_write_to_png (self, target);
}