Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 10:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: update liborc references to highway

Browse Source
This commit is contained in:
Lovell Fuller 2023-12-12 12:01:41 +00:00
parent 0adf7ef16f
commit 19fa4cd1d3
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api-utility.md
View File

@ -151,7 +151,7 @@ const counters = sharp.counters(); // { queue: 2, process: 4 }
> simd([simd]) ⇒ <code>boolean</code> > simd([simd]) ⇒ <code>boolean</code>
Get and set use of SIMD vector unit instructions. Get and set use of SIMD vector unit instructions.
Requires libvips to have been compiled with liborc support. Requires libvips to have been compiled with highway support.
Improves the performance of `resize`, `blur` and `sharpen` operations Improves the performance of `resize`, `blur` and `sharpen` operations
by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON. by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
@ -165,12 +165,12 @@ by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM N
**Example** **Example**
```js ```js
const simd = sharp.simd(); const simd = sharp.simd();
// simd is `true` if the runtime use of liborc is currently enabled // simd is `true` if the runtime use of highway is currently enabled
``` ```
**Example** **Example**
```js ```js
const simd = sharp.simd(false); const simd = sharp.simd(false);
// prevent libvips from using liborc at runtime // prevent libvips from using highway at runtime
``` ```

2
docs/search-index.json
View File

File diff suppressed because one or more lines are too long

2
lib/index.d.ts vendored
View File

@ -126,7 +126,7 @@ declare namespace sharp {
function counters(): SharpCounters; function counters(): SharpCounters;
/** /**
* Get and set use of SIMD vector unit instructions. Requires libvips to have been compiled with liborc support. * Get and set use of SIMD vector unit instructions. Requires libvips to have been compiled with highway support.
* Improves the performance of resize, blur and sharpen operations by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON. * Improves the performance of resize, blur and sharpen operations by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
* @param enable enable or disable use of SIMD vector unit instructions * @param enable enable or disable use of SIMD vector unit instructions
* @returns true if usage of SIMD vector unit instructions is enabled * @returns true if usage of SIMD vector unit instructions is enabled

6
lib/utility.js
View File

@ -183,17 +183,17 @@ function counters () {
/** /**
* Get and set use of SIMD vector unit instructions. * Get and set use of SIMD vector unit instructions.
* Requires libvips to have been compiled with liborc support. * Requires libvips to have been compiled with highway support.
* *
* Improves the performance of `resize`, `blur` and `sharpen` operations * Improves the performance of `resize`, `blur` and `sharpen` operations
* by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON. * by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
* *
* @example * @example
* const simd = sharp.simd(); * const simd = sharp.simd();
* // simd is `true` if the runtime use of liborc is currently enabled * // simd is `true` if the runtime use of highway is currently enabled
* @example * @example
* const simd = sharp.simd(false); * const simd = sharp.simd(false);
* // prevent libvips from using liborc at runtime * // prevent libvips from using highway at runtime
* *
* @param {boolean} [simd=true] * @param {boolean} [simd=true]
* @returns {boolean} * @returns {boolean}