# lv_bin_decoder.h (/api/libs/bin_decoder/lv_bin_decoder_h)



<ApiSummary functions="5" />

Functions [#functions]

<ApiTabs items="[&#x22;Getters (1)&#x22;,&#x22;Other (4)&#x22;]">
  <ApiTab value="Getters (1)">
    <ApiMember kind="function" name="lv_bin_decoder_get_area" file="libs/bin_decoder/lv_bin_decoder.h" line="44" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/libs/bin_decoder/lv_bin_decoder.h#L44">
      lv_bin_decoder_get_area [#lv_bin_decoder_get_area]

      ```c title=" " lineNumbers=1
      lv_result_t lv_bin_decoder_get_area(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, const lv_area_t *full_area, lv_area_t *decoded_area)
      ```

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

      | Name           | Type                                                                         |
      | -------------- | ---------------------------------------------------------------------------- |
      | `decoder`      | <ApiLink name="lv_image_decoder_t" display="lv_image_decoder_t *" />         |
      | `dsc`          | <ApiLink name="lv_image_decoder_dsc_t" display="lv_image_decoder_dsc_t *" /> |
      | `full_area`    | <ApiLink name="lv_area_t" display="const lv_area_t *" />                     |
      | `decoded_area` | <ApiLink name="lv_area_t" display="lv_area_t *" />                           |
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (4)">
    <ApiMember kind="function" name="lv_bin_decoder_init" file="libs/bin_decoder/lv_bin_decoder.h" line="33" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/libs/bin_decoder/lv_bin_decoder.h#L33">
      lv_bin_decoder_init [#lv_bin_decoder_init]

      Initialize the binary image decoder module

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

    <ApiMember kind="function" name="lv_bin_decoder_info" file="libs/bin_decoder/lv_bin_decoder.h" line="42" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/libs/bin_decoder/lv_bin_decoder.h#L42">
      lv_bin_decoder_info [#lv_bin_decoder_info]

      Get info about a lvgl binary image

      ```c title=" " lineNumbers=1
      lv_result_t lv_bin_decoder_info(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, lv_image_header_t *header)
      ```

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

      | Name      | Type                                                                         | Description                                                                  |
      | --------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
      | `decoder` | <ApiLink name="lv_image_decoder_t" display="lv_image_decoder_t *" />         | the decoder where this function belongs                                      |
      | `dsc`     | <ApiLink name="lv_image_decoder_dsc_t" display="lv_image_decoder_dsc_t *" /> | image descriptor containing the source and type of the image and other info. |
      | `header`  | <ApiLink name="lv_image_header_t" display="lv_image_header_t *" />           | store the image data here                                                    |

      **Returns:** <ApiLink name="lv_result_t" /> — LV\_RESULT\_OK: the info is successfully stored in `header`; LV\_RESULT\_INVALID: unknown format or other error.
    </ApiMember>

    <ApiMember kind="function" name="lv_bin_decoder_open" file="libs/bin_decoder/lv_bin_decoder.h" line="53" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/libs/bin_decoder/lv_bin_decoder.h#L53">
      lv_bin_decoder_open [#lv_bin_decoder_open]

      Open a lvgl binary image

      ```c title=" " lineNumbers=1
      lv_result_t lv_bin_decoder_open(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)
      ```

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

      | Name      | Type                                                                         | Description                                                                  |
      | --------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
      | `decoder` | <ApiLink name="lv_image_decoder_t" display="lv_image_decoder_t *" />         | the decoder where this function belongs                                      |
      | `dsc`     | <ApiLink name="lv_image_decoder_dsc_t" display="lv_image_decoder_dsc_t *" /> | pointer to decoder descriptor. `src`, `style` are already initialized in it. |

      **Returns:** <ApiLink name="lv_result_t" /> — LV\_RESULT\_OK: the info is successfully stored in `header`; LV\_RESULT\_INVALID: unknown format or other error.
    </ApiMember>

    <ApiMember kind="function" name="lv_bin_decoder_close" file="libs/bin_decoder/lv_bin_decoder.h" line="60" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/libs/bin_decoder/lv_bin_decoder.h#L60">
      lv_bin_decoder_close [#lv_bin_decoder_close]

      Close the pending decoding. Free resources etc.

      ```c title=" " lineNumbers=1
      void lv_bin_decoder_close(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)
      ```

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

      | Name      | Type                                                                         | Description                                         |
      | --------- | ---------------------------------------------------------------------------- | --------------------------------------------------- |
      | `decoder` | <ApiLink name="lv_image_decoder_t" display="lv_image_decoder_t *" />         | pointer to the decoder the function associated with |
      | `dsc`     | <ApiLink name="lv_image_decoder_dsc_t" display="lv_image_decoder_dsc_t *" /> | pointer to decoder descriptor                       |
    </ApiMember>
  </ApiTab>
</ApiTabs>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_image_decoder.h&#x22;]" transitiveIncludes="[&#x22;lv_area.h&#x22;, &#x22;lv_assert.h&#x22;, &#x22;lv_color.h&#x22;, &#x22;lv_color_op.h&#x22;, &#x22;lv_conf_internal.h&#x22;, &#x22;lv_conf_kconfig.h&#x22;, &#x22;lv_draw_buf.h&#x22;, &#x22;lv_fs.h&#x22;, &#x22;lv_image_dsc.h&#x22;, &#x22;lv_log.h&#x22;, &#x22;lv_math.h&#x22;, &#x22;lv_mem.h&#x22;, &#x22;lv_palette.h&#x22;, &#x22;lv_string.h&#x22;, &#x22;lv_types.h&#x22;]" />