目次 - SDL_image 3.0 - IMG_GetAnimationDecoderFrame

IMG_GetAnimationDecoderFrame

アニメーションデコーダの次のフレームを得る

ヘッダ

SDL3_image/SDL_image.h

構文

bool IMG_GetAnimationDecoderFrame(IMG_AnimationDecoder *decoder, SDL_Surface **frame, Uint64 *duration);

引数

*
IMG_AnimationDecoder *decoderアニメーションデコーダ
SDL_Surface **frameアニメーションの次のフレームのSDL_Surfaceの代入先へのポインタ
Uint64durationフレーム間隔. 単位はミリ秒だが, デコーダの生成時にIMG_PROP_ANIMATION_DECODER_CREATE_TIMEBASE_DENOMINATOR_NUMBERプロパティで単位を変えることもできる

戻り値

(bool) 成功のとき真, 利用可能なフレームがないとき偽を戻す. IMG_GetAnimationDecoderStatus()またはSDL_GetError()を呼んで詳細を知ることができる.

詳細

この関数はアニメーションデコーダの次のフレームをデコードし, SDL_Surfaceとして戻す. 戻されたサーフェイスは不要になったときSDL_DestroySurface()で解放する必要がある.

アニメーションデコーダにこれ以上フレームがない, またはフレームのデコードでエラーが発生した場合, この関数は偽を戻す. この場合, SDL_GetError()で詳細を得ること. SDL_GetError()が空の文字列を戻した場合, フレームがないことを表す. SDL_GetError()が有効な文字列を戻した場合, デコードに失敗したことを表す.

バージョン

SDL_image 3.4.0以降

関連項目

SDL Wikiへのリンク

SDL3_image/IMG_GetAnimationDecoderFrame