In This Topic ▼

L_CreatePlayback

Summary

Creates an animation playback object and gets a handle for managing the playback.

Syntax

#include "l_bitmap.h"

L_LTDIS_API L_INT L_CreatePlayback(phPlayback, pBitmap, hList)

Parameters

pHPLAYBACK phPlayback

Address of the HPLAYBACK variable that you can use afterward as the playback handle.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that references the target bitmap.

A bitmap list containing images to be played. The list can be created using L_CreateBitmapList and related functions. You can also pass NULL in this parameter to let the function create an empty list.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The target bitmap for the playback must be allocated before calling this function.

If you pass NULL in the hList parameter, you can use the L_AppendPlayback function to add bitmaps to the list during the playback. This is useful in the FILEREADCALLBACK function if you want to play an animated file as it is being loaded. If you need to reference the list after the playback, you can pass the address of an HBITMAPLIST variable when you call the L_DestroyPlayback function.