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:&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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Color.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Color buildPartial()
Returns
clear()
public Color.Builder clear()
Returns
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
clearBlue()
public Color.Builder clearBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;
Returns
clearField(Descriptors.FieldDescriptor field)
public Color.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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
clearOneof(Descriptors.OneofDescriptor oneof)
public Color.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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
clone()
public Color.Builder clone()
Returns
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
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
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
getBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;
Returns
Type | Description |
float | The blue.
|
getDefaultInstanceForType()
public Color getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getGreen()
The amount of green in the color as a value in the interval [0, 1].
float green = 2;
Returns
Type | Description |
float | The green.
|
getRed()
The amount of red in the color as a value in the interval [0, 1].
float red = 1;
Returns
Type | Description |
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
Type | Description |
boolean | Whether the alpha field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
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
Returns
public Color.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Color.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeFrom(Color other)
public Color.Builder mergeFrom(Color other)
Parameter
Name | Description |
other | Color
|
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Color.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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
Returns
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
Name | Description |
builderForValue | Builder
|
Returns
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
Name | Description |
value | float
The blue to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Color.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Name | Description |
value | float
The green to set.
|
Returns
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
Name | Description |
value | float
The red to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Color.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Color.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides