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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
|
<HTML>
<HEAD>
<TITLE>annotate - Methods to Annotate an Image</TITLE>
<LINK REV="made" HREF="mailto:magick@wizards.dupont.com">
</HEAD>
<body background="../../images/background.gif">
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#NAME">NAME</A>
<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
<LI><A HREF="#FUNCTION_DESCRIPTIONS">FUNCTION DESCRIPTIONS</A>
<UL>
<LI><A HREF="#AnnotateImage">AnnotateImage</A>
<LI><A HREF="#CloneAnnotateInfo">CloneAnnotateInfo</A>
<LI><A HREF="#DestroyAnnotateInfo">DestroyAnnotateInfo</A>
<LI><A HREF="#GetAnnotateInfo">GetAnnotateInfo</A>
</UL>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
annotate - Methods to Annotate an Image
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
void <STRONG>AnnotateImage</STRONG>(Image*image,constAnnotateInfo*annotate_info)
<P>
void <STRONG>DestroyAnnotateInfo</STRONG>(AnnotateInfo*annotate_info)
<P>
<HR>
<H1><A NAME="FUNCTION_DESCRIPTIONS">FUNCTION DESCRIPTIONS</A></H1>
<P>
<HR>
<H2><A NAME="AnnotateImage">AnnotateImage</A></H2>
<P>
Method AnnotateImage annotates an image with text. Optionally the
annotation can include the image filename, type, width, height, or scene
number by embedding special format characters.
<P>
The format of the AnnotateImage method is:
<blockquote>void AnnotateImage (<A HREF="types/Image.html">Image</A> *image, const AnnotateInfo *annotate_info) </blockquote>
<P>
<FONT SIZE=-1>A</FONT> description of each parameter follows:
<DL><DL>
<DT><STRONG><A NAME="item_o">image:</A></STRONG><DD>
<P>
The address of a structure of type Image.
<DT><STRONG>annotate_info:</STRONG><DD>
<P>
The address of a AnnotateInfo structure.
</DL></DL>
<P>
<HR>
<H2><A NAME="CloneAnnotateInfo">CloneAnnotateInfo</A></H2>
<P>
Method CloneAnnotateInfo makes a duplicate of the given annotate info, or if annotate info is
<FONT SIZE=-1>NULL,</FONT> a new one.
<P>
The format of the CloneAnnotateInfo method is:
<P>
<PRE> AnnotateInfo *CloneAnnotateInfo(const ImageInfo *image_info,
const AnnotateInfo *annotate_info)
</PRE>
<P>
<FONT SIZE=-1>A</FONT> description of each parameter follows:
<DL><DL>
<DT><STRONG>cloned_info:</STRONG><DD>
<P>
Method CloneAnnotateInfo returns a duplicate of the given annotate info, or if annotate info is
<FONT SIZE=-1>NULL</FONT> a new one.
<DT><STRONG>image_info:</STRONG><DD>
<P>
a structure of type info.
<DT><STRONG>annotate_info:</STRONG><DD>
<P>
a structure of type info.
</DL></DL>
<P>
<HR>
<H2><A NAME="DestroyAnnotateInfo">DestroyAnnotateInfo</A></H2>
<P>
Method DestroyAnnotateInfo deallocates memory associated with an
AnnotateInfo structure.
<P>
The format of the DestroyAnnotateInfo method is:
<blockquote>void DestroyAnnotateInfo (AnnotateInfo *annotate_info) </blockquote>
<P>
<FONT SIZE=-1>A</FONT> description of each parameter follows:
<DL><DL>
<DT><STRONG>annotate_info:</STRONG><DD>
<P>
Specifies a pointer to an AnnotateInfo structure.
</DL></DL>
<P>
<HR>
<H2><A NAME="GetAnnotateInfo">GetAnnotateInfo</A></H2>
<P>
Method GetAnnotateInfo initializes the AnnotateInfo structure.
<P>
The format of the GetAnnotateInfo method is:
<P>
<PRE> void GetAnnotateInfo(const ImageInfo *image_info,
AnnotateInfo *annotate_info)
</PRE>
<P>
<FONT SIZE=-1>A</FONT> description of each parameter follows:
<DL><DL>
<DT><STRONG>image_info:</STRONG><DD>
<P>
Specifies a pointer to an ImageInfo structure.
<DT><STRONG>annotate_info:</STRONG><DD>
<P>
Specifies a pointer to a AnnotateInfo structure.
</DL></DL>
</BODY>
</HTML>
|