mirror of
https://github.com/talgo-cloud/bimg.git
synced 2026-03-16 02:45:54 -07:00
feat(docs): update API docs
This commit is contained in:
parent
5dfb883f50
commit
92e14757b0
1 changed files with 32 additions and 0 deletions
32
README.md
32
README.md
|
|
@ -287,6 +287,18 @@ VIPS_TRACE=1 ./app
|
||||||
|
|
||||||
### Programmatic API
|
### Programmatic API
|
||||||
|
|
||||||
|
```go
|
||||||
|
const HasMagickSupport = int(C.VIPS_MAGICK_SUPPORT) == 1
|
||||||
|
```
|
||||||
|
|
||||||
|
```go
|
||||||
|
const Version = "0.1.20"
|
||||||
|
```
|
||||||
|
|
||||||
|
```go
|
||||||
|
const WATERMARK_FONT = "sans 10"
|
||||||
|
```
|
||||||
|
|
||||||
#### func ColourspaceIsSupported
|
#### func ColourspaceIsSupported
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
|
@ -396,6 +408,16 @@ const (
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### type GaussianBlur
|
||||||
|
|
||||||
|
```go
|
||||||
|
type GaussianBlur struct {
|
||||||
|
Sigma float64
|
||||||
|
MinAmpl float64
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
#### type Gravity
|
#### type Gravity
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
|
@ -505,6 +527,13 @@ func (i *Image) Flop() ([]byte, error)
|
||||||
```
|
```
|
||||||
Flop the image about the horizontal X axis
|
Flop the image about the horizontal X axis
|
||||||
|
|
||||||
|
#### func (*Image) ForceResize
|
||||||
|
|
||||||
|
```go
|
||||||
|
func (i *Image) ForceResize(width, height int) ([]byte, error)
|
||||||
|
```
|
||||||
|
Force resize with custom size (aspect ratio won't be maintained)
|
||||||
|
|
||||||
#### func (*Image) Image
|
#### func (*Image) Image
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
|
@ -697,6 +726,8 @@ const (
|
||||||
INTERPRETATION_RGB16 Interpretation = C.VIPS_INTERPRETATION_RGB16
|
INTERPRETATION_RGB16 Interpretation = C.VIPS_INTERPRETATION_RGB16
|
||||||
INTERPRETATION_GREY16 Interpretation = C.VIPS_INTERPRETATION_GREY16
|
INTERPRETATION_GREY16 Interpretation = C.VIPS_INTERPRETATION_GREY16
|
||||||
INTERPRETATION_scRGB Interpretation = C.VIPS_INTERPRETATION_scRGB
|
INTERPRETATION_scRGB Interpretation = C.VIPS_INTERPRETATION_scRGB
|
||||||
|
INTERPRETATION_LAB Interpretation = C.VIPS_INTERPRETATION_LAB
|
||||||
|
INTERPRETATION_XYZ Interpretation = C.VIPS_INTERPRETATION_XYZ
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -737,6 +768,7 @@ type Options struct {
|
||||||
Type ImageType
|
Type ImageType
|
||||||
Interpolator Interpolator
|
Interpolator Interpolator
|
||||||
Interpretation Interpretation
|
Interpretation Interpretation
|
||||||
|
GaussianBlur GaussianBlur
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue