Class: Wx::AnimationDecoder

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/animation.rb

Overview

AnimationDecoder is used by Animation for loading frames and other information for the animation from the animation image file.

Requires:

  • USE_ANIMATIONCTRL

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::AnimationDecoder 



191
 
# File 'lib/wx/doc/gen/animation.rb', line 191

def initialize; end

Instance Method Details

#can_read(stream) ⇒ Boolean Also known as: can_read?

Returns true if this decoder supports loading from the given stream.

Parameters:

Returns:

  • (Boolean) 


201
 
# File 'lib/wx/doc/gen/animation.rb', line 201

def can_read(stream) end

#clone ⇒ Wx::AnimationDecoder

Create a copy of this decoder.

Returns:



206
 
# File 'lib/wx/doc/gen/animation.rb', line 206

def clone; end

#convert_to_image(frame) ⇒ Array(Boolean,Wx::Image)

Convert given frame to Image.

Parameters:

  • frame (Integer)

Returns:



216
 
# File 'lib/wx/doc/gen/animation.rb', line 216

def convert_to_image(frame) end

#do_can_read(stream) ⇒ Boolean (protected)

Checks the signature of the data in the given stream and returns true if it appears to be a valid animation format recognized by the animation decoder; this function should modify the stream current position without taking care of restoring it since can_read will do it.

Parameters:

Returns:

  • (Boolean) 


266
 
# File 'lib/wx/doc/gen/animation.rb', line 266

def do_can_read(stream) end

#get_animation_size ⇒ Wx::Size Also known as: animation_size

Returns:



249
 
# File 'lib/wx/doc/gen/animation.rb', line 249

def get_animation_size; end

#get_background_colour ⇒ Wx::Colour Also known as: background_colour

Returns:



253
 
# File 'lib/wx/doc/gen/animation.rb', line 253

def get_background_colour; end

#get_delay(frame) ⇒ Integer Also known as: delay

Return the number of milliseconds this frame should be displayed.

If -1 is returned then the frame must be displayed forever.

Parameters:

  • frame (Integer)

Returns:

  • (Integer) 


239
 
# File 'lib/wx/doc/gen/animation.rb', line 239

def get_delay(frame) end

#get_disposal_method(frame) ⇒ Wx::AnimationDisposal Also known as: disposal_method

What should be done after displaying this frame.

Parameters:

  • frame (Integer)

Returns:



231
 
# File 'lib/wx/doc/gen/animation.rb', line 231

def get_disposal_method(frame) end

#get_frame_count ⇒ Integer Also known as: frame_count

Returns:

  • (Integer) 


257
 
# File 'lib/wx/doc/gen/animation.rb', line 257

def get_frame_count; end

#get_frame_position(frame) ⇒ Wx::Point Also known as: frame_position

Parameters:

  • frame (Integer)

Returns:



225
 
# File 'lib/wx/doc/gen/animation.rb', line 225

def get_frame_position(frame) end

#get_frame_size(frame) ⇒ Wx::Size Also known as: frame_size

Parameters:

  • frame (Integer)

Returns:



220
 
# File 'lib/wx/doc/gen/animation.rb', line 220

def get_frame_size(frame) end

#get_transparent_colour(frame) ⇒ Wx::Colour Also known as: transparent_colour

The transparent colour for this frame, if any, or NULL_COLOUR.

Parameters:

  • frame (Integer)

Returns:



245
 
# File 'lib/wx/doc/gen/animation.rb', line 245

def get_transparent_colour(frame) end

#get_type ⇒ Wx::AnimationType Also known as: type

Return the animation type this decoder implements.

Returns:



210
 
# File 'lib/wx/doc/gen/animation.rb', line 210

def get_type; end

#load(stream) ⇒ Boolean

Load the animation image frames from the given stream.

Parameters:

Returns:

  • (Boolean) 


196
 
# File 'lib/wx/doc/gen/animation.rb', line 196

def load(stream) end