Class Color3
Hierarchy
- Color3
Index
Constructors
Properties
Accessors
Methods
- add
- add
ToRef - as
Array - clamp
ToRef - clone
- copy
From - copy
From Floats - equals
- equals
Floats - from
Array - get
Class Name - get
Hash Code - multiply
- multiply
ToRef - scale
- scale
And Add ToRef - scale
ToRef - set
- subtract
- subtract
ToRef - to
Array - to
Color4 - to
Gamma Space - to
Gamma Space ToRef - toHSV
- toHSVTo
Ref - to
Hex String - to
Linear Space - to
Linear Space ToRef - to
Luminance - to
String - Black
- Blue
- From
Array - From
Array ToRef - From
Hex String - From
Ints - Gray
- Green
- HSVtoRGBTo
Ref - Lerp
- Lerp
ToRef - Magenta
- Purple
- Random
- Red
- Teal
- White
- Yellow
Constructors
constructor
-
Creates a new Color3 object from red, green, blue values, all between 0 and 1
Parameters
-
Optional r: number
defines the red component (between 0 and 1, default is 0)
-
Optional g: number
defines the green component (between 0 and 1, default is 0)
-
Optional b: number
defines the blue component (between 0 and 1, default is 0)
Returns Color3
-
Properties
bSearch playground for b
Defines the blue component (between 0 and 1, default is 0)
gSearch playground for g
Defines the green component (between 0 and 1, default is 0)
rSearch playground for r
Defines the red component (between 0 and 1, default is 0)
Accessors
Static Black Read Only
-
Gets a Color3 value containing a black color that must not be updated
Returns DeepImmutable<Color3>
Methods
addSearch playground for add
-
Creates a new Color3 set with the added values of the current Color3 and of the given one
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
Returns Color3
the new Color3
-
add ToRefSearch playground for addToRef
-
Stores the result of the addition of the current Color3 and given one rgb values into "result"
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
-
result: Color3
defines Color3 object to store the result into
Returns Color3
the unmodified current Color3
-
as ArraySearch playground for asArray
-
Returns a new array populated with 3 numeric elements : red, green and blue values
Returns number[]
the new array
clamp ToRefSearch playground for clampToRef
-
Clamps the rgb values by the min and max values and stores the result into "result"
Parameters
-
min: number | undefined
defines minimum clamping value (default is 0)
-
max: number | undefined
defines maximum clamping value (default is 1)
-
result: Color3
defines color to store the result into
Returns Color3
the original Color3
-
cloneSearch playground for clone
-
Copy the current object
Returns Color3
a new Color3 copied the current one
copy FromSearch playground for copyFrom
-
Copies the rgb values from the source in the current Color3
Parameters
-
source: DeepImmutable<Color3>
defines the source Color3 object
Returns Color3
the updated Color3 object
-
copy From FloatsSearch playground for copyFromFloats
-
Updates the Color3 rgb values from the given floats
Parameters
-
r: number
defines the red component to read from
-
g: number
defines the green component to read from
-
b: number
defines the blue component to read from
Returns Color3
the current Color3 object
-
equalsSearch playground for equals
-
Determines equality between Color3 objects
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
Returns boolean
true if the rgb values are equal to the given ones
-
equals FloatsSearch playground for equalsFloats
-
Determines equality between the current Color3 object and a set of r,b,g values
Parameters
-
r: number
defines the red component to check
-
g: number
defines the green component to check
-
b: number
defines the blue component to check
Returns boolean
true if the rgb values are equal to the given ones
-
from ArraySearch playground for fromArray
-
Update the current color with values stored in an array from the starting index of the given array
Parameters
-
array: DeepImmutable<ArrayLike<number>>
defines the source array
-
Optional offset: number
defines an offset in the source array
Returns Color3
the current Color3 object
-
get Class NameSearch playground for getClassName
-
Returns the string "Color3"
Returns string
"Color3"
get Hash CodeSearch playground for getHashCode
-
Compute the Color3 hash code
Returns number
an unique number that can be used to hash Color3 objects
multiplySearch playground for multiply
-
Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
Returns Color3
the new Color3 object
-
multiply ToRefSearch playground for multiplyToRef
-
Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
-
result: Color3
defines the Color3 object where to store the result
Returns Color3
the current Color3
-
scaleSearch playground for scale
-
Multiplies in place each rgb value by scale
Parameters
-
scale: number
defines the scaling factor
Returns Color3
the updated Color3
-
scale And Add ToRefSearch playground for scaleAndAddToRef
scale ToRefSearch playground for scaleToRef
setSearch playground for set
-
Updates the Color3 rgb values from the given floats
Parameters
-
r: number
defines the red component to read from
-
g: number
defines the green component to read from
-
b: number
defines the blue component to read from
Returns Color3
the current Color3 object
-
subtractSearch playground for subtract
-
Returns a new Color3 set with the subtracted values of the given one from the current Color3
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
Returns Color3
the new Color3
-
subtract ToRefSearch playground for subtractToRef
-
Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
Parameters
-
otherColor: DeepImmutable<Color3>
defines the second operand
-
result: Color3
defines Color3 object to store the result into
Returns Color3
the unmodified current Color3
-
to ArraySearch playground for toArray
-
Stores in the given array from the given starting index the red, green, blue values as successive elements
Parameters
-
array: FloatArray
defines the array where to store the r,g,b components
-
Optional index: number
defines an optional index in the target array to define where to start storing values
Returns Color3
the current Color3 object
-
to Color4Search playground for toColor4
-
Returns a new Color4 object from the current Color3 and the given alpha
Parameters
-
Optional alpha: number
defines the alpha component on the new Color4 object (default is 1)
Returns Color4
a new Color4 object
-
to Gamma SpaceSearch playground for toGammaSpace
-
Computes a new Color3 converted from the current one to gamma space
Returns Color3
a new Color3 object
to Gamma Space ToRefSearch playground for toGammaSpaceToRef
toHSVSearch playground for toHSV
-
Converts current color in rgb space to HSV values
Returns Color3
a new color3 representing the HSV values
toHSVTo RefSearch playground for toHSVToRef
-
Converts current color in rgb space to HSV values
Parameters
-
result: Color3
defines the Color3 where to store the HSV values
Returns void
-
to Hex StringSearch playground for toHexString
-
Compute the Color3 hexadecimal code as a string
Returns string
a string containing the hexadecimal representation of the Color3 object
to Linear SpaceSearch playground for toLinearSpace
-
Computes a new Color3 converted from the current one to linear space
Returns Color3
a new Color3 object
to Linear Space ToRefSearch playground for toLinearSpaceToRef
to LuminanceSearch playground for toLuminance
-
Returns the luminance value
Returns number
a float value
to StringSearch playground for toString
-
Creates a string with the Color3 current values
Returns string
the string representation of the Color3 object
Static BlackSearch playground for Black
-
Returns a Color3 value containing a black color
Returns Color3
a new Color3 object
Static BlueSearch playground for Blue
-
Returns a Color3 value containing a blue color
Returns Color3
a new Color3 object
Static From ArraySearch playground for FromArray
-
Creates a new Color3 from the starting index of the given array
Parameters
-
array: DeepImmutable<ArrayLike<number>>
defines the source array
-
Optional offset: number
defines an offset in the source array
Returns Color3
a new Color3 object
-
Static From Array ToRefSearch playground for FromArrayToRef
-
Creates a new Color3 from the starting index element of the given array
Parameters
-
array: DeepImmutable<ArrayLike<number>>
defines the source array to read from
-
offset: number | undefined
defines the offset in the source array
-
result: Color3
defines the target Color3 object
Returns void
-
Static From Hex StringSearch playground for FromHexString
-
Creates a new Color3 from the string containing valid hexadecimal values
Parameters
-
hex: string
defines a string containing valid hexadecimal values
Returns Color3
a new Color3 object
-
Static From IntsSearch playground for FromInts
-
Creates a new Color3 from integer values (< 256)
Parameters
-
r: number
defines the red component to read from (value between 0 and 255)
-
g: number
defines the green component to read from (value between 0 and 255)
-
b: number
defines the blue component to read from (value between 0 and 255)
Returns Color3
a new Color3 object
-
Static GraySearch playground for Gray
-
Returns a Color3 value containing a gray color
Returns Color3
a new Color3 object
Static GreenSearch playground for Green
-
Returns a Color3 value containing a green color
Returns Color3
a new Color3 object
Static HSVtoRGBTo RefSearch playground for HSVtoRGBToRef
-
Convert Hue, saturation and value to a Color3 (RGB)
Parameters
-
hue: number
defines the hue
-
saturation: number
defines the saturation
-
value: number
defines the value
-
result: Color3
defines the Color3 where to store the RGB values
Returns void
-
Static LerpSearch playground for Lerp
-
Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
Parameters
-
start: DeepImmutable<Color3>
defines the start Color3 value
-
end: DeepImmutable<Color3>
defines the end Color3 value
-
amount: number
defines the gradient value between start and end
Returns Color3
a new Color3 object
-
Static Lerp ToRefSearch playground for LerpToRef
-
Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
Parameters
-
left: DeepImmutable<Color3>
defines the start value
-
right: DeepImmutable<Color3>
defines the end value
-
amount: number
defines the gradient factor
-
result: Color3
defines the Color3 object where to store the result
Returns void
-
Static MagentaSearch playground for Magenta
-
Returns a Color3 value containing a magenta color
Returns Color3
a new Color3 object
Static PurpleSearch playground for Purple
-
Returns a Color3 value containing a purple color
Returns Color3
a new Color3 object
Static RandomSearch playground for Random
-
Returns a Color3 value containing a random color
Returns Color3
a new Color3 object
Static RedSearch playground for Red
-
Returns a Color3 value containing a red color
Returns Color3
a new Color3 object
Static TealSearch playground for Teal
-
Returns a Color3 value containing a teal color
Returns Color3
a new Color3 object
Static WhiteSearch playground for White
-
Returns a Color3 value containing a white color
Returns Color3
a new Color3 object
Static YellowSearch playground for Yellow
-
Returns a Color3 value containing a yellow color
Returns Color3
a new Color3 object
Class used to hold a RGB color