============================================================
Fan
============================================================
oneAPI Level Zero Specification - Version 1.21.26


Fan Handles
===========


.. _zes-fan-handle-t:

zes_fan_handle_t
----------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Obtained from:** :ref:`zesDeviceEnumFans`
   | **Used by:** :ref:`zesFanGetProperties`, :ref:`zesFanGetConfig`, :ref:`zesFanSetDefaultMode`, :ref:`zesFanSetFixedSpeedMode`, :ref:`zesFanSetSpeedTableMode`, :ref:`zesFanGetState`
   | **See also:** :ref:`Operations on fans (Programming Guide) <Fan>`

.. cpp:type:: zes_fan_handle_t

    Handle for a Sysman device fan.



Fan Functions
=============


.. _zesFanGetProperties:

zesFanGetProperties
-------------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanGetProperties
    :project: LevelZero


.. _zesFanGetConfig:

zesFanGetConfig
---------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanGetConfig
    :project: LevelZero


.. _zesFanSetDefaultMode:

zesFanSetDefaultMode
--------------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanSetDefaultMode
    :project: LevelZero


.. _zesFanSetFixedSpeedMode:

zesFanSetFixedSpeedMode
-----------------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanSetFixedSpeedMode
    :project: LevelZero


.. _zesFanSetSpeedTableMode:

zesFanSetSpeedTableMode
-----------------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanSetSpeedTableMode
    :project: LevelZero


.. _zesFanGetState:

zesFanGetState
--------------

.. rst-class:: api-version

*Added in version 1.0*

.. doxygenfunction:: zesFanGetState
    :project: LevelZero



Fan Enums
=========


.. _zes-fan-speed-mode-t:

zes_fan_speed_mode_t
--------------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Member of:** :ref:`zes-fan-config-t`

.. doxygenenum:: zes_fan_speed_mode_t
    :project: LevelZero


.. _zes-fan-speed-units-t:

zes_fan_speed_units_t
---------------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Used by:** :ref:`zesFanGetState`
   | **Member of:** :ref:`zes-fan-speed-t`

.. doxygenenum:: zes_fan_speed_units_t
    :project: LevelZero


 
Fan Structures
==============


.. _zes-fan-speed-t:

zes_fan_speed_t
---------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Used by:** :ref:`zesFanSetFixedSpeedMode`
   | **Member of:** :ref:`zes-fan-temp-speed-t`, :ref:`zes-fan-config-t`

.. doxygenstruct:: zes_fan_speed_t
    :project: LevelZero
    :members:
    :undoc-members:


.. _zes-fan-temp-speed-t:

zes_fan_temp_speed_t
--------------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Member of:** :ref:`zes-fan-speed-table-t`

.. doxygenstruct:: zes_fan_temp_speed_t
    :project: LevelZero
    :members:
    :undoc-members:


.. _zes-fan-speed-table-t:

zes_fan_speed_table_t
---------------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Used by:** :ref:`zesFanSetSpeedTableMode`
   | **Member of:** :ref:`zes-fan-config-t`

.. doxygenstruct:: zes_fan_speed_table_t
    :project: LevelZero
    :members:
    :undoc-members:


.. _zes-fan-properties-t:

zes_fan_properties_t
--------------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Used by:** :ref:`zesFanGetProperties`

.. doxygenstruct:: zes_fan_properties_t
    :project: LevelZero
    :members:
    :undoc-members:


.. _zes-fan-config-t:

zes_fan_config_t
----------------

.. rst-class:: api-version

*Added in version 1.0*

.. container:: api-usage

   | **Used by:** :ref:`zesFanGetConfig`

.. doxygenstruct:: zes_fan_config_t
    :project: LevelZero
    :members:
    :undoc-members: