Class: Yuki::GifReader

Inherits:

Object

• Object
• Yuki::GifReader

Defined in:

LiteRGSS.rb.yard.rb,
docs/01500_Yuki.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

• .create(filename, cache_name, hue = 0) ⇒ GifReader^?

  Create a new GifReader from archives.

• .delta_counter=(value)

  Set the delta counter used to count frames.

• .exist?(filename, cache_name, hue = 0) ⇒ Boolean

  Check if a Gif Exists.

• .new(filenameordata, from_memory = false)

  Create a new GifReader.

Instance Method Summary

• #draw(bitmap) ⇒ self

  Draw the current frame in a bitmap.

• #old_update
• #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 1245

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 1247

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 1243

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 1241

def width
  @width
end

Class Method Details

.create(filename, cache_name, hue = 0) ⇒ GifReader^?

Create a new GifReader from archives

Parameters:

• filename (String) —

  name of the gif file, including the .gif extension

• cache_name (Symbol) —

  name of the cache where to load the gif file

• hue (Integer) (defaults to: 0) —

  0 = normal, 1 = shiny for Pokemon battlers

Returns:

• (GifReader, nil)

# File 'docs/01500_Yuki.rb', line 863

def create(filename, cache_name, hue = 0)
end

.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 1268

def self.delta_counter=(value)

end

.exist?(filename, cache_name, hue = 0) ⇒ Boolean

Check if a Gif Exists

Parameters:

• filename (String) —

  name of the gif file, including the .gif extension

• cache_name (Symbol) —

  name of the cache where to load the gif file

• hue (Integer) (defaults to: 0) —

  0 = normal, 1 = shiny for Pokemon battlers

Returns:

• (Boolean)

# File 'docs/01500_Yuki.rb', line 870

def exist?(filename, cache_name, hue = 0)
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 1251

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 1263

def draw(bitmap)

end

#old_update

# File 'docs/01500_Yuki.rb', line 873

alias old_update update

#update(bitmap) ⇒ self

Update the gif animation

Parameters:

• bitmap (LiteRGSS::Bitmap) —

  texture that receive the update

Returns:

• (self)

# File 'docs/01500_Yuki.rb', line 877

def update(bitmap)
end