Class: Yuki::GifReader

Inherits:

Object

• Object
• Yuki::GifReader

Defined in:

LiteRGSS.rb.yard.rb

Overview

Class that helps to read Gif

Defined Under Namespace

Classes: Error

Instance Attribute Summary

• #frame ⇒ Integer

  Return the frame index of the Gif image.

• #frame_count ⇒ Integer readonly

  Return the number of frame in the Gif image.

• #height ⇒ Integer

  Return the height of the Gif image.

• #width ⇒ Integer

  Return the width of the Gif image.

Class Method Summary

• .delta_counter=(value)

  Set the delta counter used to count frames.

• .new(filenameordata, from_memory = false)

  Create a new GifReader.

Instance Method Summary

• #draw(bitmap) ⇒ self

  Draw the current frame in a bitmap.

• #update(bitmap) ⇒ self

  Update the gif animation.

Instance Attribute Details

#frame ⇒ Integer

Return the frame index of the Gif image

Returns:

• (Integer) —

  Return the frame index of the Gif image

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

def frame
  @frame
end

#frame_count ⇒ Integer (readonly)

Return the number of frame in the Gif image

Returns:

• (Integer) —

  Return the number of frame in the Gif image

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

def frame_count
  @frame_count
end

#height ⇒ Integer

Return the height of the Gif image

Returns:

• (Integer) —

  Return the height of the Gif image

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

def height
  @height
end

#width ⇒ Integer

Return the width of the Gif image

Returns:

• (Integer) —

  Return the width of the Gif image

# 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

# 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)

# 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:

• bitmap (LiteRGSS::Bitmap) —

  texture that receive the frame

Returns:

• (self)

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

def draw(bitmap)

end

#update(bitmap) ⇒ self

Update the gif animation

Parameters:

• bitmap (LiteRGSS::Bitmap) —

  texture that receive the update

Returns:

• (self)

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

def update(bitmap)

end