# glsl-shader-name

> Extract a shader's name from its source

Latest version **1.0.0** (published 2015-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install glsl-shader-name
pnpm add glsl-shader-name
yarn add glsl-shader-name
bun add glsl-shader-name
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-06-25 |
| First published | 2015-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Hugh Kennedy |
| Maintainers | hughsk |
| Keywords | ecosystem:stackgl |

## Links

- npm: https://www.npmjs.com/package/glsl-shader-name
- Repository: https://github.com/stackgl/glsl-shader-name
- Issues: https://github.com/stackgl/glsl-shader-name/issues
- npm.io page: https://npm.io/package/glsl-shader-name

## Dependencies (2)

- [atob-lite](https://npm.io/package/atob-lite.md) ^1.0.0
- [glsl-tokenizer](https://npm.io/package/glsl-tokenizer.md) ^2.0.2

## Recent versions

- 1.0.0 (latest) — 2015-06-25

## README

# glsl-shader-name

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

Extract a shader's name from its source, as specified in
[@spite's ShaderEditorExtension](https://github.com/spite/ShaderEditorExtension/issues/10).

``` glsl
// in plaintext:
#define SHADER_NAME hello world

// or for non-ASCII characters using base64:
#define SHADER_NAME_B64 aGVsbG8gd29ybGQ=
```

This is a simple pattern for identifying otherwise anonymous
shaders in GLSL tooling.

## Usage

[![NPM](https://nodei.co/npm/glsl-shader-name.png)](https://nodei.co/npm/glsl-shader-name/)

### `name = shaderName(src)`

Retrieves the shader name from a GLSL source string `src`.
You may also pass in a list of tokens generated by
[glsl-tokenizer](https://github.com/stackgl/glsl-tokenizer).

## Contributing

See [stackgl/contributing](https://github.com/stackgl/contributing) for details.

## License

MIT. See [LICENSE.md](http://github.com/stackgl/glsl-shader-name/blob/master/LICENSE.md) for details.

---
_Source: https://npm.io/package/glsl-shader-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._