Index

C/C++ Functions

fxAnimStart

DT_SWORD fxAnimStart(DT_AUX_INFO* info, DT_ID_SWORD bitmap_format, DT_ID_SWORD bitmap_subformat, DT_SLONG width, DT_SLONG height, DT_UWORD flags, DT_SLONG frames_count, const DT_AUX_GRAPHICS_ATTRIBS* gattribs, DT_AUX_USER_STREAM* user_stream)

Short Description: Open new animated image

This function open a new animated image in a user-defined stream to which subsequent fxAnimWrite calls will write animation frames. The image compression format is specified by the FileFormat member variable of the info structure.

Parameters

ParameterDescription

info

Pointer to the DT_AUX_INFO structure containing the applicable initialization parameters.

bitmap_format

See fxImageWrite.

bitmap_subformat

See fxImageWrite.

width

All bitmaps that will be added to the animation via subsequent subsequent fxAnimWrite calls must have the same width. The width parameter specifies this width, in pixels.

height

All bitmaps that will be added to the animation via subsequent subsequent fxAnimWrite calls must have the same height. The height parameter specifies this height, in pixels.

flags

A bitmask value.

  • bit 0 (1) — Use alpha-channel for this animated image. If set, subsequent fxAnimWrite calls can specify msk_ptr and msk_padding parameters; otherwise these two parameters will be ignored.

frames_count

The number of frames that will be added to the animated image. This value must equal the number of subsequent fxAnimWrite calls.

gattribs

See DT_AUX_GRAPHICS_ATTRIBS.

user_stream

See DT_AUX_USER_STREAM.

Return Value

If the function was successful, the return value is 1. Otherwise, the function returns 0.

Comments

The only image formats that currently support animation are DV_AUX_FILEFORMAT_APNG and DV_AUX_FILEFORMAT_GIF. The animated image opened by this function must be closed by fxAnimEnd.

 

Index