summaryrefslogtreecommitdiff
path: root/MovieDecode/MovieDecode.doc
blob: 4eeacb4ce1864e15a4342e2d4e52456cb5fc8c7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
TABLE OF CONTENTS

MovieDecode/FreeJDecoder
MovieDecode/InitJDecoder
MovieDecode/ModifyJFrame
MovieDecode/FreeJDecoder                             MovieDecode/FreeJDecoder

    NAME
	FreeJDecoder -- Free the player code for an animation

    SYNOPSIS
	FreeJDecoder(handle)
	D0           A0

	VOID FreeJDecoder(APTR handle);

    FUNCTION
	Frees all resources which were allocated by InitJDecoder().
	This is typically called once after playing an animation.

    INPUTS
	hande - result from InitJDecoder() ONLY!

    RESULT
	none

    BUGS

    SEE ALSO
	InitJDecoder()

MovieDecode/InitJDecoder                             MovieDecode/InitJDecoder

    NAME
	InitJDecoder -- Initialize the player code for a given animation

    SYNOPSIS
	handle = InitJDecoder(animtype)
	D0                    D0

	APTR InitJDecoder(ULONG animtype);

    FUNCTION
	Initializes the movie player for a given animation type. This is
	typically called once after loading the animation. After playing,
	FreeJDecoder() should be called (with the handle this function
	returns) to free any resources allocated by this function.

    INPUTS
	animtype - Bits 0 to 7: Number of bitplanes (1..6)
	           Bit 16: mode 0 = "Move" (loop), 1 = "EOR" (ping-pong)

    RESULT
	Non-zero if everything was OK, NULL if no memory or bad animtype.

    BUGS

    SEE ALSO
	FreeJDecoder()

MovieDecode/ModifyJFrame                             MovieDecode/ModifyJFrame

    NAME
	ModifyJFrame -- Apply delta data on an animation frame

    SYNOPSIS
	success = ModifyJFrame( deltas, bitmap, handle )
	D0		        A0      A1      A2

	BOOL ModifyJFrame( APTR, struct BitMap *, APTR );

    FUNCTION
	Generates a new animation frame by changing the frame before the
	currently displayed frame (for double-buffering, as usual).

    INPUTS
	deltas - pointer to the actual DLTA chunk data
	bitmap - BitMap to render into
	handle - player handle, from InitJDecoder()

    RESULT
	Non-zero if everything was OK, FALSE if an error occurred.

    BUGS

    SEE ALSO
	InitJDecoder(), FreeJDecoder()