summaryrefslogtreecommitdiff
path: root/devdocs/go/image%2Fjpeg%2Findex.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/go/image%2Fjpeg%2Findex.html
new repository
Diffstat (limited to 'devdocs/go/image%2Fjpeg%2Findex.html')
-rw-r--r--devdocs/go/image%2Fjpeg%2Findex.html38
1 files changed, 38 insertions, 0 deletions
diff --git a/devdocs/go/image%2Fjpeg%2Findex.html b/devdocs/go/image%2Fjpeg%2Findex.html
new file mode 100644
index 00000000..7b4c616f
--- /dev/null
+++ b/devdocs/go/image%2Fjpeg%2Findex.html
@@ -0,0 +1,38 @@
+<h1> Package jpeg </h1> <ul id="short-nav">
+<li><code>import "image/jpeg"</code></li>
+<li><a href="#pkg-overview" class="overviewLink">Overview</a></li>
+<li><a href="#pkg-index" class="indexLink">Index</a></li>
+</ul> <h2 id="pkg-overview">Overview </h2> <p>Package jpeg implements a JPEG image decoder and encoder. </p>
+<p>JPEG is defined in ITU-T T.81: <a href="https://www.w3.org/Graphics/JPEG/itu-t81.pdf">https://www.w3.org/Graphics/JPEG/itu-t81.pdf</a>. </p> <h2 id="pkg-index">Index </h2> <ul id="manual-nav">
+<li><a href="#pkg-constants">Constants</a></li>
+<li><a href="#Decode">func Decode(r io.Reader) (image.Image, error)</a></li>
+<li><a href="#DecodeConfig">func DecodeConfig(r io.Reader) (image.Config, error)</a></li>
+<li><a href="#Encode">func Encode(w io.Writer, m image.Image, o *Options) error</a></li>
+<li><a href="#FormatError">type FormatError</a></li>
+<li> <a href="#FormatError.Error">func (e FormatError) Error() string</a>
+</li>
+<li><a href="#Options">type Options</a></li>
+<li><a href="#Reader">type Reader</a></li>
+<li><a href="#UnsupportedError">type UnsupportedError</a></li>
+<li> <a href="#UnsupportedError.Error">func (e UnsupportedError) Error() string</a>
+</li>
+</ul> <h3>Package files</h3> <p> <span>fdct.go</span> <span>huffman.go</span> <span>idct.go</span> <span>reader.go</span> <span>scan.go</span> <span>writer.go</span> </p> <h2 id="pkg-constants">Constants</h2> <p>DefaultQuality is the default quality encoding parameter. </p>
+<pre data-language="go">const DefaultQuality = 75</pre> <h2 id="Decode">func <span>Decode</span> </h2> <pre data-language="go">func Decode(r io.Reader) (image.Image, error)</pre> <p>Decode reads a JPEG image from r and returns it as an <span>image.Image</span>. </p>
+<h2 id="DecodeConfig">func <span>DecodeConfig</span> </h2> <pre data-language="go">func DecodeConfig(r io.Reader) (image.Config, error)</pre> <p>DecodeConfig returns the color model and dimensions of a JPEG image without decoding the entire image. </p>
+<h2 id="Encode">func <span>Encode</span> </h2> <pre data-language="go">func Encode(w io.Writer, m image.Image, o *Options) error</pre> <p>Encode writes the Image m to w in JPEG 4:2:0 baseline format with the given options. Default parameters are used if a nil *<a href="#Options">Options</a> is passed. </p>
+<h2 id="FormatError">type <span>FormatError</span> </h2> <p>A FormatError reports that the input is not a valid JPEG. </p>
+<pre data-language="go">type FormatError string</pre> <h3 id="FormatError.Error">func (FormatError) <span>Error</span> </h3> <pre data-language="go">func (e FormatError) Error() string</pre> <h2 id="Options">type <span>Options</span> </h2> <p>Options are the encoding parameters. Quality ranges from 1 to 100 inclusive, higher is better. </p>
+<pre data-language="go">type Options struct {
+ Quality int
+}
+</pre> <h2 id="Reader">type <span>Reader</span> </h2> <p>Deprecated: Reader is not used by the <span>image/jpeg</span> package and should not be used by others. It is kept for compatibility. </p>
+<pre data-language="go">type Reader interface {
+ io.ByteReader
+ io.Reader
+}</pre> <h2 id="UnsupportedError">type <span>UnsupportedError</span> </h2> <p>An UnsupportedError reports that the input uses a valid but unimplemented JPEG feature. </p>
+<pre data-language="go">type UnsupportedError string</pre> <h3 id="UnsupportedError.Error">func (UnsupportedError) <span>Error</span> </h3> <pre data-language="go">func (e UnsupportedError) Error() string</pre><div class="_attribution">
+ <p class="_attribution-p">
+ &copy; Google, Inc.<br>Licensed under the Creative Commons Attribution License 3.0.<br>
+ <a href="http://golang.org/pkg/image/jpeg/" class="_attribution-link">http://golang.org/pkg/image/jpeg/</a>
+ </p>
+</div>