# usePointerCapture

Source: /tuil/docs/reference/packages/ink/api/use-pointer-capture
Locale: en

function exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function usePointerCapture(id: string): {
  readonly capture: () => void;
  readonly release: () => void;
};
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member | Type     | Required | Description                          | Related types |
| ------ | -------- | -------- | ------------------------------------ | ------------- |
| `id`   | `string` | Yes      | Supplies the `id` value as `string`. | —             |

## Returns [#returns]

`{
  readonly capture: () => void;
  readonly release: () => void;
}` — Returns a value that satisfies `{
  readonly capture: () => void;
  readonly release: () => void;
}`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/pointer.ts)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)