Difference between revisions of "Legacy:CreateColor"

From Spherical
Jump to: navigation, search
(Usage)
(Notes)
 
Line 15: Line 15:
 
==Notes==
 
==Notes==
  
The alpha component is optional. By default it's complete opaque (255).
+
* The alpha component is optional. By default it's complete opaque (255).
 +
* Avoid creating Color objects on the fly in render scripts, particularly when the actual RGB values used don't change from frame to frame.  This seems innocent enough, but can slow down your game considerably.  Instead, try to create Colors ahead of time so they can be reused each frame.
  
 
==Examples==
 
==Examples==

Latest revision as of 05:00, 20 June 2015

Returns a Sphere Color Object, to be used in color masks or drawing primitives.

Usage

Sphere 1.0 API
CreateColor(r, g, b, a);


Sphere 2.0 API
new Color(r, g, b, a);


  • r the red component
  • g the green component
  • b the blue component
  • a the alpha component

Notes

  • The alpha component is optional. By default it's complete opaque (255).
  • Avoid creating Color objects on the fly in render scripts, particularly when the actual RGB values used don't change from frame to frame. This seems innocent enough, but can slow down your game considerably. Instead, try to create Colors ahead of time so they can be reused each frame.

Examples

Create some colors:

var Red    = CreateColor(255, 0  , 0);
var Green  = CreateColor(0  , 255, 0);
var Yellow = CreateColor(255, 255, 0);

var TransparentRed = CreateColor(255, 0, 0, 125);

See also


API:Color/navbox