Class: Gosu::Color

Inherits:
Object show all
Defined in:
lib/fidgit/gosu_ext/color.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Color) argb(alpha, red, green, blue)

ARGB in 0..255 format (equivalent to Color.new, but explicit)

Parameters:

  • alpha (Integer)
  • red (Integer)
  • green (Integer)
  • blue (Integer)

Returns:



36
37
38
# File 'lib/fidgit/gosu_ext/color.rb', line 36

def self.argb(alpha, red, green, blue)
  new(alpha, red, green, blue)
end

+ (Color) from_tex_play(color)

Convert from an RGBA array, as used by TexPlay.

Parameters:

  • color (Array<Float>)

    TexPlay color [r, g, b, a] in range 0.0..1.0

Returns:



69
70
71
# File 'lib/fidgit/gosu_ext/color.rb', line 69

def self.from_tex_play(color)
  rgba(*color.map {|c| (c * 255).to_i })
end

+ (Color) hsv(hue, saturation, value)

HSV format (alpha assumed to be 255)

Parameters:

  • hue (Float)

    0.0..360.0

  • saturation (Float)

    0.0..1.0

  • value (Float)

    0.0..1.0

Returns:



46
47
48
# File 'lib/fidgit/gosu_ext/color.rb', line 46

def self.hsv(hue, saturation, value)
  from_hsv(hue, saturation, value)
end

+ (Color) hsva(hue, saturation, value, alpha)

HSVA format

Parameters:

  • hue (Float)

    0.0..360.0

  • saturation (Float)

    0.0..1.0

  • value (Float)

    0.0..1.0

  • alpha (Integer)

    1..255

Returns:



57
58
59
# File 'lib/fidgit/gosu_ext/color.rb', line 57

def self.hsva(hue, saturation, value, alpha)
  from_ahsv(alpha, hue, saturation, value)
end

+ (Color) rgb(red, green, blue)

RGB in 0..255 format (Alpha assumed 255)

Parameters:

  • red (Integer)
  • green (Integer)
  • blue (Integer)

Returns:



16
17
18
# File 'lib/fidgit/gosu_ext/color.rb', line 16

def self.rgb(red, green, blue)
  new(255, red, green, blue)
end

+ (Color) rgba(red, green, blue, alpha)

RGBA in 0..255 format

Parameters:

  • red (Integer)
  • green (Integer)
  • blue (Integer)
  • alpha (Integer)

Returns:



27
28
29
# File 'lib/fidgit/gosu_ext/color.rb', line 27

def self.rgba(red, green, blue, alpha)
  new(alpha, red, green, blue)
end

Instance Method Details

- (Object) +(other)

Raises:

  • (ArgumentError)


102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/fidgit/gosu_ext/color.rb', line 102

def +(other)
  raise ArgumentError, "Can only add another #{self.class}" unless other.is_a? Color

  copy = Color.new(0)

  copy.red = [red + other.red, 255].min
  copy.green = [green + other.green, 255].min
  copy.blue = [blue + other.blue, 255].min
  copy.alpha = [alpha + other.alpha, 255].min

  copy
end

- (Object) -(other)

Raises:

  • (ArgumentError)


115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/fidgit/gosu_ext/color.rb', line 115

def -(other)
  raise ArgumentError, "Can only take away another #{self.class}" unless other.is_a? Color

  copy = Color.new(0)

  copy.red = [red - other.red, 0].max
  copy.green = [green - other.green, 0].max
  copy.blue = [blue - other.blue, 0].max
  copy.alpha = [alpha - other.alpha, 0].max

  copy
end

- (Object) ==(other)



128
129
130
131
132
133
134
# File 'lib/fidgit/gosu_ext/color.rb', line 128

def ==(other)
  if other.is_a? Color
    red == other.red and green == other.green and blue == other.blue and alpha == other.alpha
  else
    false
  end
end

- (Object) colorize(text)

Colorize text for in-line rendering by Gosu. e.g. “frog” => “<c=00ff9a>frog</c>”



89
90
91
# File 'lib/fidgit/gosu_ext/color.rb', line 89

def colorize(text)
  "<c=#{to_hex}>#{text}</c>"
end

- (Boolean) opaque?

Is the color completely opaque?

Returns:

  • (Boolean)


8
# File 'lib/fidgit/gosu_ext/color.rb', line 8

def opaque?; alpha == 255; end

- (String) to_hex

Convert to a 6-digit hexadecimal value, appropriate for passing to the Gosu <c> tag. The alpha channel is ignored.

Returns:

  • (String)

    RGB hexadecimal string, such as “AABB00”



83
84
85
# File 'lib/fidgit/gosu_ext/color.rb', line 83

def to_hex
  "%02x%02x%02x" % [red, green, blue]
end

- (Object) to_s

Show the Color as <RGBA [0, 0, 0, 0]> or, if opaque, <RGB [0, 0, 0]> (Gosu default is '(ARGB:0/0/0/0)')



94
95
96
97
98
99
100
# File 'lib/fidgit/gosu_ext/color.rb', line 94

def to_s
  if opaque?
    "<RGB [#{red}, #{green}, #{blue}]>"
  else
    "<RGBA [#{red}, #{green}, #{blue}, #{alpha}]>"
  end
end

- (Array<Float>) to_tex_play

Convert to an RGBA array, as used by TexPlay.

Returns:

  • (Array<Float>)

    TexPlay color array [r, g, b, a] in range 0.0..1.0



76
77
78
# File 'lib/fidgit/gosu_ext/color.rb', line 76

def to_tex_play
  [red / 255.0, green / 255.0, blue / 255.0,  alpha / 255.0]
end

- (Boolean) transparent?

Is the color completely transparent?

Returns:

  • (Boolean)


6
# File 'lib/fidgit/gosu_ext/color.rb', line 6

def transparent?; alpha == 0; end