.. highlightlang:: us

.. _objgetcolorgradient:

OBJGetColorGradient
===================

.. index:: OBJGetColorGradient

.. us.tag  OBJGetColorGradient ENGLISH draw-get Changed6002

:ref:`OBJGetColorGradient` returns two RGB colors which define the color
gradient.

.. function::  rmRGB = OBJGetColorGradient(hobj)
               rmARGB = OBJGetColorGradient(hobj, bTransparency)

.. us.return

**Return Value**

*rmRGB* is a matrix with 2 rows and 3 columns.

.. list-table::
   :header-rows: 1

   * - Value
     - Meaning
   * - rmRGB[1;1]
     - (Bottom) Red (0 to 255)
   * - rmRGB[1;2]
     - (Bottom) Green (0 to 255)
   * - rmRGB[1;3]
     - (Bottom) Blue (0 to 255)
   * - rmRGB[2;1]
     - (Top) Red (0 to 255)
   * - rmRGB[2;2]
     - (Top) Green (0 to 255)
   * - rmRGB[2;3]
     - (Top) Blue (0 to 255)

If *bTransparency* is TRUE (1), *rmARGB* is a matrix with 4 columns:

.. list-table::
   :header-rows: 1

   * - Value
     - Meaning
   * - rmARGB[1;1]
     - (Bottom) Transparency value (alpha) between 0 and 255. 0 is transparent
       and 255 is opaque.
   * - rmARGB[1;2]
     - (Bottom) Red (0 to 255)
   * - rmARGB[1;3]
     - (Bottom) Green (0 to 255)
   * - rmARGB[1;4]
     - (Bottom) Blue (0 to 255)
   * - rvColorARGB[2;1]
     - (Top) Transparency value (alpha) between 0 and 255. 0 is transparent
        and 255 is opaque.
   * - rmARGB[2;2]
     - (Top) Red (0 to 255)
   * - rmARGB[2;3]
     - (Top) Green (0 to 255)
   * - rmARGB[2;4]
     - (Top) Blue (0 to 255)

.. us.params

**Parameters**

.. uparam:: hobj

   *hobj* identifies a line, text, rectangle, ellipse or layer (diagram) object.

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2018.3
     - Transparency.

.. seealso::
   :ref:`overview-drawing-objects`,
   :ref:`OBJSetColorGradient`

:sub:`id-825385`