Class RenderTexture

A texture that can be rendered to (wraps a WebGL Framebuffer).

Hierarchy (View Summary)

Texture
- RenderTexture

Index

Constructors

Properties

_ph _pw _px _py base? flipY glTexture height padding scale uvH uvW uvX uvY width

Methods

activate clone deactivate destroy getSubTexture resize setBase setRegion splitGrid withPadding

Constructors

constructor

new RenderTexture(
    render: Rapid,
    width: number,
    height: number,
    options?: ITextureOptions,
): RenderTexture
Parameters
- render: Rapid
- width: number
- height: number
- Optionaloptions: ITextureOptions
Returns RenderTexture
Overrides Texture.constructor
- Defined in texture.ts:423

Properties

`Protected`_ph

_ph: number = 0

`Protected`_pw

_pw: number = 0

`Protected`_px

_px: number = 0

`Protected`_py

_py: number = 0

`Optional`base

base?: BaseTexture

flipY

flipY: boolean = true

glTexture

glTexture: WebGLTexture | null = null

height

height: number = 0

padding

padding: number = 0

scale

scale: number = 1

uvH

uvH: number = 1

uvW

uvW: number = 1

uvX

uvX: number = 0

uvY

uvY: number = 0

width

width: number = 0

Methods

activate

activate(clearColor?: Color): void
Activates this texture as the current render target.
Parameters
- OptionalclearColor: Color
  Optional color to clear the buffer with.
Returns void
- Defined in texture.ts:505

clone

clone(): Texture
Creates a shallow copy of this Texture, sharing the same BaseTexture.

Returns Texture
A new Texture instance.
Inherited from Texture.clone
- Defined in texture.ts:332

deactivate

deactivate(): void
Deactivates this texture, returning rendering to the default frame buffer.

Returns void
- Defined in texture.ts:520

destroy

destroy(): void
Destroys the framebuffer, renderbuffer, and base texture.

Returns void
Overrides Texture.destroy
- Defined in texture.ts:528

getSubTexture

getSubTexture(x: number, y: number, width: number, height: number): Texture
Creates a new Texture representing a sub-region of this Texture.
Parameters
- x: number
  The x coordinate in pixels, relative to this texture's logical start.
- y: number
  The y coordinate in pixels, relative to this texture's logical start.
- width: number
  The width of the sub-texture in pixels.
- height: number
  The height of the sub-texture in pixels.
Returns Texture
A new Texture pointing to the sub-region.
Inherited from Texture.getSubTexture
- Defined in texture.ts:315

resize

resize(width: number, height: number, force?: boolean): void
Resizes the render texture using a grow-only GPU allocation strategy.
- GPU memory is only reallocated when the new size exceeds the current allocation.
- Shrinking only updates the logical dimensions and UV sub-region — no GPU work.
This makes it safe to call every frame with varying sizes (e.g. inside applyFilters).
Parameters
- width: number
  New logical width.
- height: number
  New logical height.
- force: boolean = false
  Force full GPU reallocation regardless of current allocation size.
Returns void
- Defined in texture.ts:456

setBase

setBase(base: BaseTexture): this
Sets the base texture and increments its reference count.
Parameters
- base: BaseTexture
  The BaseTexture instance.
Returns this
The current Texture instance.
Inherited from Texture.setBase
- Defined in texture.ts:261

setRegion

setRegion(x: number, y: number, w: number, h: number): this
Sets the visible region (clipping) in pixels relative to the BaseTexture.
Parameters
- x: number
  The x coordinate in pixels.
- y: number
  The y coordinate in pixels.
- w: number
  The width in pixels.
- h: number
  The height in pixels.
Returns this
The current Texture instance.
Inherited from Texture.setRegion
- Defined in texture.ts:284

splitGrid

splitGrid(
    cellWidth: number,
    cellHeight: number,
    cols?: number,
    rows?: number,
): Texture[]
Utility to split this texture into a grid of sprite textures. Sub-textures will respect the current UV offsets.
Parameters
- cellWidth: number
  The width of each cell in pixels.
- cellHeight: number
  The height of each cell in pixels.
- Optionalcols: number
  Optional number of columns. Truncates based on texture width if omitted.
- Optionalrows: number
  Optional number of rows. Truncates based on texture height if omitted.
Returns Texture[]
An array of split Textures.
Inherited from Texture.splitGrid
- Defined in texture.ts:379

withPadding

withPadding(pixels: number): Texture
Returns a new Texture with the rendered quad expanded by pixels on all sides. The UV coordinates are adjusted outward so the padded border samples outside the original texture region (which is transparent when using CLAMP wrap mode).

Use this with outline or glow shaders that need to draw beyond the texture edge.
Parameters
- pixels: number
  Number of pixels to expand on each side.
Returns Texture
Example
```
const padded = catTex.withPadding(6);
rapid.drawSprite(padded, Color.White(), false, false, outlineShader);
```
Inherited from Texture.withPadding
- Defined in texture.ts:356