Color Class

Extends ValueType

Module: cc Parent Module: cc

Representation of RGBA colors.

Each color component is a floating point value with a range from 0 to 255.

You can also use the convenience method cc.color to create a new Color.

Index

Properties
  • WHITE Color Solid white, RGBA is [255, 255, 255, 255].
  • BLACK Color Solid black, RGBA is [0, 0, 0, 255].
  • TRANSPARENT Color Transparent, RGBA is [0, 0, 0, 0].
  • GRAY Color Grey, RGBA is [127.5, 127.5, 127.5].
  • RED Color Solid red, RGBA is [255, 0, 0].
  • GREEN Color Solid green, RGBA is [0, 255, 0].
  • BLUE Color Solid blue, RGBA is [0, 0, 255].
  • YELLOW Color Yellow, RGBA is [255, 235, 4].
  • ORANGE Color Orange, RGBA is [255, 127, 0].
  • CYAN Color Cyan, RGBA is [0, 255, 255].
  • MAGENTA Color Magenta, RGBA is [255, 0, 255].
Methods
  • constructor
  • clone Clone a new color from the current color.
  • equals TODO
  • lerp TODO
  • toString TODO
  • getR Gets red channel value
  • setR Sets red value and return the current color object
  • getG Gets green channel value
  • setG Sets green value and return the current color object
  • getB Gets blue channel value
  • setB Sets blue value and return the current color object
  • getA Gets alpha channel value
  • setA Sets alpha value and return the current color object
  • toCSS Convert color to css format.
  • fromHEX Read hex string and store color data into the current color object, the hex string must be formated as rgba or rgb.
  • toHEX convert Color to HEX color string.
  • toRGBValue Convert to 24bit rgb value.
  • fromHSV Read HSV model color and convert to RGB color
  • toHSV Transform to HSV model color
  • set Copys all the properties from another given object to this value.

Details

Properties

WHITE

Solid white, RGBA is [255, 255, 255, 255].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:78
BLACK

Solid black, RGBA is [0, 0, 0, 255].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:86
TRANSPARENT

Transparent, RGBA is [0, 0, 0, 0].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:94
GRAY

Grey, RGBA is [127.5, 127.5, 127.5].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:102
RED

Solid red, RGBA is [255, 0, 0].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:110
GREEN

Solid green, RGBA is [0, 255, 0].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:118
BLUE

Solid blue, RGBA is [0, 0, 255].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:126
YELLOW

Yellow, RGBA is [255, 235, 4].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:134
ORANGE

Orange, RGBA is [255, 127, 0].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:142
CYAN

Cyan, RGBA is [0, 255, 255].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:150
MAGENTA

Magenta, RGBA is [255, 0, 255].

meta description
Type Color
Defined in cocos2d/core/value-types/color.js:158

Methods

constructor
meta description
Defined in cocos2d/core/value-types/color.js:53
Parameters
  • r Number red component of the color, default value is 0.
  • g Number green component of the color, defualt value is 0.
  • b Number blue component of the color, default value is 0.
  • a Number alpha component of the color, default value is 255.
clone

Clone a new color from the current color.

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:177
Examples
var color = new cc.Color();
var newColor = color.clone();// Color {r: 0, g: 0, b: 0, a: 255}
equals

TODO

meta description
Returns Boolean
Defined in cocos2d/core/value-types/color.js:192
Parameters
Examples
var color1 = cc.Color.WHITE;
var color2 = new cc.Color(255, 255, 255);
cc.log(color1.equals(color2)); // true;
color2 = cc.Color.RED;
cc.log(color2.equals(color1)); // false;
lerp

TODO

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:209
Parameters
  • to Color
  • ratio number the interpolation coefficient.
  • out Color optional, the receiving vector.
Examples

```Not found for the example path: temp-src/engine/docs/utils/api/engine/docs/cocos2d/core/value-types/CCColor/lerp.js

toString

TODO

meta description
Returns String
Defined in cocos2d/core/value-types/color.js:232
Examples
var color = cc.Color.WHITE;
color.toString(); // "rgba(255, 255, 255, 255)"
getR

Gets red channel value

meta description
Returns Number
Defined in cocos2d/core/value-types/color.js:249
setR

Sets red value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:258
Parameters
  • red Number the new Red component.
Examples
var color = new cc.Color();
color.setR(255); // Color {r: 255, g: 0, b: 0, a: 255}
getG

Gets green channel value

meta description
Returns Number
Defined in cocos2d/core/value-types/color.js:273
setG

Sets green value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:282
Parameters
  • green Number the new Green component.
Examples
var color = new cc.Color();
color.setG(255); // Color {r: 0, g: 255, b: 0, a: 255}
getB

Gets blue channel value

meta description
Returns Number
Defined in cocos2d/core/value-types/color.js:297
setB

Sets blue value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:306
Parameters
  • blue Number the new Blue component.
Examples
var color = new cc.Color();
color.setB(255); // Color {r: 0, g: 0, b: 255, a: 255}
getA

Gets alpha channel value

meta description
Returns Number
Defined in cocos2d/core/value-types/color.js:321
setA

Sets alpha value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:330
Parameters
  • alpha Number the new Alpha component.
Examples
var color = new cc.Color();
color.setA(0); // Color {r: 0, g: 0, b: 0, a: 0}
toCSS

Convert color to css format.

meta description
Returns String
Defined in cocos2d/core/value-types/color.js:355
Parameters
  • opt String "rgba", "rgb", "#rgb" or "#rrggbb".
Examples

```Not found for the example path: temp-src/engine/docs/utils/api/engine/docs/cocos2d/core/value-types/CCColor/toCSS.js

fromHEX

Read hex string and store color data into the current color object, the hex string must be formated as rgba or rgb.

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:384
Parameters
Examples
var color = cc.Color.BLACK;
color.fromHEX("#FFFF33"); // Color {r: 255, g: 255, b: 51, a: 255};
toHEX

convert Color to HEX color string. e.g. cc.color(255,6,255) to : "#ff06ff"

meta description
Returns String
Defined in cocos2d/core/value-types/color.js:405
Parameters
  • fmt String "#rgb", "#rrggbb" or "#rrggbbaa".
Examples
var color = cc.Color.BLACK;
color.toHEX("#rgb");     // "000";
color.toHEX("#rrggbb");  // "000000";
toRGBValue

Convert to 24bit rgb value.

meta description
Returns Number
Defined in cocos2d/core/value-types/color.js:445
Examples
var color = cc.Color.YELLOW;
color.toRGBValue(); // 16771844;
fromHSV

Read HSV model color and convert to RGB color

meta description
Returns Color
Defined in cocos2d/core/value-types/color.js:458
Parameters
Examples
var color = cc.Color.YELLOW;
color.fromHSV(0, 0, 1); // Color {r: 255, g: 255, b: 255, a: 255};
toHSV

Transform to HSV model color

meta description
Returns Object
Defined in cocos2d/core/value-types/color.js:536
Examples
var color = cc.Color.YELLOW;
color.toHSV(); // Object {h: 0.1533864541832669, s: 0.9843137254901961, v: 1};
set

Copys all the properties from another given object to this value.

meta description
Defined in cocos2d/core/value-types/value-type.js:84
Parameters

results matching ""

    No results matching ""