ColorGeometryInstanceAttribute - Cesium Documentation

# ColorGeometryInstanceAttribute

#### new ColorGeometryInstanceAttribute(red, green, blue, alpha)

  Value and type information for per-instance geometry color.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `red` | Number | `1.0` | optional The red component.
  `green` | Number | `1.0` | optional The green component.
  `blue` | Number | `1.0` | optional The blue component.
  `alpha` | Number | `1.0` | optional The alpha component.

  ##### Example:

      var instance = new Cesium.GeometryInstance({
        geometry : new Cesium.BoxGeometry({
          dimensions : new Cesium.Cartesian3(1000000.0, 1000000.0, 500000.0)
        }),
        modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame(
          Cesium.Cartesian3.fromDegrees(0.0, 0.0), new Cesium.Cartesian3(0.0, 0.0, 1000000.0), new Cesium.Matrix4()),
        id : 'box',
        attributes : {
          color : new Cesium.ColorGeometryInstanceAttribute(red, green, blue, alpha)
        }
      });

  ##### See:

  - GeometryInstance
  - GeometryInstanceAttribute
  Source: Core/ColorGeometryInstanceAttribute.js, line 45

### Members

#### readonlycomponentDatatype :ComponentDatatype

  The datatype of each component in the attribute, e.g., individual elements in `ColorGeometryInstanceAttribute#value`.
  Default Value: ``ComponentDatatype.UNSIGNED_BYTE``
  Source: Core/ColorGeometryInstanceAttribute.js, line 78

#### readonlycomponentsPerAttribute :Number

  The number of components in the attributes, i.e., `ColorGeometryInstanceAttribute#value`.
  Default Value: `4`
  Source: Core/ColorGeometryInstanceAttribute.js, line 94

#### readonlynormalize :Boolean

  When `true` and `componentDatatype` is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering.
  Default Value: `true`
  Source: Core/ColorGeometryInstanceAttribute.js, line 112

#### value :Uint8Array

  The values for the attributes stored in a typed array.
  Default Value: `[255, 255, 255, 255]`
  Source: Core/ColorGeometryInstanceAttribute.js, line 58

### Methods

#### staticColorGeometryInstanceAttribute.fromColor(color) → ColorGeometryInstanceAttribute

  Creates a new `ColorGeometryInstanceAttribute` instance given the provided `Color`.

  Name | Type | Description
  --- | --- | ---
  `color` | Color | The color.

  ##### Returns:

  The new `ColorGeometryInstanceAttribute` instance.

  ##### Example:

      var instance = new Cesium.GeometryInstance({
        geometry : // ...
        attributes : {
          color : Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.CORNFLOWERBLUE),
        }
      });

  Source: Core/ColorGeometryInstanceAttribute.js, line 133

#### staticColorGeometryInstanceAttribute.toValue(color, result) → Uint8Array

  Converts a color to a typed array that can be used to assign a color attribute.

  Name | Type | Description
  --- | --- | ---
  `color` | Color | The color.
  `result` | Uint8Array | optional The array to store the result in, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter or a new instance if result was undefined.

  ##### Example:

      var attributes = primitive.getGeometryInstanceAttributes('an id');
      attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA, attributes.color);

  Source: Core/ColorGeometryInstanceAttribute.js, line 155