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, as well.
Note: this proto does not 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.
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| Modifier and Type | Method and Description |
|---|---|
Color.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Color |
build() |
Color |
buildPartial() |
Color.Builder |
clear() |
Color.Builder |
clearAlpha()
The fraction of this color that should be applied to the pixel.
|
Color.Builder |
clearBlue()
The amount of blue in the color as a value in the interval [0, 1].
|
Color.Builder |
clearField(Descriptors.FieldDescriptor field) |
Color.Builder |
clearGreen()
The amount of green in the color as a value in the interval [0, 1].
|
Color.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Color.Builder |
clearRed()
The amount of red in the color as a value in the interval [0, 1].
|
Color.Builder |
clone() |
FloatValue |
getAlpha()
The fraction of this color that should be applied to the pixel.
|
FloatValue.Builder |
getAlphaBuilder()
The fraction of this color that should be applied to the pixel.
|
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].
|
Color |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
float |
getGreen()
The amount of green in the color as a value in the interval [0, 1].
|
float |
getRed()
The amount of red in the color as a value in the interval [0, 1].
|
boolean |
hasAlpha()
The fraction of this color that should be applied to the pixel.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Color.Builder |
mergeAlpha(FloatValue value)
The fraction of this color that should be applied to the pixel.
|
Color.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Color.Builder |
mergeFrom(Color other) |
Color.Builder |
mergeFrom(Message other) |
Color.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Color.Builder |
setAlpha(FloatValue.Builder builderForValue)
The fraction of this color that should be applied to the pixel.
|
Color.Builder |
setAlpha(FloatValue value)
The fraction of this color that should be applied to the pixel.
|
Color.Builder |
setBlue(float value)
The amount of blue in the color as a value in the interval [0, 1].
|
Color.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Color.Builder |
setGreen(float value)
The amount of green in the color as a value in the interval [0, 1].
|
Color.Builder |
setRed(float value)
The amount of red in the color as a value in the interval [0, 1].
|
Color.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Color.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Color.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Color.Builder>public Color getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Color build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Color buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Color.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Color.Builder>public Color.Builder mergeFrom(Color other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Color.Builder>public Color.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Color.Builder>java.io.IOExceptionpublic float getRed()
The amount of red in the color as a value in the interval [0, 1].
float red = 1;getRed in interface ColorOrBuilderpublic Color.Builder setRed(float value)
The amount of red in the color as a value in the interval [0, 1].
float red = 1;public Color.Builder clearRed()
The amount of red in the color as a value in the interval [0, 1].
float red = 1;public float getGreen()
The amount of green in the color as a value in the interval [0, 1].
float green = 2;getGreen in interface ColorOrBuilderpublic Color.Builder setGreen(float value)
The amount of green in the color as a value in the interval [0, 1].
float green = 2;public Color.Builder clearGreen()
The amount of green in the color as a value in the interval [0, 1].
float green = 2;public float getBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;getBlue in interface ColorOrBuilderpublic Color.Builder setBlue(float value)
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;public Color.Builder clearBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;hasAlpha in interface ColorOrBuilderpublic 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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;getAlpha in interface ColorOrBuilderpublic 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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
.google.protobuf.FloatValue alpha = 4;getAlphaOrBuilder in interface ColorOrBuilderpublic final Color.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Color.Builder>public final Color.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Color.Builder>