.. _stdlib_outline_component:

=======
Outline
=======


+++++++
Classes
+++++++

.. _struct-outline_component-Outline:

.. das:attribute:: Outline : NativeComponent

This component adds outline effect to the node.
It enables outlining the node with given color and thickness.

To use this component, add the following line to your project file::

    require engine.core_components.outline_component // or require engine.core

Usage example::

    var node = create_node(NodeData())
    add_component(node, new Outline(color = float3(1)))



:Properties:

.. _function-outline_component__dot__rq_color_Outline:

.. das:operator:: Outline.color() : float3



.. _function-outline_component__dot__rq_color_rq_clone_Outline_float3:

.. das:operator:: Outline.color =(value: float3)

Color of the outline. Default is (1f, 1f, 1f)

:Arguments: * **value** : float3

.. _function-outline_component__dot__rq_zTest_Outline:

.. das:operator:: Outline.zTest() : OutlineZTest



.. _function-outline_component__dot__rq_zTest_rq_clone_Outline_OutlineZTest:

.. das:operator:: Outline.zTest =(value: OutlineZTest)

Z-test mode for outline rendering. Can be {OutlineZTest.ZTestOff, OutlineZTest.ZTestOn, OutlineZTest.ZTestInverted}. Default is ZTestOff.

:Arguments: * **value** :  :ref:`OutlineZTest <enum-public_components-OutlineZTest>`