Documentation

Color extends Message
in package

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(''); }; // ...

Generated from protobuf message google.type.Color

Table of Contents

Properties

$alpha  : mixed
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.
$blue  : mixed
The amount of blue in the color as a value in the interval [0, 1].
$green  : mixed
The amount of green in the color as a value in the interval [0, 1].
$red  : mixed
The amount of red in the color as a value in the interval [0, 1].

Methods

__construct()  : mixed
Constructor.
clearAlpha()  : mixed
getAlpha()  : FloatValue|null
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.
getAlphaUnwrapped()  : float|null
Returns the unboxed value from <code>getAlpha()</code>
getBlue()  : float
The amount of blue in the color as a value in the interval [0, 1].
getGreen()  : float
The amount of green in the color as a value in the interval [0, 1].
getRed()  : float
The amount of red in the color as a value in the interval [0, 1].
hasAlpha()  : mixed
setAlpha()  : $this
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.
setAlphaUnwrapped()  : $this
Sets the field by wrapping a primitive type in a Google\Protobuf\FloatValue object.
setBlue()  : $this
The amount of blue in the color as a value in the interval [0, 1].
setGreen()  : $this
The amount of green in the color as a value in the interval [0, 1].
setRed()  : $this
The amount of red in the color as a value in the interval [0, 1].

Properties

$alpha

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.

protected mixed $alpha = null

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).

Generated from protobuf field .google.protobuf.FloatValue alpha = 4 [json_name = "alpha"];

$blue

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

protected mixed $blue = 0.0

Generated from protobuf field float blue = 3 [json_name = "blue"];

$green

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

protected mixed $green = 0.0

Generated from protobuf field float green = 2 [json_name = "green"];

$red

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

protected mixed $red = 0.0

Generated from protobuf field float red = 1 [json_name = "red"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type float $red
      The amount of red in the color as a value in the interval [0, 1].
@type float $green
      The amount of green in the color as a value in the interval [0, 1].
@type float $blue
      The amount of blue in the color as a value in the interval [0, 1].
@type \Google\Protobuf\FloatValue $alpha
      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).

}

clearAlpha()

public clearAlpha() : mixed

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.

public getAlpha() : FloatValue|null

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).

Generated from protobuf field .google.protobuf.FloatValue alpha = 4 [json_name = "alpha"];

Return values
FloatValue|null

getAlphaUnwrapped()

Returns the unboxed value from <code>getAlpha()</code>

public getAlphaUnwrapped() : float|null

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).

Generated from protobuf field .google.protobuf.FloatValue alpha = 4 [json_name = "alpha"];

Return values
float|null

getBlue()

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

public getBlue() : float

Generated from protobuf field float blue = 3 [json_name = "blue"];

Return values
float

getGreen()

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

public getGreen() : float

Generated from protobuf field float green = 2 [json_name = "green"];

Return values
float

getRed()

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

public getRed() : float

Generated from protobuf field float red = 1 [json_name = "red"];

Return values
float

hasAlpha()

public hasAlpha() : mixed

setAlpha()

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.

public setAlpha(FloatValue $var) : $this

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).

Generated from protobuf field .google.protobuf.FloatValue alpha = 4 [json_name = "alpha"];

Parameters
$var : FloatValue
Return values
$this

setAlphaUnwrapped()

Sets the field by wrapping a primitive type in a Google\Protobuf\FloatValue object.

public setAlphaUnwrapped(float|null $var) : $this

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).

Generated from protobuf field .google.protobuf.FloatValue alpha = 4 [json_name = "alpha"];

Parameters
$var : float|null
Return values
$this

setBlue()

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

public setBlue(float $var) : $this

Generated from protobuf field float blue = 3 [json_name = "blue"];

Parameters
$var : float
Return values
$this

setGreen()

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

public setGreen(float $var) : $this

Generated from protobuf field float green = 2 [json_name = "green"];

Parameters
$var : float
Return values
$this

setRed()

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

public setRed(float $var) : $this

Generated from protobuf field float red = 1 [json_name = "red"];

Parameters
$var : float
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results