Class: Yuki::GifReader

Inherits:
Object show all
Defined in:
LiteRGSS.rb.yard.rb,
docs/0_Dependencies.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

Constructor Details

#initialize(filenameordata, from_memory = false) ⇒ GifReader

Create a new GifReader

Parameters:

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


1258
1259
1260
# File 'LiteRGSS.rb.yard.rb', line 1258

def initialize(filenameordata, from_memory = false)

end

Instance Attribute Details

#frame ⇒ Integer

Return the frame index of the Gif image

Returns:

  • (Integer) —

    Return the frame index of the Gif image



1252
1253
1254
# File 'LiteRGSS.rb.yard.rb', line 1252

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



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

def frame_count
  @frame_count
end

#height ⇒ Integer

Return the height of the Gif image

Returns:

  • (Integer) —

    Return the height of the Gif image



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

def height
  @height
end

#width ⇒ Integer

Return the width of the Gif image

Returns:

  • (Integer) —

    Return the width of the Gif image



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

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:



597
598
# File 'docs/0_Dependencies.rb', line 597

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



1275
1276
1277
# File 'LiteRGSS.rb.yard.rb', line 1275

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)


604
605
# File 'docs/0_Dependencies.rb', line 604

def exist?(filename, cache_name, hue = 0)
end

Instance Method Details

#draw(bitmap) ⇒ self

Draw the current frame in a bitmap

Parameters:

Returns:

  • (self)


1270
1271
1272
# File 'LiteRGSS.rb.yard.rb', line 1270

def draw(bitmap)

end

#old_update



607
# File 'docs/0_Dependencies.rb', line 607

alias old_update update

#update(bitmap) ⇒ self

Update the gif animation

Parameters:

Returns:

  • (self)


611
612
# File 'docs/0_Dependencies.rb', line 611

def update(bitmap)
end