Skip to content

Commit

Permalink
Docs: update liborc references to highway
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Dec 12, 2023
1 parent 0adf7ef commit 19fa4cd
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/api-utility.md
Expand Up @@ -151,7 +151,7 @@ const counters = sharp.counters(); // { queue: 2, process: 4 }
> simd([simd]) ⇒ <code>boolean</code>
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
by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
Expand All @@ -165,12 +165,12 @@ by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM N
**Example**
```js
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**
```js
const simd = sharp.simd(false);
// prevent libvips from using liborc at runtime
// prevent libvips from using highway at runtime
```


Expand Down
2 changes: 1 addition & 1 deletion docs/search-index.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/index.d.ts
Expand Up @@ -126,7 +126,7 @@ declare namespace sharp {
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.
* @param enable enable or disable use of SIMD vector unit instructions
* @returns true if usage of SIMD vector unit instructions is enabled
Expand Down
6 changes: 3 additions & 3 deletions lib/utility.js
Expand Up @@ -183,17 +183,17 @@ function counters () {

/**
* 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
* by taking advantage of the SIMD vector unit of the CPU, e.g. Intel SSE and ARM NEON.
*
* @example
* 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
* const simd = sharp.simd(false);
* // prevent libvips from using liborc at runtime
* // prevent libvips from using highway at runtime
*
* @param {boolean} [simd=true]
* @returns {boolean}
Expand Down

0 comments on commit 19fa4cd

Please sign in to comment.