67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
|
gobmp
|
||
|
=====
|
||
|
|
||
|
A Go package for reading and writing BMP image files.
|
||
|
|
||
|
|
||
|
Installation
|
||
|
------------
|
||
|
|
||
|
To download and install, at a command prompt type:
|
||
|
|
||
|
go get github.com/jsummers/gobmp
|
||
|
|
||
|
|
||
|
Documentation
|
||
|
-------------
|
||
|
|
||
|
Gobmp is designed to work the same as Go's standard
|
||
|
[image modules](http://golang.org/pkg/image/). Importing it will automatically
|
||
|
cause the image.Decode function to support reading BMP files.
|
||
|
|
||
|
The documentation may be read online at
|
||
|
[GoDoc](http://godoc.org/github.com/jsummers/gobmp).
|
||
|
|
||
|
Or, after installing, type:
|
||
|
|
||
|
godoc github.com/jsummers/gobmp | more
|
||
|
|
||
|
|
||
|
Status
|
||
|
------
|
||
|
|
||
|
The decoder supports almost all types of BMP images.
|
||
|
|
||
|
By default, the encoder will write a 24-bit RGB image, or a 1-, 4-, or 8-bit
|
||
|
paletted image. Support for 32-bit RGBA images can optionally be enabled.
|
||
|
Writing compressed images is not supported.
|
||
|
|
||
|
|
||
|
License
|
||
|
-------
|
||
|
|
||
|
Gobmp is distributed under an MIT-style license.
|
||
|
|
||
|
Copyright © 2012-2013 Jason Summers
|
||
|
<[jason1@pobox.com](mailto:jason1@pobox.com)>
|
||
|
|
||
|
<pre>
|
||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
|
of this software and associated documentation files (the "Software"), to deal
|
||
|
in the Software without restriction, including without limitation the rights
|
||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
|
copies of the Software, and to permit persons to whom the Software is
|
||
|
furnished to do so, subject to the following conditions:
|
||
|
|
||
|
The above copyright notice and this permission notice shall be included in
|
||
|
all copies or substantial portions of the Software.
|
||
|
|
||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
|
THE SOFTWARE.
|
||
|
</pre>
|