Class: Gosu::Sample

Inherits:

Object

• Object
• Gosu::Sample

Defined in:

rdoc/gosu.rb

Overview

A sample is a short sound that is completely loaded in memory, can be played multiple times at once and offers very flexible playback parameters. Use samples for everything that’s not music.

See Also:

• Song

Instance Method Summary

• #initialize(filename) ⇒ Sample constructor

  Loads a sample from a file.

• #play(volume = 1, speed = 1, looping = false) ⇒ Channel

  Plays the sample without panning.

• #play_pan(pan = 0, volume = 1, speed = 1, looping = false) ⇒ Channel

  Plays the sample with panning.

Constructor Details

#initialize(filename) ⇒ Sample #initialize(window, filename) ⇒ Sample

Loads a sample from a file.

(Passing a Window reference is not necessary anymore, please use the first overload from now on.)

# File 'rdoc/gosu.rb', line 569

def initialize(filename); end

Instance Method Details

#play(volume = 1, speed = 1, looping = false) ⇒ Channel

Plays the sample without panning.

See Also:

• #play_pan

# File 'rdoc/gosu.rb', line 580

def play(volume=1, speed=1, looping=false); end

#play_pan(pan = 0, volume = 1, speed = 1, looping = false) ⇒ Channel

Plays the sample with panning.

See Also:

• #play

# File 'rdoc/gosu.rb', line 592

def play_pan(pan=0, volume=1, speed=1, looping=false); end