VX_OpenMovieFromFile


C Specification

#include <nitro/vx.h>

VXHandle    VX_OpenMovieFromFile        ( FSFile *file, 
                                          u32 nbBufferedFrameMax,
                                          u32 loopEnable);

Description

Opens a VX movie from a file.
VX_Malloc is called inside this function.

Arguments

file Already opened NITRO file handle.
nbBufferedFrameMax
Maximum number of frames who can be successively unpacked without been blitted or skipped.
Default value is VX_NB_BUFFERED_FRAME_DEFAULT.
Value cannot be below VX_NB_BUFFERED_FRAME_MIN.
loopEnable VX_LOOP_ENABLE enables looping, VX_LOOP_DISABLE disables it.

Return Values

Return a VXHandleVXHandle value if ok, VX_INVALID_HANDLE if error.

Cause of error : 
	- impossible to Read VX header.
	- incompatible file format (typically, this is not a valid VX movie).
	- wrong movie resolution (it must not exceed 256x192).
	- not enough memory (allocation error).

See Also

VX_OpenMovieFromMemory
VX_CloseMovie

Revision History

02/15/2006 Added information of VX_Malloc function use inside this function
10/26/2005 Initial Version