# renderTerminalImage

Source: /tuil/docs/reference/packages/ink/api/render-terminal-image
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 renderTerminalImage(
  source: TerminalImageSource,
  columns = source.width,
  color = true,
): string;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                  | Required | Description                                           | Related types                                                                   |
| --------- | --------------------- | -------- | ----------------------------------------------------- | ------------------------------------------------------------------------------- |
| `source`  | `TerminalImageSource` | Yes      | Supplies the `source` value as `TerminalImageSource`. | [`TerminalImageSource`](/tuil/docs/reference/packages/ink/api/terminal-image-source) |
| `columns` | `unknown`             | No       | Supplies the `columns` value as `unknown`.            | —                                                                               |
| `color`   | `unknown`             | No       | Supplies the `color` value as `unknown`.              | —                                                                               |

## Returns [#returns]

`string` — Returns a value that satisfies `string`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalImageSource`](/tuil/docs/reference/packages/ink/api/terminal-image-source)

## Source [#source]

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

## Package [#package]

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