summaryrefslogtreecommitdiff
path: root/www/api/resize.html
diff options
context:
space:
mode:
authorJiyong <jiyong.min@samsung.com>2023-12-06 10:30:38 +0900
committerJiyong <jiyong.min@samsung.com>2023-12-06 10:31:10 +0900
commit2c17c6b7ecf6d96c9b4004cd7b79d860b66e6ae3 (patch)
treec2510f971c95cb79f5a4bd55c841d294bf5197fd /www/api/resize.html
parent043c171f3b5935329641967057ae5f45bc1a5631 (diff)
downloadGraphicsMagick-upstream.tar.gz
GraphicsMagick-upstream.tar.bz2
GraphicsMagick-upstream.zip
Imported Upstream version 1.3.42upstream/1.3.42upstream
Change-Id: I4f2a12cbf50e1a459e7bac7c5a8e374071620eea
Diffstat (limited to 'www/api/resize.html')
-rw-r--r--www/api/resize.html180
1 files changed, 92 insertions, 88 deletions
diff --git a/www/api/resize.html b/www/api/resize.html
index 9bdf308..c8a791d 100644
--- a/www/api/resize.html
+++ b/www/api/resize.html
@@ -1,12 +1,14 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
-<title>resize</title>
-<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
+ <meta charset="utf-8">
+ <meta content="en" name="language">
+ <title>resize</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">
+
</head>
+
<body>
<div class="banner">
@@ -19,6 +21,7 @@
</form>
</div>
+
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
@@ -32,43 +35,41 @@
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
+
<div class="document" id="resize">
<h1 class="title">resize</h1>
-<h2 class="subtitle" id="resize-an-image">Resize an image</h2>
-
+<p class="subtitle" id="resize-an-image">Resize an image</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
-<li><a class="reference internal" href="#magnifyimage" id="id11">MagnifyImage</a></li>
-<li><a class="reference internal" href="#minifyimage" id="id12">MinifyImage</a></li>
-<li><a class="reference internal" href="#resizeimage" id="id13">ResizeImage</a></li>
-<li><a class="reference internal" href="#sampleimage" id="id14">SampleImage</a></li>
-<li><a class="reference internal" href="#scaleimage" id="id15">ScaleImage</a></li>
-<li><a class="reference internal" href="#thumbnailimage" id="id16">ThumbnailImage</a></li>
+<li><p><a class="reference internal" href="#magnifyimage" id="id11">MagnifyImage</a></p></li>
+<li><p><a class="reference internal" href="#minifyimage" id="id12">MinifyImage</a></p></li>
+<li><p><a class="reference internal" href="#resizeimage" id="id13">ResizeImage</a></p></li>
+<li><p><a class="reference internal" href="#sampleimage" id="id14">SampleImage</a></p></li>
+<li><p><a class="reference internal" href="#scaleimage" id="id15">ScaleImage</a></p></li>
+<li><p><a class="reference internal" href="#thumbnailimage" id="id16">ThumbnailImage</a></p></li>
</ul>
</div>
<div class="section" id="magnifyimage">
<h1><a class="toc-backref" href="#id11">MagnifyImage</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *MagnifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MagnifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>MagnifyImage() is a convenience method that scales an image proportionally
to twice its size.</p>
<p>The format of the MagnifyImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *MagnifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MagnifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -76,24 +77,22 @@ to twice its size.</p>
<h1><a class="toc-backref" href="#id12">MinifyImage</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *MinifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MinifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
<p>MinifyImage() is a convenience method that scales an image proportionally
to half its size.</p>
<p>The format of the MinifyImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *MinifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MinifyImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -101,11 +100,9 @@ to half its size.</p>
<h1><a class="toc-backref" href="#id13">ResizeImage</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ResizeImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns, const unsigned long rows,
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ResizeImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns, const unsigned long rows,
const <a class="reference external" href="../api/types.html#filtertype">FilterTypes</a> filter, const double blur,
- <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+ <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
@@ -121,24 +118,28 @@ Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc
are windowed (brought down to zero) with the Blackman filter.</p>
<p>ResizeImage() was inspired by Paul Heckbert's zoom program.</p>
<p>The format of the ResizeImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ResizeImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns, const unsigned long rows,
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ResizeImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns, const unsigned long rows,
const <a class="reference external" href="../api/types.html#filtertype">FilterTypes</a> filter, const double blur,
- <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
-<dl class="docutils">
+ <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>columns:</dt>
-<dd>The number of columns in the scaled image.</dd>
+<dd><p>The number of columns in the scaled image.</p>
+</dd>
<dt>rows:</dt>
-<dd>The number of rows in the scaled image.</dd>
+<dd><p>The number of rows in the scaled image.</p>
+</dd>
<dt>filter:</dt>
-<dd>Image filter to use.</dd>
+<dd><p>Image filter to use.</p>
+</dd>
<dt>blur:</dt>
-<dd>The blur factor where &gt; 1 is blurry, &lt; 1 is sharp.</dd>
+<dd><p>The blur factor where &gt; 1 is blurry, &lt; 1 is sharp.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -146,10 +147,8 @@ are windowed (brought down to zero) with the Blackman filter.</p>
<h1><a class="toc-backref" href="#id14">SampleImage</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *SampleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SampleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
@@ -158,19 +157,21 @@ sampling. Unlike other scaling methods, this method does not introduce
any additional color into the scaled image. SampleImage() is extremely
fast and may be used where speed is most important.</p>
<p>The format of the SampleImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *SampleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
-<dl class="docutils">
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SampleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>columns:</dt>
-<dd>The number of columns in the sampled image.</dd>
+<dd><p>The number of columns in the sampled image.</p>
+</dd>
<dt>rows:</dt>
-<dd>The number of rows in the sampled image.</dd>
+<dd><p>The number of rows in the sampled image.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -178,10 +179,8 @@ fast and may be used where speed is most important.</p>
<h1><a class="toc-backref" href="#id15">ScaleImage</a></h1>
<div class="section" id="id7">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ScaleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ScaleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id8">
<h2>Description</h2>
@@ -190,19 +189,21 @@ This method is reasonably fast but it is not currently multi-threaded
and does not support image filters. The quality of the resized image
is sufficient for most purposes.</p>
<p>The format of the ScaleImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ScaleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
-<dl class="docutils">
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ScaleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>columns:</dt>
-<dd>The number of columns in the scaled image.</dd>
+<dd><p>The number of columns in the scaled image.</p>
+</dd>
<dt>rows:</dt>
-<dd>The number of rows in the scaled image.</dd>
+<dd><p>The number of rows in the scaled image.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -210,10 +211,8 @@ is sufficient for most purposes.</p>
<h1><a class="toc-backref" href="#id16">ThumbnailImage</a></h1>
<div class="section" id="id9">
<h2>Synopsis</h2>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ThumbnailImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ThumbnailImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="id10">
<h2>Description</h2>
@@ -223,27 +222,32 @@ ThumbnailImage() is typically very fast but an attempt is made to improve
quality by first using a simple sampling algorithm for part of the
reduction, and then a filtering algorithm to produce the final image.</p>
<p>The format of the ThumbnailImage method is:</p>
-<pre class="literal-block">
-<a class="reference external" href="../api/types.html#image">Image</a> *ThumbnailImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
- const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );
-</pre>
-<dl class="docutils">
+<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ThumbnailImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long columns,
+ const unsigned long rows, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
<dt>columns:</dt>
-<dd>The number of columns in the scaled image.</dd>
+<dd><p>The number of columns in the scaled image.</p>
+</dd>
<dt>rows:</dt>
-<dd>The number of rows in the scaled image.</dd>
+<dd><p>The number of rows in the scaled image.</p>
+</dd>
<dt>exception:</dt>
-<dd>Return any errors or warnings in this structure.</dd>
+<dd><p>Return any errors or warnings in this structure.</p>
+</dd>
</dl>
</div>
</div>
</div>
+
<hr class="docutils">
<div class="document">
- <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p>
+ <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
+</div>
+
</div>
</body>
</html>