Created
March 12, 2022 11:17
-
-
Save Theaninova/5861dfcebfce27bdcce4668d0d18d53c to your computer and use it in GitHub Desktop.
Type Definitions for https://github.com/patriciogonzalezvivo/glslCanvas
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
declare module 'glslCanvas' { | |
export type DefaultUniforms = 'u_mouse' | 'u_resolution' | 'u_time' | 'u_tex' | |
export interface TestResult { | |
wasValid: boolean | |
frag?: string | |
vert?: string | |
timeElapsedMs: number | |
} | |
export type TextureData = object | |
export type UniformTypes = string | boolean | number | number[] | |
export interface Uniforms { | |
[name: string]: UniformTypes | Uniforms | |
} | |
export interface Mouse { | |
x: number | |
y: number | |
} | |
export interface ConstructorOptions { | |
fragmentString: string | |
vertexString?: string | |
backgroundColor: 'rgba(1,1,1,0)' | string | |
[key: string]: unknown | |
} | |
export type LoadTextureOptions = object | |
export type UniformMethods = `${1 | 2 | 3 | 4}${'f' | 'i'}${'v' | ''}` | `${2 | 3 | 4}fv` | |
export type UniformGlslTypes = | |
| 'float' | |
| 'int' | |
| 'bool' | |
| 'vec2' | |
| 'vec3' | |
| 'vec4' | |
| 'ivec2' | |
| 'ivec3' | |
| 'ivec4' | |
| 'bvec2' | |
| 'bvec3' | |
| 'bvec4' | |
| 'mat2' | |
| 'mat3' | |
| 'mat4' | |
| 'sampler2D' | |
| string | |
export type FragmentBuffers<T extends string> = Record<`u_buffer${number}`, {fragment: `${string}${T}`}> | |
class GlslCanvas { | |
width: number | |
height: number | |
canvas: HTMLCanvasElement | |
gl: WebGLRenderingContext | |
program?: unknown | |
textures: object | |
buffers: unknown | |
uniforms: Uniforms | |
vbo: object | |
isValid: boolean | |
BUFFER_COUNT: number | |
TEXTURE_COUNT: number | |
vertexString: string | |
timeLoad: number | |
timeDelta: number | |
forceRender: boolean | |
paused: boolean | |
realToCSSPixels: number | |
constructor(canvas: HTMLCanvasElement, contextOptions?: Partial<ConstructorOptions>, options?: object) | |
setUniform(name: string, ...value: UniformTypes[]): void | |
load(fragmentShader: string, vertexShader?: string): void | |
destroy(): void | |
test(callback: (result: TestResult) => void, fragString?: string, vertString?: string): void | |
loadTexture( | |
name: string, | |
urlElementOrData: string | TextureData, | |
options?: Partial<LoadTextureOptions>, | |
): void | |
refreshUniforms(): void | |
setUniforms(uniforms: Uniforms): void | |
setMouse(mouse: Mouse): void | |
uniform(method: UniformMethods, type: UniformGlslTypes, name: string, ...value: UniformTypes[]): void | |
uniformTexture(name: string, texture: unknown, options?: object): void | |
resize(): void | |
render(): void | |
play(): void | |
pause(): void | |
renderPrograms(): void | |
getBuffers<T extends string>(fragString: T): FragmentBuffers<T> | |
loadPrograms(buffers: FragmentBuffers<string>): void | |
createSwappableBuffer(W: GLsizei, H: GLsizei, program: unknown): object | |
createBuffer( | |
W: GLsizei, | |
H: GLsizei, | |
): { | |
index: number | |
texture: unknown | |
buffer: unknown | |
W: GLsizei | |
H: GLsizei | |
resize: (W: GLsizei, H: GLsizei) => void | |
} | |
resizeSwappableBuffers(): void | |
version(): `${number}.${number}.${number}` | |
} | |
export default GlslCanvas | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment