mirror of
https://github.com/talgo-cloud/bimg.git
synced 2026-03-15 18:35:54 -07:00
feat(docs): update API
This commit is contained in:
parent
1d76750fb9
commit
41692f384d
1 changed files with 5 additions and 13 deletions
18
README.md
18
README.md
|
|
@ -242,7 +242,7 @@ Enable libvips traces (note that a lot of data will be written in stdout):
|
||||||
VIPS_TRACE=1 ./app
|
VIPS_TRACE=1 ./app
|
||||||
```
|
```
|
||||||
|
|
||||||
#### func DetermineImageTypeName
|
#### func DetermineImageTypeName
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func DetermineImageTypeName(buf []byte) string
|
func DetermineImageTypeName(buf []byte) string
|
||||||
|
|
@ -271,13 +271,6 @@ func IsTypeSupported(t ImageType) bool
|
||||||
```
|
```
|
||||||
Check if a given image type is supported
|
Check if a given image type is supported
|
||||||
|
|
||||||
#### func PrintMemoryStats
|
|
||||||
|
|
||||||
```go
|
|
||||||
func PrintMemoryStats()
|
|
||||||
```
|
|
||||||
Print Go memory and garbage collector stats. Useful for debugging
|
|
||||||
|
|
||||||
#### func Read
|
#### func Read
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
|
@ -295,8 +288,8 @@ func Resize(buf []byte, o Options) ([]byte, error)
|
||||||
```go
|
```go
|
||||||
func Shutdown()
|
func Shutdown()
|
||||||
```
|
```
|
||||||
Explicit thread-safe libvips shutdown. Call this to drop caches. If libvips was
|
Thread-safe function to shutdown libvips. You could call this to drop caches as
|
||||||
already initialized, the function is no-op
|
well. If libvips was already initialized, the function is no-op
|
||||||
|
|
||||||
#### func VipsDebug
|
#### func VipsDebug
|
||||||
|
|
||||||
|
|
@ -505,9 +498,9 @@ Add text as watermark on the given image
|
||||||
#### func (*Image) Zoom
|
#### func (*Image) Zoom
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func (i *Image) Zoom(level int) ([]byte, error)
|
func (i *Image) Zoom(factor int) ([]byte, error)
|
||||||
```
|
```
|
||||||
Zoom the image by the given factor
|
Zoom the image by the given factor. You should probably call Extract() before
|
||||||
|
|
||||||
#### type ImageMetadata
|
#### type ImageMetadata
|
||||||
|
|
||||||
|
|
@ -634,7 +627,6 @@ type VipsMemoryInfo struct {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
#### func VipsMemory
|
#### func VipsMemory
|
||||||
|
|
||||||
```go
|
```go
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue