.. _stdlib_anti_aliasing_component:

============
AntiAliasing
============


++++++++++++
Enumerations
++++++++++++

.. _enum-public_components-AntiAliasingMode:

.. das:attribute:: AntiAliasingMode

:Values: * **None** = 0 - No anti-aliasing

         * **FXAA** = 1 - Enable FXAA (fast approximate anti-aliasing)

         * **MSAA** = 2 - Enable MSAA (multisample anti-aliasing)


.. _enum-public_components-FXAAQuality:

.. das:attribute:: FXAAQuality

:Values: * **Low** = 0 - Default medium dither, fastest

         * **Medium** = 1 - Less dither, fastest

         * **High** = 2 - Less dither, highest quality

         * **Max** = 3 - No dither, very expensive


.. _enum-public_components-MSAAQuality:

.. das:attribute:: MSAAQuality

:Values: * **MSAA_2x** = 0 - Increase number of supersamples x2. Not all hardware supports this feature.

         * **MSAA_4x** = 1 - Increase number of supersamples x4. Most hardware supports this feature.

         * **MSAA_8x** = 2 - Increase number of supersamples x8. Not all hardware supports this feature.

         * **MSAA_Max** = 3 - Use maximum number of supersamples. Hardware defined.


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

.. _struct-anti_aliasing_component-AntiAliasing:

.. das:attribute:: AntiAliasing : NativeComponent

This component is used to setup anti aliasing post process for result image.
There is choice between FXAA and MSAA. FXAA is faster but less quality than MSAA. MSAA is slower but better quality.
This render feature is disabled by default.

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

    require engine.core_components.anti_aliasing_component // or require engine.core

Usage example::

    let setting = create_render_settings()
    get_component(renderSettings) $(var aa : AntiAliasing?) {
        aa.active = true
        aa.mode = AntiAliasingMode.FXAA
        aa.fxaa_quality = FXAAQuality.Low
    }


:Properties:

.. _function-anti_aliasing_component__dot__rq_active_AntiAliasing:

.. das:operator:: AntiAliasing.active() : bool



.. _function-anti_aliasing_component__dot__rq_active_rq_clone_AntiAliasing_bool:

.. das:operator:: AntiAliasing.active =(value: bool)

Active flag. If set to true, anti aliasing will be applied to the result image. Default is false.

:Arguments: * **value** : bool

.. _function-anti_aliasing_component__dot__rq_mode_AntiAliasing:

.. das:operator:: AntiAliasing.mode() : AntiAliasingMode



.. _function-anti_aliasing_component__dot__rq_mode_rq_clone_AntiAliasing_AntiAliasingMode:

.. das:operator:: AntiAliasing.mode =(value: AntiAliasingMode)

Mode of the anti aliasing, can be {AntiAliasingMode None, AntiAliasingMode FXAA, AntiAliasingMode MSAA}. Default is None.

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

.. _function-anti_aliasing_component__dot__rq_msaa_quality_AntiAliasing:

.. das:operator:: AntiAliasing.msaa_quality() : MSAAQuality



.. _function-anti_aliasing_component__dot__rq_msaa_quality_rq_clone_AntiAliasing_MSAAQuality:

.. das:operator:: AntiAliasing.msaa_quality =(value: MSAAQuality)

Quality of msaa. Can be {MSAAQuality MSAA_2x, MSAAQuality MSAA_4x, MSAAQuality MSAA_8x}. Default is MSAA_4x.

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

.. _function-anti_aliasing_component__dot__rq_fxaa_quality_AntiAliasing:

.. das:operator:: AntiAliasing.fxaa_quality() : FXAAQuality



.. _function-anti_aliasing_component__dot__rq_fxaa_quality_rq_clone_AntiAliasing_FXAAQuality:

.. das:operator:: AntiAliasing.fxaa_quality =(value: FXAAQuality)

Quality of fxaa. Can be {FXAAQuality Low, FXAAQuality Medium, FXAAQuality High}. Default is Medium.

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