зеркало из https://github.com/SixLabors/Shapes.git
Update README.md
This commit is contained in:
Scott Williams
GitHub
Родитель
e169294016
Коммит
f1320c98c6
113
README.md
113
README.md
|
|
@ -1,55 +1,23 @@
|
|||
|
||||
# <img src="build/icons/imagesharp-logo-64.png" width="52" height="52"/> ImageSharp
|
||||
# Shaper2D
|
||||
|
||||
**ImageSharp** is a new cross-platform 2D graphics API designed to allow the processing of images without the use of `System.Drawing`.
|
||||
|
||||
> **ImageSharp is still in early stages (alpha) but progress has been pretty quick. As such, please do not use on production environments until the library reaches release candidate status. Pre-release downloads are available from the [MyGet package repository](https://www.myget.org/gallery/imagesharp).**
|
||||
|
||||
[](https://raw.githubusercontent.com/JimBobSquarePants/ImageSharp/master/APACHE-2.0-LICENSE.txt)
|
||||
[](https://github.com/JimBobSquarePants/ImageSharp/issues)
|
||||
[](https://github.com/JimBobSquarePants/ImageSharp/stargazers)
|
||||
[](https://github.com/JimBobSquarePants/ImageSharp/network)
|
||||
[](https://gitter.im/ImageSharp/General?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://twitter.com/intent/tweet?hashtags=imagesharp,dotnet,oss&text=ImageSharp.+A+new+cross-platform+2D+graphics+API+in+C%23&url=https%3a%2f%2fgithub.com%2fJimBobSquarePants%2fImageSharp&via=james_m_south)
|
||||
|
||||
|
||||
| |Build Status|Code Coverage|
|
||||
|-------------|:----------:|:-----------:|
|
||||
|**Linux/Mac**|[](https://travis-ci.org/JimBobSquarePants/ImageSharp)|[](https://codecov.io/gh/JimBobSquarePants/ImageSharp)|
|
||||
|**Windows** |[](https://ci.appveyor.com/project/JamesSouth/imagesharp/branch/master)|[](https://codecov.io/gh/JimBobSquarePants/ImageSharp)|
|
||||
**Shaper2D** is a new cross-platform 2D polygon manipulation AP.
|
||||
|
||||
[](https://raw.githubusercontent.com/tocsoft/Shaper2D/master/APACHE-2.0-LICENSE.txt)
|
||||
[](https://github.com/tocsoft/Shaper2D/issues)
|
||||
[](https://github.com/tocsoft/Shaper2D/stargazers)
|
||||
[](https://github.com/tocsoft/Shaper2D/network)
|
||||
|
||||
### Installation
|
||||
At present the code is pre-release but when ready it will be available on [Nuget](http://www.nuget.org).
|
||||
|
||||
**Pre-release downloads**
|
||||
|
||||
We already have a [MyGet package repository](https://www.myget.org/gallery/imagesharp) - for bleeding-edge / development NuGet releases.
|
||||
|
||||
### Packages
|
||||
|
||||
The **ImageSharp** library is made up of multiple packages, to make **ImageSharp** do anything useful you will want to make sure you include at least one format as a dependency otherwise you will not be able to save/load any images.
|
||||
|
||||
Packages include:
|
||||
- **ImageSharp**
|
||||
Contains the Image classes, Colors, Primitives, Bootstrapper, IImageFormat interface, and other core functionality.
|
||||
- **ImageSharp.Formats.Jpeg**
|
||||
The jpeg decoder/encoder (Auto registered)
|
||||
- **ImageSharp.Formats.Png**
|
||||
The png decoder/encoder (Auto registered)
|
||||
- **ImageSharp.Formats.Gif**
|
||||
The gif decoder/encoder (Auto registered)
|
||||
- **ImageSharp.Formats.Bmp**
|
||||
The bmp decoder/encoder (Auto registered)
|
||||
- **ImageSharp.Processing**
|
||||
Contains methods like Resize, Crop, Skew, Rotate - Anything that alters the dimensions of the image.
|
||||
Contains methods like Gaussian Blur, Pixelate, Edge Detection - Anything that maintains the original image dimensions.
|
||||
- **ImageSharp.Drawing**
|
||||
Brushes and various drawing algorithms.
|
||||
We already have a [MyGet package repository](https://www.myget.org/gallery/shaper2d) - for bleeding-edge / development NuGet releases.
|
||||
|
||||
### Manual build
|
||||
|
||||
If you prefer, you can compile ImageSharp yourself (please do and help!), you'll need:
|
||||
If you prefer, you can compile Shaper2D yourself (please do and help!), you'll need:
|
||||
|
||||
- [Visual Studio 2015 with Update 3 (or above)](https://www.visualstudio.com/news/releasenotes/vs2015-update3-vs)
|
||||
- The [.NET Core 1.0 SDK Installer](https://www.microsoft.com/net/core#windows) - Non VSCode link.
|
||||
|
|
@ -57,68 +25,37 @@ If you prefer, you can compile ImageSharp yourself (please do and help!), you'll
|
|||
To clone it locally click the "Clone in Windows" button above or run the following git commands.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/JimBobSquarePants/ImageSharp
|
||||
git clone https://github.com/tocsoft/Shaper2D
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
There's plenty there and more coming. Check out the [current features](features.md)!
|
||||
- Point in Polygon
|
||||
- Line Intersections
|
||||
- Complex Polygons (with holes, this can be contained or overlap(we fix them for you))
|
||||
- Polygons
|
||||
- With Liniear line segments
|
||||
- With Beziear curve linesegments
|
||||
- Mixes Linear & beziear segments
|
||||
- Paths
|
||||
- With Liniear line segments
|
||||
- With Beziear curve linesegments
|
||||
- Mixes Linear & beziear segments
|
||||
|
||||
### API
|
||||
|
||||
Without the constraints of `System.Drawing` We have been able to develop something much more flexible, easier to code against, and much, much less prone to memory leaks. Gone are system-wide process-locks. Images and processors are thread safe usable in parallel processing utilizing all the availables cores.
|
||||
|
||||
Many `Image` methods are also fluent.
|
||||
|
||||
Here's an example of the code required to resize an image using the default Bicubic resampler then turn the colors into their grayscale equivalent using the BT709 standard matrix.
|
||||
|
||||
```csharp
|
||||
using (FileStream stream = File.OpenRead("foo.jpg"))
|
||||
using (FileStream output = File.OpenWrite("bar.jpg"))
|
||||
{
|
||||
Image image = new Image(stream);
|
||||
image.Resize(image.Width / 2, image.Height / 2)
|
||||
.Grayscale()
|
||||
.Save(output);
|
||||
}
|
||||
```
|
||||
|
||||
Individual processors can be initialised and apply processing against images. This allows nesting which brings the potential for powerful combinations of processing methods:
|
||||
|
||||
```csharp
|
||||
new BrightnessProcessor(50).Apply(sourceImage, sourceImage.Bounds);
|
||||
```
|
||||
|
||||
Setting individual pixel values is perfomed as follows:
|
||||
|
||||
```csharp
|
||||
Image image = new Image(400, 400);
|
||||
using (var pixels = image.Lock())
|
||||
{
|
||||
pixels[200, 200] = Color.White;
|
||||
}
|
||||
```
|
||||
|
||||
For advanced usage the `Image<TColor>` and `PixelAccessor<TColor>` classes are available allowing developers to implement their own color models in the same manner as Microsoft XNA Game Studio and MonoGame.
|
||||
|
||||
All in all this should allow image processing to be much more accessible to developers which has always been my goal from the start.
|
||||
TODO add api example in here (missing polygon builder class)
|
||||
|
||||
### How can you help?
|
||||
|
||||
Please... Spread the word, contribute algorithms, submit performance improvements, unit tests.
|
||||
|
||||
Performance is a biggie, if you know anything about the new vector types and can apply some fancy new stuff with that it would be awesome.
|
||||
|
||||
There's a lot of developers out there who could write this stuff a lot better and faster than I and I would love to see what we collectively can come up with so please, if you can help in any way it would be most welcome and benificial for all.
|
||||
### Projects using Shaper2D
|
||||
|
||||
### The ImageSharp Team
|
||||
None yet but should soon be used by SvgSharp and ImageSharp.
|
||||
|
||||
Grand High Eternal Dictator
|
||||
- [Scott Williams](https://github.com/jimbobsquarepants)
|
||||
### The Shaper2D Team
|
||||
|
||||
Core Team
|
||||
- [Dirk Lemstra](https://github.com/dlemstra)
|
||||
- [Jeavon Leopold](https://github.com/jeavon)
|
||||
- [Anton Firsov](https://github.com/antonfirsov)
|
||||
- [Olivia Ifrim](https://github.com/olivif)
|
||||
Lead
|
||||
- [Scott Williams](https://github.com/tocsoft)
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче