Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

FrameTexture

Defined in: packages/sigma/src/rendering/frame-texture.ts:28

Constructors

Constructor

new FrameTexture(gl, options): FrameTexture

Defined in: packages/sigma/src/rendering/frame-texture.ts:37

Parameters

gl

WebGL2RenderingContext

options

FrameTextureOptions

Returns

FrameTexture

Methods

bind()

bind(textureUnit): void

Defined in: packages/sigma/src/rendering/frame-texture.ts:122

Binds the texture to a unit for sampling by consumers.

Parameters

textureUnit

number

Returns

void


bindAsRenderTarget()

bindAsRenderTarget(): void

Defined in: packages/sigma/src/rendering/frame-texture.ts:115

Binds the texture as the render target and sets the viewport to its size, ready for the frame-pass to scatter values into it. The caller restores the default framebuffer/viewport afterward.

Returns

void


ensureCapacity()

ensureCapacity(capacity): void

Defined in: packages/sigma/src/rendering/frame-texture.ts:96

Grows the texture so capacity items are addressable, keeping it sized against the matching data texture. A no-op once large enough.

Parameters

capacity

number

Returns

void


getTexture()

getTexture(): WebGLTexture | null

Defined in: packages/sigma/src/rendering/frame-texture.ts:128

Returns

WebGLTexture | null


getTextureHeight()

getTextureHeight(): number

Defined in: packages/sigma/src/rendering/frame-texture.ts:136

Returns

number


getTextureWidth()

getTextureWidth(): number

Defined in: packages/sigma/src/rendering/frame-texture.ts:132

Returns

number


kill()

kill(): void

Defined in: packages/sigma/src/rendering/frame-texture.ts:140

Returns

void