docs/html/uCEFImage.TCefImageRef.html

<!DOCTYPE html>
<html lang="en">
<head>
<title>cef4delphi: uCEFImage: Class TCefImageRef</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 1.0.4">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="bootstrap.min.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
<style type="text/css">
body { margin: 0.5em; }
.badge { padding: 0.1em 0.5em; color: white; }
</style></head>
<body>
<span id="TCefImageRef"></span><h1 class="cio">Class TCefImageRef</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uCEFImage.html">uCEFImage</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCefImageRef = class(<a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a>, <a class="normal" href="uCEFInterfaces.ICefImage.html">ICefImage</a>)</code></p>
<h2 class="description">Description</h2>
<p class="nodescription">This item has no description.</p><span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TInterfacedObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a></li>
<li class="thisitem">TCefImageRef</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#IsEmpty">IsEmpty</a></strong>: Boolean;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#IsSame-ICefImage-">IsSame</a></strong>(const that: <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>): Boolean;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#AddBitmap-Single-Integer-Integer-TCefColorType-TCefAlphaType-Pointer-NativeUInt-">AddBitmap</a></strong>(scaleFactor: Single; pixelWidth, pixelHeight: Integer; colorType: <a href="uCEFTypes.html#TCefColorType">TCefColorType</a>; alphaType: <a href="uCEFTypes.html#TCefAlphaType">TCefAlphaType</a>; const pixelData: Pointer; pixelDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#AddPng-Single-Pointer-NativeUInt-">AddPng</a></strong>(scaleFactor: Single; const pngData: Pointer; pngDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#AddJpeg-Single-Pointer-NativeUInt-">AddJpeg</a></strong>(scaleFactor: Single; const jpegData: Pointer; jpegDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetWidth">GetWidth</a></strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetHeight">GetHeight</a></strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#HasRepresentation-Single-">HasRepresentation</a></strong>(scaleFactor: Single): Boolean;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#RemoveRepresentation-Single-">RemoveRepresentation</a></strong>(scaleFactor: Single): Boolean;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetRepresentationInfo-Single-Single-Integer-Integer-">GetRepresentationInfo</a></strong>(scaleFactor: Single; var actualScaleFactor: Single; var pixelWidth, pixelHeight: Integer): Boolean;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetAsBitmap-Single-TCefColorType-TCefAlphaType-Integer-Integer-">GetAsBitmap</a></strong>(scaleFactor: Single; colorType: <a href="uCEFTypes.html#TCefColorType">TCefColorType</a>; alphaType: <a href="uCEFTypes.html#TCefAlphaType">TCefAlphaType</a>; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetAsPng-Single-Boolean-Integer-Integer-">GetAsPng</a></strong>(scaleFactor: Single; withTransparency: Boolean; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><code>function <strong><a href="uCEFImage.TCefImageRef.html#GetAsJpeg-Single-Integer-Integer-Integer-">GetAsJpeg</a></strong>(scaleFactor: Single; quality: Integer; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
<td class="itemcode"><code>class function <strong><a href="uCEFImage.TCefImageRef.html#UnWrap-Pointer-">UnWrap</a></strong>(data: Pointer): <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>;</code></td>
</tr>
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
<td class="itemcode"><code>class function <strong><a href="uCEFImage.TCefImageRef.html#New">New</a></strong>: <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="IsEmpty"></span><code>function <strong>IsEmpty</strong>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#IsEmpty">ICefImage.IsEmpty</a>.</p><p>
 Returns true (1) if this Image is NULL. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="IsSame-ICefImage-"></span><code>function <strong>IsSame</strong>(const that: <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#IsSame-ICefImage-">ICefImage.IsSame</a>.</p><p>
 Returns true (1) if this Image and |that| Image share the same underlying storage. Will also return true (1) if both images are NULL. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="AddBitmap-Single-Integer-Integer-TCefColorType-TCefAlphaType-Pointer-NativeUInt-"></span><code>function <strong>AddBitmap</strong>(scaleFactor: Single; pixelWidth, pixelHeight: Integer; colorType: <a href="uCEFTypes.html#TCefColorType">TCefColorType</a>; alphaType: <a href="uCEFTypes.html#TCefAlphaType">TCefAlphaType</a>; const pixelData: Pointer; pixelDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#AddBitmap-Single-Integer-Integer-TCefColorType-TCefAlphaType-Pointer-NativeUInt-">ICefImage.AddBitmap</a>.</p><p>
 Add a bitmap image representation for |scale_factor|. Only 32-bit RGBA/BGRA formats are supported. |pixel_width| and |pixel_height| are the bitmap representation size in pixel coordinates. |pixel_data| is the array of pixel data and should be |pixel_width| x |pixel_height| x 4 bytes in size. |color_type| and |alpha_type| values specify the pixel format. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="AddPng-Single-Pointer-NativeUInt-"></span><code>function <strong>AddPng</strong>(scaleFactor: Single; const pngData: Pointer; pngDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#AddPng-Single-Pointer-NativeUInt-">ICefImage.AddPng</a>.</p><p>
 Add a PNG image representation for |scale_factor|. |png_data| is the image data of size |png_data_size|. Any alpha transparency in the PNG data will be maintained. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="AddJpeg-Single-Pointer-NativeUInt-"></span><code>function <strong>AddJpeg</strong>(scaleFactor: Single; const jpegData: Pointer; jpegDataSize: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#AddJpeg-Single-Pointer-NativeUInt-">ICefImage.AddJpeg</a>.</p><p>
 Create a JPEG image representation for |scale_factor|. |jpeg_data| is the image data of size |jpeg_data_size|. The JPEG format does not support transparency so the alpha byte will be set to 0xFF for all pixels. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetWidth"></span><code>function <strong>GetWidth</strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetWidth">ICefImage.GetWidth</a>.</p><p>
 Returns the image width in density independent pixel (DIP) units. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetHeight"></span><code>function <strong>GetHeight</strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetHeight">ICefImage.GetHeight</a>.</p><p>
 Returns the image height in density independent pixel (DIP) units. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="HasRepresentation-Single-"></span><code>function <strong>HasRepresentation</strong>(scaleFactor: Single): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#HasRepresentation-Single-">ICefImage.HasRepresentation</a>.</p><p>
 Returns true (1) if this image contains a representation for |scale_factor|. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="RemoveRepresentation-Single-"></span><code>function <strong>RemoveRepresentation</strong>(scaleFactor: Single): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#RemoveRepresentation-Single-">ICefImage.RemoveRepresentation</a>.</p><p>
 Removes the representation for |scale_factor|. Returns true (1) on success. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetRepresentationInfo-Single-Single-Integer-Integer-"></span><code>function <strong>GetRepresentationInfo</strong>(scaleFactor: Single; var actualScaleFactor: Single; var pixelWidth, pixelHeight: Integer): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetRepresentationInfo-Single-Single-Integer-Integer-">ICefImage.GetRepresentationInfo</a>.</p><p>
 Returns information for the representation that most closely matches |scale_factor|. |actual_scale_factor| is the actual scale factor for the representation. |pixel_width| and |pixel_height| are the representation size in pixel coordinates. Returns true (1) on success. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetAsBitmap-Single-TCefColorType-TCefAlphaType-Integer-Integer-"></span><code>function <strong>GetAsBitmap</strong>(scaleFactor: Single; colorType: <a href="uCEFTypes.html#TCefColorType">TCefColorType</a>; alphaType: <a href="uCEFTypes.html#TCefAlphaType">TCefAlphaType</a>; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetAsBitmap-Single-TCefColorType-TCefAlphaType-Integer-Integer-">ICefImage.GetAsBitmap</a>.</p><p>
 Returns the bitmap representation that most closely matches |scale_factor|. Only 32-bit RGBA/BGRA formats are supported. |color_type| and |alpha_type| values specify the desired output pixel format. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a ICefBinaryValue containing the pixel data on success or NULL on failure. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetAsPng-Single-Boolean-Integer-Integer-"></span><code>function <strong>GetAsPng</strong>(scaleFactor: Single; withTransparency: Boolean; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetAsPng-Single-Boolean-Integer-Integer-">ICefImage.GetAsPng</a>.</p><p>
 Returns the PNG representation that most closely matches |scale_factor|. If |with_transparency| is true (1) any alpha transparency in the image will be represented in the resulting PNG data. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a ICefBinaryValue containing the PNG image data on success or NULL on failure. </p>
</td></tr>
</table>
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
<td class="itemcode"><span id="GetAsJpeg-Single-Integer-Integer-Integer-"></span><code>function <strong>GetAsJpeg</strong>(scaleFactor: Single; quality: Integer; var pixelWidth, pixelHeight: Integer): <a href="uCEFInterfaces.ICefBinaryValue.html">ICefBinaryValue</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFInterfaces.ICefImage.html#GetAsJpeg-Single-Integer-Integer-Integer-">ICefImage.GetAsJpeg</a>.</p><p>
 Returns the JPEG representation that most closely matches |scale_factor|. |quality| determines the compression level with 0 == lowest and 100 == highest. The JPEG format does not support alpha transparency and the alpha channel, if any, will be discarded. |pixel_width| and |pixel_height| are the output representation size in pixel coordinates. Returns a ICefBinaryValue containing the JPEG image data on success or NULL on failure. </p>
</td></tr>
</table>
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
<td class="itemcode"><span id="UnWrap-Pointer-"></span><code>class function <strong>UnWrap</strong>(data: Pointer): <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
<td class="itemcode"><span id="New"></span><code>class function <strong>New</strong>: <a href="uCEFInterfaces.ICefImage.html">ICefImage</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 1.0.4</a>. </em>
</span>
</body></html>