App:Library:LVGL:docs:Others:Snapshot

提供: robot-jp wiki
ナビゲーションに移動検索に移動

https://docs.lvgl.io/8.2/others/snapshot.html

英文 自動翻訳


Snapshot

英文 自動翻訳

Snapshot provides APIs to take snapshot image for LVGL object together with its children.

The image will look exactly like the object.

スナップショットは、LVGLオブジェクトのスナップショットイメージをその子と一緒に取得するためのAPIを提供します。

画像はオブジェクトとまったく同じように見えます。

戻る : Previous


Usage

英文 自動翻訳

Simply call API lv_snapshot_take to generate the image descriptor which can be set as image object src using lv_img_set_src.

Note, only below color formats are supported for now:

  • LV_IMG_CF_TRUE_COLOR_ALPHA
  • LV_IMG_CF_ALPHA_1BIT
  • LV_IMG_CF_ALPHA_2BIT
  • LV_IMG_CF_ALPHA_4BIT
  • LV_IMG_CF_ALPHA_8BIT


APIlv_snapshot_takeを呼び出すだけで、lv_img_set_srcを使用して画像オブジェクトsrcとして設定できる画像記述子を生成できます。

現在、以下のカラーフォーマットのみがサポートされていることに注意してください。

  • LV_IMG_CF_TRUE_COLOR_ALPHA
  • LV_IMG_CF_ALPHA_1BIT
  • LV_IMG_CF_ALPHA_2BIT
  • LV_IMG_CF_ALPHA_4BIT
  • LV_IMG_CF_ALPHA_8BIT
戻る : Previous


Free the Image

英文 自動翻訳

The memory lv_snapshot_take uses are dynamically allocated using lv_mem_alloc.

Use API lv_snapshot_free to free the memory it takes.

This will firstly free memory the image data takes, then the image descriptor.

Take caution to free the snapshot but not delete the image object.

Before free the memory, be sure to firstly unlink it from image object, using lv_img_set_src(NULL) and lv_img_cache_invalidate_src(src).

Below code snippet explains usage of this API. 

 void update_snapshot(lv_obj_t * obj, lv_obj_t * img_snapshot)
 {
     lv_img_dsc_t* snapshot = (void*)lv_img_get_src(img_snapshot);
     if(snapshot) {
         lv_snapshot_free(snapshot);
     }
     snapshot = lv_snapshot_take(obj, LV_IMG_CF_TRUE_COLOR_ALPHA);
     lv_img_set_src(img_snapshot, snapshot);
 }


メモリlv_snapshot_takeの使用は、lv_mem_allocを使用して動的に割り当てられます。

APIlv_snapshot_freeを使用して、必要なメモリを解放します。

これにより、最初に画像データが使用するメモリが解放され、次に画像記述子が解放されます。


スナップショットを解放するように注意してください。

ただし、イメージオブジェクトは削除しないでください。

メモリを解放する前に、必ずlv_img_set_src(NULL)とlv_img_cache_invalidate_src(src)を使用して、まず画像オブジェクトからメモリのリンクを解除してください。

以下のコードスニペットは、このAPIの使用法を説明しています。 

  void  update_snapshot （lv_obj_t  *  obj 、 lv_obj_t  *  img_snapshot ）
  { 
      lv_img_dsc_t * スナップショット =  （void * ）lv_img_get_src （img_snapshot ）
      if （snapshot ） { 
          lv_snapshot_free （snapshot ）
      }
      スナップショット =  lv_snapshot_take （obj 、 LV_IMG_CF_TRUE_COLOR_ALPHA ）
      lv_img_set_src （img_snapshot 、 snapshot);
  }
戻る : Previous

Use Existing Buffer

英文 自動翻訳

If the snapshot needs update now and then, or simply caller provides memory, use API lv_res_t lv_snapshot_take_to_buf(lv_obj_t * obj, lv_img_cf_t cf, lv_img_dsc_t * dsc, void * buf, uint32_t buff_size); for this case.


It's caller's responsibility to alloc/free the memory.

If snapshot is generated successfully, the image descriptor is updated and image data will be stored to provided buf.


Note that snapshot may fail if provided buffer is not enough, which may happen when object size changes.

It's recommended to use API lv_snapshot_buf_size_needed to check the needed buffer size in byte firstly and resize the buffer accordingly.

スナップショットを時々更新する必要がある場合、または単に呼び出し元がメモリを提供する場合は、この場合はAPIlv_res_t lv_snapshot_take_to_buf(lv_obj_t * obj, lv_img_cf_t cf, lv_img_dsc_t * dsc, void * buf, uint32_t buff_size);を使用してください。


メモリを割り当て/解放するのは発信者の責任です。

スナップショットが正常に生成されると、イメージ記述子が更新され、イメージデータが提供されたbufに保存されます。


提供されたバッファが十分でない場合、スナップショットが失敗する可能性があることに注意してください。

これは、オブジェクトサイズが変更されたときに発生する可能性があります。

APIlv_snapshot_buf_size_neededを使用して、最初に必要なバッファサイズをバイト単位で確認し、それに応じてバッファのサイズを変更することをお勧めします。

戻る : Previous



Example

Simple snapshot example

英文 自動翻訳

LVGL docs others snapshot 01.png

戻る : Previous


API

英文 自動翻訳

Functions

*lv_snapshot_take( *obj, cf)

Take snapshot for object with its children.
Parameters
  • obj -- The object to generate snapshot.
  • cf -- color format for generated image.
Returns
a pointer to an image descriptor, or NULL if failed.

void lv_snapshot_free( *dsc)

Free the snapshot image returned by It will firstly free the data image takes, then the image descriptor.
Parameters
dsc -- The image descriptor generated by lv_snapshot_take.

uint32_t lv_snapshot_buf_size_needed( *obj, cf)

Get the buffer needed for object snapshot image.
Parameters
  • obj -- The object to generate snapshot.
  • cf -- color format for generated image.
Returns
the buffer size needed in bytes

lv_res_t lv_snapshot_take_to_buf( *obj, cf, *dsc, void *buf, uint32_t buff_size)

Take snapshot for object with its children, save image info to provided buffer.
Parameters
  • obj -- The object to generate snapshot.
  • cf -- color format for generated image.
  • dsc -- image descriptor to store the image result.
  • buff -- the buffer to store image data.
  • buff_size -- provided buffer size in bytes.
Returns
LV_RES_OK on success, LV_RES_INV on error.


機能

lv_img_dsc_t * lv_snapshot_take（ lv_obj_t * obj、 lv_img_cf_t cf）

オブジェクトとその子のスナップショットを作成します。
パラメーター
  • obj-スナップショットを生成するオブジェクト。
  • cf--生成された画像のカラーフォーマット。
戻り値
画像記述子へのポインタ。失敗した場合はNULL。

void lv_snapshot_free（lv_img_dsc_t * dsc）

スナップショットは、LVGLオブジェクトのスナップショットイメージをその子と一緒に取得するためのAPIを提供します。lv_snapshot_takeによって返されたスナップショットイメージ を解放します。最初にデータイメージが取得し、次にイメージ記述子が解放されます。
パラメーター
dsc -lv_snapshot_takeによって生成された画像記述子。

uint32_t lv_snapshot_buf_size_needed（lv_obj_t * obj、lv_img_cf_t cf）

オブジェクトスナップショットイメージに必要なバッファを取得します。
パラメーター
  • obj-スナップショットを生成するオブジェクト。
  • cf--生成された画像のカラーフォーマット。
戻り値
必要なバッファサイズ（バイト単位）

lv_res_t lv_snapshot_take_to_buf（lv_obj_t * obj、lv_img_cf_t cf、lv_img_dsc_t * dsc、void * buf、uint32_t buff_size）

オブジェクトとその子のスナップショットを作成し、提供されたバッファに画像情報を保存します。
パラメーター
  • obj-スナップショットを生成するオブジェクト。
  • cf--生成された画像のカラーフォーマット。
  • dsc--画像の結果を保存する画像記述子。
  • buff--画像データを保存するためのバッファ。
  • buff_size-指定されたバッファサイズ（バイト単位）。
戻り値
成功した場合はLV_RES_OK、エラーの場合はLV_RES_INV。
戻る : Previous
「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Others:Snapshot&oldid=3720」から取得