mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 10:30:15 +02:00
Docs: prebuilt binaries support tile-based output (#4305)
Except when targeting WebAssembly.
This commit is contained in:
parent
82dc859a49
commit
92083ea64c
@ -762,10 +762,6 @@ Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed arc
|
|||||||
|
|
||||||
The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
|
The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
|
||||||
|
|
||||||
Requires libvips compiled with support for libgsf.
|
|
||||||
The prebuilt binaries do not include this - see
|
|
||||||
[installing a custom libvips](https://sharp.pixelplumbing.com/install#custom-libvips).
|
|
||||||
|
|
||||||
|
|
||||||
**Throws**:
|
**Throws**:
|
||||||
|
|
||||||
|
@ -135,6 +135,8 @@ Use in web browsers is unsupported.
|
|||||||
|
|
||||||
Native text rendering is unsupported.
|
Native text rendering is unsupported.
|
||||||
|
|
||||||
|
[Tile-based output](/api-output#tile) is unsupported.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install --cpu=wasm32 sharp
|
npm install --cpu=wasm32 sharp
|
||||||
```
|
```
|
||||||
|
File diff suppressed because one or more lines are too long
2
lib/index.d.ts
vendored
2
lib/index.d.ts
vendored
@ -799,8 +799,6 @@ declare namespace sharp {
|
|||||||
* Use tile-based deep zoom (image pyramid) output.
|
* Use tile-based deep zoom (image pyramid) output.
|
||||||
* Set the format and options for tile images via the toFormat, jpeg, png or webp functions.
|
* Set the format and options for tile images via the toFormat, jpeg, png or webp functions.
|
||||||
* Use a .zip or .szi file extension with toFile to write to a compressed archive file format.
|
* Use a .zip or .szi file extension with toFile to write to a compressed archive file format.
|
||||||
*
|
|
||||||
* Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.
|
|
||||||
* @param tile tile options
|
* @param tile tile options
|
||||||
* @throws {Error} Invalid options
|
* @throws {Error} Invalid options
|
||||||
* @returns A sharp instance that can be used to chain operations
|
* @returns A sharp instance that can be used to chain operations
|
||||||
|
@ -1232,10 +1232,6 @@ function raw (options) {
|
|||||||
*
|
*
|
||||||
* The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
|
* The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
|
||||||
*
|
*
|
||||||
* Requires libvips compiled with support for libgsf.
|
|
||||||
* The prebuilt binaries do not include this - see
|
|
||||||
* {@link https://sharp.pixelplumbing.com/install#custom-libvips installing a custom libvips}.
|
|
||||||
*
|
|
||||||
* @example
|
* @example
|
||||||
* sharp('input.tiff')
|
* sharp('input.tiff')
|
||||||
* .png()
|
* .png()
|
||||||
|
Loading…
x
Reference in New Issue
Block a user