Scala Native SFML
DocsAPI
Generated with
Scala Native SFML/sfml/sfml.graphics/Color

Color

sfml.graphics.Color
See theColor companion object
trait Color(using ctor: ctor)

Utility class for manipulating RGBA colors.

Color is a simple color class composed of 4 components:

  • Red
  • Green
  • Blue
  • Alpha (opacity)

Each component is a public member, an unsigned integer in the range [0, 255]. Thus, colors can be constructed and manipulated very easily:

val color = Color(255, 0, 0) // red
val black = color.copy(r = 0) // make it black
val blue = color.copy(b = 128.toByte) // make it dark blue

The fourth component of colors, named "alpha", represents the opacity of the color. A color with an alpha value of 255 will be fully opaque, while an alpha value of 0 will make a color fully transparent, whatever the value of the other components is.

The most common colors are already defined as static variables:

val black = Color.Black()
val white = Color.White()
val red = Color.Red()
val green = Color.Green()
val blue = Color.Blue()
val yellow = Color.Yellow()
val magenta = Color.Magenta()
val cyan = Color.Cyan()
val transparent = Color.Transparent()

Value parameters

a

Alpha (opacity) component.

b

Blue component.

g

Green component.

r

Red component.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def !=(rhs: Immutable[Color]): Boolean
def ==(rhs: Immutable[Color]): Boolean
def a: Int
def a_=(a: Int): Unit
def b: Int
def b_=(b: Int): Unit
def copy(r: Int, g: Int, b: Int, a: Int): Color
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
def g: Int
def g_=(g: Int): Unit
def r: Int
def r_=(r: Int): Unit
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Generated with