Class Color.Builder (2.36.0)

public static final class Color.Builder extends GeneratedMessageV3.Builder<Color.Builder> implements ColorOrBuilder

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript.

This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space.

When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5.

Example (Java):

  import com.google.type.Color;

  // ...
  public static java.awt.Color fromProto(Color protocolor) {
    float alpha = protocolor.hasAlpha()
        ? protocolor.getAlpha().getValue()
        : 1.0;

    return new java.awt.Color(
        protocolor.getRed(),
        protocolor.getGreen(),
        protocolor.getBlue(),
        alpha);
  }

  public static Color toProto(java.awt.Color color) {
    float red = (float) color.getRed();
    float green = (float) color.getGreen();
    float blue = (float) color.getBlue();
    float denominator = 255.0;
    Color.Builder resultBuilder =
        Color
            .newBuilder()
            .setRed(red / denominator)
            .setGreen(green / denominator)
            .setBlue(blue / denominator);
    int alpha = color.getAlpha();
    if (alpha != 255) {
      result.setAlpha(
          FloatValue
              .newBuilder()
              .setValue(((float) alpha) / denominator)
              .build());
    }
    return resultBuilder.build();
  }
  // ...

Example (iOS / Obj-C):

  // ...
  static UIColor* fromProto(Color* protocolor) {
     float red = [protocolor red];
     float green = [protocolor green];
     float blue = [protocolor blue];
     FloatValue* alpha_wrapper = [protocolor alpha];
     float alpha = 1.0;
     if (alpha_wrapper != nil) {
       alpha = [alpha_wrapper value];
     }
     return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
  }

  static Color* toProto(UIColor* color) {
      CGFloat red, green, blue, alpha;
      if (![color getRed:&amp;red green:&amp;green blue:&amp;blue alpha:&amp;alpha]) {
        return nil;
      }
      Color* result = [[Color alloc] init];
      [result setRed:red];
      [result setGreen:green];
      [result setBlue:blue];
      if (alpha &lt;= 0.9999) {
        [result setAlpha:floatWrapperWithValue(alpha)];
      }
      [result autorelease];
      return result;
 }
 // ...

Example (JavaScript):

 // ...

 var protoToCssColor = function(rgb_color) {
    var redFrac = rgb_color.red || 0.0;
    var greenFrac = rgb_color.green || 0.0;
    var blueFrac = rgb_color.blue || 0.0;
    var red = Math.floor(redFrac * 255);
    var green = Math.floor(greenFrac * 255);
    var blue = Math.floor(blueFrac * 255);

    if (!('alpha' in rgb_color)) {
       return rgbToCssColor(red, green, blue);
    }

    var alphaFrac = rgb_color.alpha.value || 0.0;
    var rgbParams = [red, green, blue].join(',');
    return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
 };

 var rgbToCssColor = function(red, green, blue) {
   var rgbNumber = new Number((red &lt;&lt; 16) | (green &lt;&lt; 8) | blue);
   var hexString = rgbNumber.toString(16);
   var missingZeros = 6 - hexString.length;
   var resultBuilder = ['#'];
   for (var i = 0; i &lt; missingZeros; i++) {
      resultBuilder.push('0');
   }
   resultBuilder.push(hexString);
   return resultBuilder.join('');
 };

 // ...

Protobuf type google.type.Color

Implements

ColorOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Color.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Color.Builder
Overrides

build()

public Color build()
Returns
TypeDescription
Color

buildPartial()

public Color buildPartial()
Returns
TypeDescription
Color

clear()

public Color.Builder clear()
Returns
TypeDescription
Color.Builder
Overrides

clearAlpha()

public Color.Builder clearAlpha()

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Returns
TypeDescription
Color.Builder

clearBlue()

public Color.Builder clearBlue()

The amount of blue in the color as a value in the interval [0, 1].

float blue = 3;

Returns
TypeDescription
Color.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Color.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Color.Builder
Overrides

clearGreen()

public Color.Builder clearGreen()

The amount of green in the color as a value in the interval [0, 1].

float green = 2;

Returns
TypeDescription
Color.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Color.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Color.Builder
Overrides

clearRed()

public Color.Builder clearRed()

The amount of red in the color as a value in the interval [0, 1].

float red = 1;

Returns
TypeDescription
Color.Builder

This builder for chaining.

clone()

public Color.Builder clone()
Returns
TypeDescription
Color.Builder
Overrides

getAlpha()

public FloatValue getAlpha()

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Returns
TypeDescription
FloatValue

The alpha.

getAlphaBuilder()

public FloatValue.Builder getAlphaBuilder()

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Returns
TypeDescription
Builder

getAlphaOrBuilder()

public FloatValueOrBuilder getAlphaOrBuilder()

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Returns
TypeDescription
FloatValueOrBuilder

getBlue()

public float getBlue()

The amount of blue in the color as a value in the interval [0, 1].

float blue = 3;

Returns
TypeDescription
float

The blue.

getDefaultInstanceForType()

public Color getDefaultInstanceForType()
Returns
TypeDescription
Color

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getGreen()

public float getGreen()

The amount of green in the color as a value in the interval [0, 1].

float green = 2;

Returns
TypeDescription
float

The green.

getRed()

public float getRed()

The amount of red in the color as a value in the interval [0, 1].

float red = 1;

Returns
TypeDescription
float

The red.

hasAlpha()

public boolean hasAlpha()

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Returns
TypeDescription
boolean

Whether the alpha field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAlpha(FloatValue value)

public Color.Builder mergeAlpha(FloatValue value)

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Parameter
NameDescription
valueFloatValue
Returns
TypeDescription
Color.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Color.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Color.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Color.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Color.Builder
Overrides

mergeFrom(Color other)

public Color.Builder mergeFrom(Color other)
Parameter
NameDescription
otherColor
Returns
TypeDescription
Color.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Color.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Color.Builder
Overrides

setAlpha(FloatValue value)

public Color.Builder setAlpha(FloatValue value)

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Parameter
NameDescription
valueFloatValue
Returns
TypeDescription
Color.Builder

setAlpha(FloatValue.Builder builderForValue)

public Color.Builder setAlpha(FloatValue.Builder builderForValue)

The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).

.google.protobuf.FloatValue alpha = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Color.Builder

setBlue(float value)

public Color.Builder setBlue(float value)

The amount of blue in the color as a value in the interval [0, 1].

float blue = 3;

Parameter
NameDescription
valuefloat

The blue to set.

Returns
TypeDescription
Color.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Color.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Color.Builder
Overrides

setGreen(float value)

public Color.Builder setGreen(float value)

The amount of green in the color as a value in the interval [0, 1].

float green = 2;

Parameter
NameDescription
valuefloat

The green to set.

Returns
TypeDescription
Color.Builder

This builder for chaining.

setRed(float value)

public Color.Builder setRed(float value)

The amount of red in the color as a value in the interval [0, 1].

float red = 1;

Parameter
NameDescription
valuefloat

The red to set.

Returns
TypeDescription
Color.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Color.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Color.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Color.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Color.Builder
Overrides