.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly

.. role:: clio-static
   :class: clio-flag clio-flag-static


######
Color3
######

.. js:class:: cee.Color3

   An immutable three component (RGB) color.
   
   The color components (r,g,b) are in the range 0..1.
   
   Note that this class is immutable.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.Color3.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.Color3.b`
   * :js:data:`~cee.Color3.g`
   * :js:data:`~cee.Color3.r`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.Color3.equals`
   * :js:meth:`~static cee.Color3.from`
   * :js:meth:`~static cee.Color3.fromArray`
   * :js:meth:`~static cee.Color3.fromColor4`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: cee.Color3.constructor

      .. rst-class:: sig-pretty-signature
      
         | Color3(**r**\ : *number*\ , **g**\ : *number*\ , **b**\ : *number*\ ): :js:class:`Color3 <cee.Color3>`
      
      Creates a color object.
      
      **Parameters**
      
      
         **r**\ : *number*
      
         **g**\ : *number*
      
         **b**\ : *number*
      
      
      **Returns**\ : :js:class:`Color3 <cee.Color3>`
      



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.Color3.b

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | b: *number*
      
      The blue component of the color. Range: 0..1
      



.. js:data:: cee.Color3.g

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | g: *number*
      
      The green component of the color. Range: 0..1
      



.. js:data:: cee.Color3.r

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | r: *number*
      
      The red component of the color. Range: 0..1
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.Color3.equals

      .. rst-class:: sig-pretty-signature
      
         | equals(**other**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *boolean*
      
      Returns true if the colors are equal.
      
      **Parameters**
      
      
         **other**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *boolean*
      



.. js:method:: static cee.Color3.from

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | from(**color**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): :js:class:`Color3 <cee.Color3>`
      
      Creates a Color3 instance from any object with r,g,b properties
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : :js:class:`Color3 <cee.Color3>`
      



.. js:method:: static cee.Color3.fromArray

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | fromArray(**arr**\ : *ArrayLike*\ ): :js:class:`Color3 <cee.Color3>`
      
      Creates a new Color3 instance from the first 3 elements of the given array.
      
      **Parameters**
      
      
         **arr**\ : *ArrayLike*
      
      
      **Returns**\ : :js:class:`Color3 <cee.Color3>`
      



.. js:method:: static cee.Color3.fromColor4

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | fromColor4(**color**\ : :js:class:`Color4Like <cee.Color4Like>`\ ): :js:class:`Color3 <cee.Color3>`
      
      Creates a Color3 instance from the r,g,b properties of the given RGBA color, ignoring the alpha channel
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color4Like <cee.Color4Like>`
      
      
      **Returns**\ : :js:class:`Color3 <cee.Color3>`
      




