| Current Path : /var/www/html/mmishra/indem/iiita/Doc/ |
| Current File : /var/www/html/mmishra/indem/iiita/Doc/interface_image.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>VersyPHP Documentation</title>
</head>
<body style="color: rgb(8, 38, 176); font-size: 20px; table-layout: fixed; margin-left: 35px; width: 872px; margin-top: 26px; height: 249px;" text="">
<table style="width: 878px; height: 54px;" align="center" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td align="left" width="30%">
<img src="logo.gif" align="middle" border="0" height="50" width="85">
</td>
<td style="width: 45%;" align="right">
<h1 style="font-size: 10pt;"> VESRYPDF.PHP DOCUMENATION </h1>
</td>
</tr>
</tbody>
</table>
<h2 style="color: rgb(71, 38, 125); font-family: serif; font-size: 12pt;">VersyPDF Images' manipulation Interface</h2>
<h3 style="color: rgb(71, 38, 125); font-family: serif; font-size: 11pt;">FUNCTIONS:</h3>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_new</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Create PDF image.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$Width -</b> [ in ] Specifies the width in pixels of the image.
<br><b>$Height -</b> [ in ] Specifies the height in pixels of the image.
<br><b>$Depth -</b> [ in ] Indicates the bit count per component of the image.
<br><b>$Device -</b> [ in ] Indicates the color space in which image samples are specified.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
PDF Image handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Image = pdfimage_new( $Lib, $Width, $Height, $Depth, $Device );
</td>
</tr>
<tr>
<td width="15%">See Also:</td>
<td>
Color depth ( IT_* ) constants
</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_load_from_stream</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Create PDF image from image file opened with PDF Stream.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$AStream -</b> [ in ] Stream handle.
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
PDF Image handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Image = pdfimage_load_from_stream( $Lib, $Stream, $Index );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_load_from_file</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Create PDF image from image file.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$FileName -</b> [ in ] Filename of the file where stored image
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
PDF Image handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Image = pdfimage_load_from_file( $Lib, $FileName, $Index );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_load_from_buffer</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Create PDF image from image file stored in memory buffer.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$Buffer -</b> [ in ] Storage location for data.
<br><b>$BufferSize -</b> [ in ] Size of the storage.
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
PDF Image handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Image = pdfimage_load_from_buffer( $Lib, $Buffer, $BufferSize, $Index );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_free</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Free PDF image.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
None.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
pdfimage_free( $Image );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_depth</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets the bit count per component of the image.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
The bit count.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Depth = pdfimage_get_depth( $Image );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_color_device</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets the color space in which image samples are specified.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Color space.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ColorDevice = pdfimage_get_color_device( $Image );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_width</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets the width of the image.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Width in samples of the bitmap.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Width = pdfimage_get_width( $Image );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_height</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets the height of the image.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Height in samples of the bitmap.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Height = pdfimage_get_height( $Image );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_scanline</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Provides indexed access to each line of samples.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Image -</b> [ in ] PDF Image handle.
<br><b>$ScanLineIndex -</b> [ in ] Index of line of the pixels.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Pointer to line of the samples.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ScanLine = pdfimage_get_scanline( $Image, $ScanLineIndex );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends image to document with specified compression.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$Image -</b> [ in ] PDF Image handle.
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_to_doc( $Image, $Doc, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc_from_file</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends image to document with specified compression from file.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$FileName -</b> [ in ] Filename of file where stored image
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_to_doc_from_file( $Doc, $FileName, $Index, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc_from_buffer</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends image to document with specified compression from memory buffer.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$Buffer -</b> [ in ] Storage location for data.
<br><b>$BufferSize -</b> [ in ] Size of the storage.
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_from_buffer( $Doc, $Buffer, $BufferSize, $Index, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc_from_stream</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends image to document with specified compression from stream.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$AStream -</b> [ in ] Stream where stored image
<br><b>$Index -</b> [ in ] Index of the image if file ( Used only for Tiff files )
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_to_doc_from_stream( $Doc, $AStream, $Index, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc_as_mask</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends b/w image to document with specified compression as transparent mask.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$Image -</b> [ in ] PDF Image handle.
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_to_doc_as_mask( $Doc, $Image, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_append_to_doc_with_mask</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Appends image to document with specified compression with transparent mask.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b> [ in ] PDF document handle.
<br><b>$Image -</b> [ in ] PDF Image handle.
<br><b>$CompressionType -</b> [ in ] Image compression type.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of the image in PDF document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$ImageId = pdfimage_append_to_doc_with_mask( $Doc, $Image, $CompressionType );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_tiff_count_from_stream</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets count of the images in the tiff file opened with PDF Stream.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$AStream -</b> [ in ] Stream handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Count of the images.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Count = pdfimage_get_tiff_count_from_stream( $Lib, $AStream );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_tiff_count_from_file</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets count of the images in the tiff file.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$FileName -</b> [ in ] Filename of the file where stored image.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Count of the images.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Count = pdfimage_get_tiff_count_from_file( $Lib, $FileName );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfimage_get_tiff_count_from_buffer</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets count of the images in the tiff file stored in memory buffer.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Lib -</b> [ in ] PDF Library handle.
<br><b>$Buffer -</b> [ in ] Storage location for data.
<br><b>$BufferSize -</b> [ in ] Size of the storage.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Count of the images.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Count = pdfimage_get_tiff_count_from_buffer( $Lib, $Buffer, $BufferSize );
</td>
</tr>
</table><br>
</body></html>