Class: Yuki::GifReader

Inherits:
Object show all
Defined in:
LiteRGSS.rb.yard.rb

Overview

Class that helps to read Gif

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#frameInteger

Return the frame index of the Gif image

Returns:

  • (Integer)

    Return the frame index of the Gif image



1243
1244
1245
# File 'LiteRGSS.rb.yard.rb', line 1243

def frame
  @frame
end

#frame_countInteger (readonly)

Return the number of frame in the Gif image

Returns:

  • (Integer)

    Return the number of frame in the Gif image



1245
1246
1247
# File 'LiteRGSS.rb.yard.rb', line 1245

def frame_count
  @frame_count
end

#heightInteger

Return the height of the Gif image

Returns:

  • (Integer)

    Return the height of the Gif image



1241
1242
1243
# File 'LiteRGSS.rb.yard.rb', line 1241

def height
  @height
end

#widthInteger

Return the width of the Gif image

Returns:

  • (Integer)

    Return the width of the Gif image



1239
1240
1241
# File 'LiteRGSS.rb.yard.rb', line 1239

def width
  @width
end

Class Method Details

.delta_counter=(value)

Set the delta counter used to count frames

Parameters:

  • value (Numeric)

    the number of miliseconds per frame



1266
1267
1268
# File 'LiteRGSS.rb.yard.rb', line 1266

def self.delta_counter=(value)

end

.new(filenameordata, from_memory = false)

Create a new GifReader

Parameters:

  • filenameordata (String)
  • from_memory (Boolean) (defaults to: false)


1249
1250
1251
# File 'LiteRGSS.rb.yard.rb', line 1249

def self.new(filenameordata, from_memory = false)

end

Instance Method Details

#draw(bitmap) ⇒ self

Draw the current frame in a bitmap

Parameters:

Returns:

  • (self)


1261
1262
1263
# File 'LiteRGSS.rb.yard.rb', line 1261

def draw(bitmap)

end

#update(bitmap) ⇒ self

Update the gif animation

Parameters:

Returns:

  • (self)


1255
1256
1257
# File 'LiteRGSS.rb.yard.rb', line 1255

def update(bitmap)

end