summaryrefslogtreecommitdiff
path: root/Documentation/ifflib_internal.doc
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/ifflib_internal.doc')
-rw-r--r--Documentation/ifflib_internal.doc33
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/ifflib_internal.doc b/Documentation/ifflib_internal.doc
new file mode 100644
index 0000000..e3e09b1
--- /dev/null
+++ b/Documentation/ifflib_internal.doc
@@ -0,0 +1,33 @@
+TABLE OF CONTENTS
+
+iff.library/CalcViewModes
+ iff.library/CalcViewModes iff.library/CalcViewModes
+
+ NAME
+ CalcViewModes() -- Calculate Amiga-specific ViewModes from a BMHD
+
+ SYNOPSIS
+ viewmodes = CalcViewModes( bmhd )
+ D0 A0
+
+ ULONG CalcViewModes( struct IFFL_BMHD )
+
+ FUNCTION
+ Tries to calculate the viewmodes for a CAMG chunk by looking at
+ the bmh_Width, bmh_Height and bmh_Depth entries of a bmhd.
+ This is not always satisfactory, but we're stuck with it.
+
+ INPUTS
+ bmhd - BitMapHeader describing the picture's dimensions
+
+ RESULT
+ viewmodes - ULONG containing the view modes (LACE, HIRES)
+
+ BUGS
+ Knows nothing about Monitor IDs or new View modes like SUPERHIRES
+ or HAM8. You should not use this function in new code.
+
+ SEE ALSO
+ IFFL_GetViewModes(), IFFL_SaveClip()
+
+ \ No newline at end of file