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 



502
503
504
505
506
507
508
509
510
 
# File 'ext/cairo/rb_cairo_surface.c', line 502

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

.create ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'ext/cairo/rb_cairo_surface.c', line 296

static VALUE
cr_surface_create (int argc, VALUE *argv, VALUE klass)
{
  VALUE rb_surface;
  rb_surface = rb_funcallv (klass, cr_id_new, argc, argv);
  if (rb_block_given_p ())
    {
      return rb_ensure (rb_cairo__surface_yield_and_finish, rb_surface,
                        cr_surface_destroy_with_destroy_check, rb_surface);
    }
  else
    {
      return rb_surface;
    }
}

.gl_supported? ⇒ Boolean

Returns:

  • (Boolean) 


408
409
410
411
412
413
414
415
416
 
# File 'ext/cairo/rb_cairo_surface.c', line 408

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) 


418
419
420
421
422
 
# File 'ext/cairo/rb_cairo_surface.c', line 418

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

.image_supported? ⇒ Boolean

Returns:

  • (Boolean) 


312
313
314
315
316
 
# File 'ext/cairo/rb_cairo_surface.c', line 312

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

.pdf_supported? ⇒ Boolean

Returns:

  • (Boolean) 


318
319
320
321
322
323
324
325
326
 
# File 'ext/cairo/rb_cairo_surface.c', line 318

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) 


328
329
330
331
332
333
334
335
336
 
# File 'ext/cairo/rb_cairo_surface.c', line 328

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) 


378
379
380
381
382
383
384
385
386
 
# File 'ext/cairo/rb_cairo_surface.c', line 378

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) 


338
339
340
341
342
343
344
345
346
 
# File 'ext/cairo/rb_cairo_surface.c', line 338

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) 


398
399
400
401
402
403
404
405
406
 
# File 'ext/cairo/rb_cairo_surface.c', line 398

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) 


388
389
390
391
392
393
394
395
396
 
# File 'ext/cairo/rb_cairo_surface.c', line 388

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
9
10
 
# File 'lib/cairo/surface.rb', line 4

def supported?(type)
  type_components = type.to_s.split(/([A-Z][a-z\d]+)/).reject(&:empty?)
  snake_case_type_name = type_components.join("_").downcase
  supported_predicate = "#{snake_case_type_name}_supported?"
  return false unless respond_to?(supported_predicate)
  send(supported_predicate)
end

.svg_supported? ⇒ Boolean

Returns:

  • (Boolean) 


358
359
360
361
362
363
364
365
366
 
# File 'ext/cairo/rb_cairo_surface.c', line 358

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) 


424
425
426
427
428
429
430
431
432
 
# File 'ext/cairo/rb_cairo_surface.c', line 424

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) 


368
369
370
371
372
373
374
375
376
 
# File 'ext/cairo/rb_cairo_surface.c', line 368

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) 


348
349
350
351
352
353
354
355
356
 
# File 'ext/cairo/rb_cairo_surface.c', line 348

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) 


434
435
436
437
438
439
440
441
442
 
# File 'ext/cairo/rb_cairo_surface.c', line 434

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) 


49
50
51
 
# File 'lib/cairo.rb', line 49

def clone
  raise NotImplementedError
end

#content ⇒ Object 



714
715
716
717
718
 
# File 'ext/cairo/rb_cairo_surface.c', line 714

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

#copy_page ⇒ Object 



968
969
970
971
972
973
974
 
# File 'ext/cairo/rb_cairo_surface.c', line 968

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

#create_similar ⇒ Object 



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

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);
  rb_cairo_surface_check_status (similar_surface);
  return CRSURFACE2RVAL_WITH_DESTROY (similar_surface);
}

#create_similar_image ⇒ Object 



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'ext/cairo/rb_cairo_surface.c', line 598

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);
  rb_cairo_surface_check_status (similar_image);
  return CRSURFACE2RVAL_WITH_DESTROY (similar_image);
}

#destroy ⇒ Object 



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

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

  surface = _SELF;
  cr_surface_destroy_raw (surface);
  RTYPEDDATA_DATA (self) = NULL;

  return self;
}

#device ⇒ Object 



707
708
709
710
711
 
# File 'ext/cairo/rb_cairo_surface.c', line 707

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

#device_offset ⇒ Object 



907
908
909
910
911
912
913
914
915
 
# File 'ext/cairo/rb_cairo_surface.c', line 907

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

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

#device_scale ⇒ Object 



928
929
930
931
932
933
934
935
 
# File 'ext/cairo/rb_cairo_surface.c', line 928

static VALUE
cr_surface_get_device_scale (VALUE self)
{
  double x_scale, y_scale;

  cairo_surface_get_device_scale (_SELF, &x_scale, &y_scale);
  return rb_ary_new3 (2, rb_float_new (x_scale), rb_float_new (y_scale));
}

#dup ⇒ Object

Raises:

  • (NotImplementedError) 


46
47
48
 
# File 'lib/cairo.rb', line 46

def dup
  raise NotImplementedError
end

#fallback_resolution ⇒ Object 



951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'ext/cairo/rb_cairo_surface.c', line 951

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);
  rb_cairo_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 



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'ext/cairo/rb_cairo_surface.c', line 525

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);
  RTYPEDDATA_DATA (self) = NULL;

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

  return self;
}

#flush ⇒ Object 



851
852
853
854
855
856
857
 
# File 'ext/cairo/rb_cairo_surface.c', line 851

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

#font_options ⇒ Object 



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'ext/cairo/rb_cairo_surface.c', line 830

static VALUE
cr_surface_get_font_options (VALUE self)
{
  cairo_font_options_t *options;
  VALUE rb_options;

  options = cairo_font_options_create ();
  rb_cairo_check_status (cairo_font_options_status (options));

  /* TODO: Use rb_ensure() */
  rb_options = CRFONTOPTIONS2RVAL (options);
  cairo_font_options_destroy (options);

  options = RVAL2CRFONTOPTIONS (rb_options);
  cairo_surface_get_font_options (_SELF, options);
  rb_cairo_surface_check_status (_SELF);
  rb_cairo_check_status (cairo_font_options_status (options));

  return rb_options;
}

#get_mime_data ⇒ Object 



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'ext/cairo/rb_cairo_surface.c', line 766

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 



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'ext/cairo/rb_cairo_surface.c', line 635

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_funcall (rb_extents, cr_id_x, 0));
          extents->y = NUM2INT (rb_funcall (rb_extents, cr_id_y, 0));
          extents->width = NUM2INT (rb_funcall (rb_extents, cr_id_width, 0));
          extents->height = NUM2INT (rb_funcall (rb_extents, cr_id_height, 0));
        }
      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);
  rb_cairo_surface_check_status (mapped_image);
  return CRSURFACE2RVAL_WITH_DESTROY (mapped_image);
}

#mark_dirty ⇒ Object 



859
860
861
862
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
892
893
894
895
 
# File 'ext/cairo/rb_cairo_surface.c', line 859

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));
    }

  rb_cairo_surface_check_status (_SELF);
  return self;
}

#reference_count ⇒ Object

Surface manipulation



513
514
515
516
517
518
519
520
521
522
523
 
# File 'ext/cairo/rb_cairo_surface.c', line 513

static VALUE
cr_surface_get_reference_count (VALUE self)
{
  cairo_surface_t *surface;
  unsigned int reference_count;

  surface = _SELF;
  reference_count = cairo_surface_get_reference_count (surface);

  return UINT2NUM (reference_count);
}

#set_device_offset ⇒ Object 



897
898
899
900
901
902
903
904
905
 
# File 'ext/cairo/rb_cairo_surface.c', line 897

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));
  rb_cairo_surface_check_status (_SELF);
  return self;
}

#set_device_scale ⇒ Object 



918
919
920
921
922
923
924
925
926
 
# File 'ext/cairo/rb_cairo_surface.c', line 918

static VALUE
cr_surface_set_device_scale (VALUE self, VALUE x_scale, VALUE y_scale)
{
  cairo_surface_set_device_scale (_SELF,
                                  NUM2DBL (x_scale),
                                  NUM2DBL (y_scale));
  rb_cairo_surface_check_status (_SELF);
  return self;
}

#set_fallback_resolution ⇒ Object 



938
939
940
941
942
943
944
945
946
947
948
 
# File 'ext/cairo/rb_cairo_surface.c', line 938

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));
  rb_cairo_surface_check_status (_SELF);
  return self;
}

#set_mime_data ⇒ Object 



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

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 



976
977
978
979
980
981
982
 
# File 'ext/cairo/rb_cairo_surface.c', line 976

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

#sub_rectangle_surface ⇒ Object 



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'ext/cairo/rb_cairo_surface.c', line 686

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));
  rb_cairo_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) 


816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'ext/cairo/rb_cairo_surface.c', line 816

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 



673
674
675
676
677
678
679
680
681
682
 
# File 'ext/cairo/rb_cairo_surface.c', line 673

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 



750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'ext/cairo/rb_cairo_surface.c', line 750

static VALUE
cr_surface_write_to_png_generic (VALUE self, VALUE target)
{
  if (rb_respond_to (target, rb_cairo__io_id_to_path) &&
      !rb_respond_to (target, rb_cairo__io_id_to_io))
    {
      target = rb_funcall (target, rb_cairo__io_id_to_path, 0);
    }
  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);
}