# lv_profiler_builtin.h (/api/misc/lv_profiler_builtin_h)



<RelatedHeaders name="lv_profiler_builtin_private.h" isPrivate="false" />

<ApiSummary functions="6" macros="4" />

Functions [#functions]

<ApiTabs items="[&#x22;Setters (1)&#x22;,&#x22;Other (5)&#x22;]">
  <ApiTab value="Setters (1)">
    <ApiMember kind="function" name="lv_profiler_builtin_set_enable" file="misc/lv_profiler_builtin.h" line="61" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L61">
      lv_profiler_builtin_set_enable [#lv_profiler_builtin_set_enable]

      Enable or disable the built-in profiler.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_set_enable(bool enable)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                    | Description                                            |
      | -------- | ----------------------- | ------------------------------------------------------ |
      | `enable` | <ApiLink name="bool" /> | true to enable the built-in profiler, false to disable |
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (5)">
    <ApiMember kind="function" name="lv_profiler_builtin_config_init" file="misc/lv_profiler_builtin.h" line="44" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L44">
      lv_profiler_builtin_config_init [#lv_profiler_builtin_config_init]

      Initialize the configuration of the built-in profiler.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_config_init(lv_profiler_builtin_config_t *config)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                                                     | Description                                                     |
      | -------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
      | `config` | <ApiLink name="lv_profiler_builtin_config_t" display="lv_profiler_builtin_config_t *" /> | Pointer to the configuration structure of the built-in profiler |
    </ApiMember>

    <ApiMember kind="function" name="lv_profiler_builtin_init" file="misc/lv_profiler_builtin.h" line="50" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L50">
      lv_profiler_builtin_init [#lv_profiler_builtin_init]

      Initialize the built-in profiler with the given configuration.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_init(const lv_profiler_builtin_config_t *config)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                                                           | Description                                                     |
      | -------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
      | `config` | <ApiLink name="lv_profiler_builtin_config_t" display="const lv_profiler_builtin_config_t *" /> | Pointer to the configuration structure of the built-in profiler |
    </ApiMember>

    <ApiMember kind="function" name="lv_profiler_builtin_uninit" file="misc/lv_profiler_builtin.h" line="55" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L55">
      lv_profiler_builtin_uninit [#lv_profiler_builtin_uninit]

      Uninitialize the built-in profiler.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_uninit(void)
      ```
    </ApiMember>

    <ApiMember kind="function" name="lv_profiler_builtin_flush" file="misc/lv_profiler_builtin.h" line="66" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L66">
      lv_profiler_builtin_flush [#lv_profiler_builtin_flush]

      Flush the profiling data to the console.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_flush(void)
      ```
    </ApiMember>

    <ApiMember kind="function" name="lv_profiler_builtin_write" file="misc/lv_profiler_builtin.h" line="73" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L73">
      lv_profiler_builtin_write [#lv_profiler_builtin_write]

      Write the profiling data for a function with the given tag.

      ```c title=" " lineNumbers=1
      void lv_profiler_builtin_write(const char *func, char tag)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type           | Description                                               |
      | ------ | -------------- | --------------------------------------------------------- |
      | `func` | `const char *` | Name of the function being profiled                       |
      | `tag`  | `char`         | Tag to associate with the profiling data for the function |
    </ApiMember>
  </ApiTab>
</ApiTabs>

Macros [#macros]

<ApiMember kind="macro" name="LV_PROFILER_BUILTIN_BEGIN_TAG" file="misc/lv_profiler_builtin.h" line="27" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L27">
  LV_PROFILER_BUILTIN_BEGIN_TAG [#lv_profiler_builtin_begin_tag]

  ```c title=" " lineNumbers=1
  #define LV_PROFILER_BUILTIN_BEGIN_TAG(tag) \
      lv_profiler_builtin_write((tag), 'B')
  ```
</ApiMember>

<ApiMember kind="macro" name="LV_PROFILER_BUILTIN_END_TAG" file="misc/lv_profiler_builtin.h" line="28" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L28">
  LV_PROFILER_BUILTIN_END_TAG [#lv_profiler_builtin_end_tag]

  ```c title=" " lineNumbers=1
  #define LV_PROFILER_BUILTIN_END_TAG(tag) \
      lv_profiler_builtin_write((tag), 'E')
  ```
</ApiMember>

<ApiMember kind="macro" name="LV_PROFILER_BUILTIN_BEGIN" file="misc/lv_profiler_builtin.h" line="29" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L29">
  LV_PROFILER_BUILTIN_BEGIN [#lv_profiler_builtin_begin]

  ```c title=" " lineNumbers=1
  #define LV_PROFILER_BUILTIN_BEGIN LV_PROFILER_BUILTIN_BEGIN_TAG(__func__)
  ```
</ApiMember>

<ApiMember kind="macro" name="LV_PROFILER_BUILTIN_END" file="misc/lv_profiler_builtin.h" line="30" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/misc/lv_profiler_builtin.h#L30">
  LV_PROFILER_BUILTIN_END [#lv_profiler_builtin_end]

  ```c title=" " lineNumbers=1
  #define LV_PROFILER_BUILTIN_END LV_PROFILER_BUILTIN_END_TAG(__func__)
  ```
</ApiMember>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_conf_internal.h&#x22;, &#x22;lv_types.h&#x22;]" includedBy="[&#x22;lv_profiler.h&#x22;, &#x22;lv_profiler_builtin_private.h&#x22;]" transitiveIncludes="[&#x22;lv_conf_kconfig.h&#x22;]" />
