Class: GdkPixbuf::Pixbuf

Inherits:
Object
  • Object
show all
Extended by:
GLib::Deprecatable
Defined in:
lib/gdk_pixbuf2/pixbuf.rb,
lib/gdk_pixbuf2/deprecated.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Pixbuf

Returns a new instance of Pixbuf.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 21

def initialize(*args)
  case args.size
  when 1
    case args[0]
    when Hash
      initialize_with_hash(args[0])
    when String
      message = "#{caller[0]}: #{self.class}.new(path) is deprecated. "
      message << "Use #{self.class}.new(:file => path) instead."
      warn message
      initialize_raw(args[0])
    when Array
      message = "#{caller[0]}: #{self.class}.new(xpm) is deprecated. "
      message << "Use #{self.class}.new(:xpm => xpm) instead."
      warn message
      initialize_new_from_xpm_data(args[0])
    else
      raise ArgumentError, "must be options: #{args[0].inspect}"
    end
  when 2
    message = "#{caller[0]}: "
    message << "#{self.class}.new(data, copy_pixels) is deprecated. "
    message << "Use Gio::Resource instead."
    warn message
    initialize_from_inline(*args)
  when 3
    message = "#{caller[0]}: "
    message << "#{self.class}.new(path, width, height) is deprecated. "
    message << "Use #{self.class}.new(:file => path, :width => width, "
    message << ":height => height) instead."
    warn message
    initialize_new_from_file_at_size(*args)
  when 4
    message = "#{caller[0]}: "
    message << "#{self.class}.new(path, width, height, "
    message << "preserve_aspect_ratio) is deprecated. "
    message << "Use #{self.class}.new(:file => path, :width => width, "
    message << ":height => height, "
    message << ":preserve_aspect_ratio => preserve_aspect_ratio) instead."
    warn message
    initialize_new_from_file_at_scale(*args)
  when 5
    message = "#{caller[0]}: "
    message << "#{self.class}.new(colorspace, has_alpha, bits_per_sample, "
    message << "width, height) is deprecated. "
    message << "Use #{self.class}.new(:colorspace => colorspace, "
    message << ":has_alpha => has_alpha, "
    message << ":bits_per_sample => bits_per_sample, "
    message << ":width => width, "
    message << ":height => height) instead."
    warn message
    initialize_new(*args)
  when 7
    message = "#{caller[0]}: "
    message << "#{self.class}.new(data, colorspace, has_alpha, "
    message << "bits_per_sample, width, height) is deprecated. "
    message << "Use #{self.class}.new(:data => data, "
    message << ":colorspace => colorspace, "
    message << ":has_alpha => has_alpha, "
    message << ":bits_per_sample => bits_per_sample, "
    message << ":width => width, "
    message << ":height => height) instead."
    warn message
    initialize_new_from_data(*args)
  else
    super
  end
end

Class Method Details

.new(*args, &block) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/gdk_pixbuf2/deprecated.rb', line 26

def new(*args, &block)
  if args[0].is_a?(Pixbuf)
    message = "#{caller[0]}: #{self}.new(pixbuf, ...) is deprecated. "
    message << "Use pixbuf.subpixbuf(...)  instead."
    warn(message)
    args[0].subpixbuf(*args[1..-1])
  elsif args.size == 1 and args[0].is_a?(Hash)
    options = args[0]
    src_pixbuf = options[:src_pixbuf]
    if src_pixbuf
      message = "#{caller[0]}: "
      message << "#{self}.new(:src_pixbuf => pixbuf, ...) is deprecated. "
      message << "Use pixbuf.subpixbuf(...)  instead."
      warn(message)
      src_pixbuf.subpixbuf(options[:src_x],
                           options[:src_y],
                           options[:width],
                           options[:height])
    else
      super
    end
  else
    super
  end
end

Instance Method Details

#composite(options) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 313

def composite(options)
  destination = options[:destination] || options[:dest]
  dest_x = options[:destination_x] || options[:dest_x] || 0
  dest_y = options[:destination_y] || options[:dest_y] || 0
  dest_width = options[:destination_width] || options[:dest_width]
  dest_height = options[:destination_height] || options[:dest_height]

  destination ||= Pixbuf.new(:colorspace => colorspace,
                             :has_alpha => has_alpha?,
                             :bits_per_sample => bits_per_sample,
                             :width => dest_x + dest_width,
                             :height => dest_y + dest_height)
  destination.composite!(self, options)
  destination
end

#composite!(source, options) ⇒ Object 



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
370
371
372
373
374
375
376
377
378
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 329

def composite!(source, options)
  dest_x = options[:destination_x] || options[:dest_x] || 0
  dest_y = options[:destination_y] || options[:dest_y] || 0
  dest_width = options[:destination_width] || options[:dest_width]
  dest_height = options[:destination_height] || options[:dest_height]
  offset_x = options[:offset_x] || 0.0
  offset_y = options[:offset_y] || 0.0
  scale_x = options[:scale_x] || (dest_width / source.width.to_f)
  scale_y = options[:scale_y] || (dest_height / source.height.to_f)
  interpolation_type = options[:interpolation_type] ||
    options[:interp_type] ||
    :bilinear
  overall_alpha = options[:overall_alpha] || 255
  check_x = options[:check_x] || 0
  check_y = options[:check_y] || 0
  check_size = options[:check_size]
  color1 = options[:color1] || 0x999999
  color2 = options[:color2] || 0xdddddd

  if check_size
    source.composite_color(self,
                           dest_x,
                           dest_y,
                           dest_width,
                           dest_height,
                           offset_x,
                           offset_y,
                           scale_x,
                           scale_y,
                           interpolation_type,
                           overall_alpha,
                           check_x,
                           check_y,
                           check_size,
                           color1,
                           color2)
  else
    source.composite_raw(self,
                         dest_x,
                         dest_y,
                         dest_width,
                         dest_height,
                         offset_x,
                         offset_y,
                         scale_x,
                         scale_y,
                         interpolation_type,
                         overall_alpha)
  end
end

#composite_raw ⇒ Object 



312
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 312

alias_method :composite_raw, :composite

#dup ⇒ Object 



184
185
186
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 184

def dup
  copy
end

#fill!(pixel) ⇒ Object 



194
195
196
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 194

def fill!(pixel)
  fill(pixel)
end

#initialize_raw ⇒ Object 



19
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 19

alias_method :initialize_raw, :initialize

#rotate(angle) ⇒ Object 



198
199
200
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 198

def rotate(angle)
  rotate_simple(angle)
end

#saturate_and_pixelate(saturation, pixelate) ⇒ Object 



203
204
205
206
207
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 203

def saturate_and_pixelate(saturation, pixelate)
  dest = dup
  saturate_and_pixelate_raw(dest, saturation, pixelate)
  dest
end

#saturate_and_pixelate_raw ⇒ Object 



202
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 202

alias_method :saturate_and_pixelate_raw, :saturate_and_pixelate

#save(type, options = {}) ⇒ String, void #save(filename, type, options = {}) ⇒ void

Overloads:

  • #save(type, options = {}) ⇒ String, void

    Save as ‘type` format.

    Parameters:

    • type (String) —

      The format to be saved. ‘“jpeg”`, `“png”`, `“ico”` and `“bmp”` are available by default.

    • options (Hash<Symbol, String>) (defaults to: {}) —

      The options for saving. Key-value pairs except ‘:filename` key are passed to save logic. Available keys are depended on format. For example, `:quality => “100”` is available in `“jpeg”` format.

    Options Hash (options):

    • :filename (String) —

      The filename to be outputted.

    Returns:

    • (String, void) —

      The saved data. If you specify ‘:filename` option, it returns nothing.

  • #save(filename, type, options = {}) ⇒ void
    Deprecated.

    since 3.1.1. Use ‘save(type, :filename => filename)` instead.

    This method returns an undefined value.

    Save to ‘filename` as `type` format.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 234

def save(*args)
  case args.size
  when 1
    arg1 = args[0]
    if arg1.respond_to?(:to_path)
      filename = arg1.to_path
    elsif arg1.is_a?(String) and arg1.include?(".")
      filename = args[0]
    else
      filename = nil
      type = arg1
    end
    if filename
      type = File.extname(filename).gsub(/\A\./, "").downcase
      case type
      when "jpg"
        type = "jpeg"
      end
    end
    options = {}
  when 2
    if args.last.is_a?(Hash)
      type, options = args
      if options.key?(:filename)
        options = options.dup
        filename = options.delete(:filename)
      else
        filename = nil
      end
    else
      filename, type = args
      options = {}
    end
  when 3
    filename, type, options = args
  else
    message = "wrong number of arguments (given #{args.size}, expected 1..3)"
    raise ArgumentError, message
  end

  keys = []
  values = []
  options.each do |key, value|
    key = key.to_s if key.is_a?(Symbol)
    keys << key
    values << value
  end
  if filename
    savev(filename, type, keys, values)
  else
    _, data = save_to_bufferv(type, keys, values)
    data.pack("C*")
  end
end

#scale(*args) ⇒ Object

TODO: test TODO: Improve API by Hash



292
293
294
295
296
297
298
299
300
301
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 292

def scale(*args)
  case args.size
  when 2, 3
    width, height, interp_type = args
    interp_type ||= :bilinear
    scale_simple(width, height, interp_type)
  else
    scale_raw(*args)
  end
end

#scale!(source, *args) ⇒ Object

TODO: test TODO: Improve API by Hash



305
306
307
308
309
310
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 305

def scale!(source, *args)
  if args.size == 8
    args << :bilinear
  end
  source.scale_raw(self, *args)
end

#scale_raw ⇒ Object 



289
 
# File 'lib/gdk_pixbuf2/pixbuf.rb', line 289

alias_method :scale_raw, :scale