Package com.google.type

Class Color

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ColorOrBuilder, Serializable
    public final class Color
extends com.google.protobuf.GeneratedMessageV3
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:&red green:&green blue:&blue alpha:&alpha]) {
            return nil;
          }
          Color* result = [[Color alloc] init];
          [result setRed:red];
          [result setGreen:green];
          [result setBlue:blue];
          if (alpha <= 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 << 16) | (green << 8) | blue);
       var hexString = rgbNumber.toString(16);
       var missingZeros = 6 - hexString.length;
       var resultBuilder = ['#'];
       for (var i = 0; i < missingZeros; i++) {
          resultBuilder.push('0');
       }
       resultBuilder.push(hexString);
       return resultBuilder.join('');
     };
     // ...
    Protobuf type google.type.Color
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Color.Builder
      Represents a color in the RGBA color space.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALPHA_FIELD_NUMBER  
      static int BLUE_FIELD_NUMBER  
      static int GREEN_FIELD_NUMBER  
      static int RED_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      com.google.protobuf.FloatValue getAlpha()
      The fraction of this color that should be applied to the pixel.
      com.google.protobuf.FloatValueOrBuilder getAlphaOrBuilder()
      The fraction of this color that should be applied to the pixel.
      float getBlue()
      The amount of blue in the color as a value in the interval [0, 1].
      static Color getDefaultInstance()  
      Color getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      float getGreen()
      The amount of green in the color as a value in the interval [0, 1].
      com.google.protobuf.Parser<Color> getParserForType()  
      float getRed()
      The amount of red in the color as a value in the interval [0, 1].
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasAlpha()
      The fraction of this color that should be applied to the pixel.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Color.Builder newBuilder()  
      static Color.Builder newBuilder​(Color prototype)  
      Color.Builder newBuilderForType()  
      protected Color.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Color parseDelimitedFrom​(InputStream input)  
      static Color parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Color parseFrom​(byte[] data)  
      static Color parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Color parseFrom​(com.google.protobuf.ByteString data)  
      static Color parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Color parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Color parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Color parseFrom​(InputStream input)  
      static Color parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Color parseFrom​(ByteBuffer data)  
      static Color parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Color> parser()  
      Color.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getRed

        public float getRed()
         The amount of red in the color as a value in the interval [0, 1].
        float red = 1;
        Specified by:
        getRed in interface ColorOrBuilder
        Returns:
        The red.

      • getGreen

        public float getGreen()
         The amount of green in the color as a value in the interval [0, 1].
        float green = 2;
        Specified by:
        getGreen in interface ColorOrBuilder
        Returns:
        The green.

      • getBlue

        public float getBlue()
         The amount of blue in the color as a value in the interval [0, 1].
        float blue = 3;
        Specified by:
        getBlue in interface ColorOrBuilder
        Returns:
        The blue.

      • 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;
        Specified by:
        hasAlpha in interface ColorOrBuilder
        Returns:
        Whether the alpha field is set.

      • getAlpha

        public com.google.protobuf.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;
        Specified by:
        getAlpha in interface ColorOrBuilder
        Returns:
        The alpha.

      • getAlphaOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getAlphaOrBuilder in interface ColorOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Color parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Color parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Color.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Color.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Color.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Color getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Color> parser()

      • getParserForType

        public com.google.protobuf.Parser<Color> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Color getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder