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].
  • r number Get or set red channel value
  • g number Get or set green channel value
  • b number Get or set blue channel value
  • a number Get or set alpha channel value
Methods
  • copy Copy content of a color into another.
  • clone Clone a new color.
  • set Set the components of a color to the given values.
  • fromHex Converts the hexadecimal formal color into rgb formal.
  • add Add components of two colors, respectively.
  • subtract Subtract components of color b from components of color a, respectively.
  • multiply Multiply components of two colors, respectively.
  • divide Divide components of color a by components of color b, respectively.
  • scale Scales a color by a number.
  • lerp Performs a linear interpolation between two colors.
  • toArray Turn an array of colors
  • fromArray An array of colors turn
  • 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 Set the color
  • multiply Multiplies the current color by the specified color

Details

Properties

WHITE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

meta description
Type Color
Defined in cocos2d/core/value-types/color.ts:153
r

Get or set red channel value

meta description
Type number
Defined in cocos2d/core/value-types/color.ts:446
g

Get or set green channel value

meta description
Type number
Defined in cocos2d/core/value-types/color.ts:458
b

Get or set blue channel value

meta description
Type number
Defined in cocos2d/core/value-types/color.ts:470
a

Get or set alpha channel value

meta description
Type number
Defined in cocos2d/core/value-types/color.ts:482

Methods

copy

Copy content of a color into another.

meta description
Defined in cocos2d/core/value-types/color.ts:163
clone

Clone a new color.

meta description
Defined in cocos2d/core/value-types/color.ts:178
set

Set the components of a color to the given values.

meta description
Defined in cocos2d/core/value-types/color.ts:189
fromHex

Converts the hexadecimal formal color into rgb formal.

meta description
Defined in cocos2d/core/value-types/color.ts:204
add

Add components of two colors, respectively.

meta description
Defined in cocos2d/core/value-types/color.ts:224
subtract

Subtract components of color b from components of color a, respectively.

meta description
Defined in cocos2d/core/value-types/color.ts:239
multiply

Multiply components of two colors, respectively.

meta description
Defined in cocos2d/core/value-types/color.ts:254
divide

Divide components of color a by components of color b, respectively.

meta description
Defined in cocos2d/core/value-types/color.ts:269
scale

Scales a color by a number.

meta description
Defined in cocos2d/core/value-types/color.ts:284
lerp

Performs a linear interpolation between two colors.

meta description
Defined in cocos2d/core/value-types/color.ts:299
toArray

Turn an array of colors

meta description
Defined in cocos2d/core/value-types/color.ts:318
Parameters
  • ofs Unknown 数组起始偏移量
fromArray

An array of colors turn

meta description
Defined in cocos2d/core/value-types/color.ts:336
Parameters
  • ofs Unknown 数组起始偏移量
constructor
meta description
Defined in cocos2d/core/value-types/color.ts:355
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.ts:374
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.ts:389
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.ts:406
Parameters
  • to Color
  • ratio number the interpolation coefficient.
  • out Color optional, the receiving vector.
Examples
// Converts a white color to a black one trough time.
update: function (dt) {
    var color = this.node.color;
    if (color.equals(cc.Color.BLACK)) {
        return;
    }
    this.ratio += dt * 0.1;
    this.node.color = cc.Color.WHITE.lerp(cc.Color.BLACK, ratio);
}
toString

TODO

meta description
Returns String
Defined in cocos2d/core/value-types/color.ts:429
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.ts:494
setR

Sets red value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.ts:503
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.ts:518
setG

Sets green value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.ts:527
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.ts:542
setB

Sets blue value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.ts:551
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.ts:566
setA

Sets alpha value and return the current color object

meta description
Returns Color
Defined in cocos2d/core/value-types/color.ts:575
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.ts:591
Parameters
  • opt String "rgba", "rgb", "#rgb" or "#rrggbb".
Examples
var color = cc.Color.BLACK;
color.toCSS();          // "#000";
color.toCSS("rgba");    // "rgba(0,0,0,1.00)";
color.toCSS("rgb");     // "rgba(0,0,0)";
color.toCSS("#rgb");    // "#000";
color.toCSS("#rrggbb"); // "#000000";
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.ts:620
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.ts:641
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.ts:681
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.ts:694
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.ts:772
Examples
var color = cc.Color.YELLOW;
color.toHSV(); // Object {h: 0.1533864541832669, s: 0.9843137254901961, v: 1};
set

Set the color

meta description
Defined in cocos2d/core/value-types/color.ts:803
Parameters
multiply

Multiplies the current color by the specified color

meta description
Returns Color
Defined in cocos2d/core/value-types/color.ts:828
Parameters

results matching ""

    No results matching ""