Class RenderTexture

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

Hierarchy (View Summary)

Texture
- RenderTexture

Index

Constructors

Constructors

constructor

new RenderTexture(render: Rapid, options: IRenderTextureOptions): RenderTexture
Parameters
- render: Rapid
- options: IRenderTextureOptions
Returns RenderTexture
Overrides Texture.constructor
- Defined in texture.ts:461

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

`Optional`clearColor

clearColor?: Color

flipY

flipY: boolean = true

glTexture

glTexture: WebGLTexture | null = null

isAtlas

isAtlas: boolean = false

isRotated

isRotated: boolean = false

offsetX

offsetX: number = 0

offsetY

offsetY: number = 0

rawHeight

rawHeight: number = 0

rawWidth

rawWidth: number = 0

scale

scale: number = 1

uvH

uvH: number = 1

uvW

uvW: number = 1

uvX

uvX: number = 0

uvY

uvY: number = 0

Accessors

height

get height(): number
Returns number
Inherited from Texture.height
- Defined in texture.ts:284

width

get width(): number
Returns number
Inherited from Texture.width
- Defined in texture.ts:280

Methods

activate

activate(clear?: boolean): void
Activates this texture as the current render target.
Parameters
- clear: boolean = false
  Whether to clear the render target after activation.
Returns void
- Defined in texture.ts:543

clear

clear(clearColor?: Color): void
Parameters
- OptionalclearColor: Color
Returns void
- Defined in texture.ts:552

clone

clone(target?: Texture): Texture
Creates a shallow copy of this Texture, sharing the same BaseTexture.
Parameters
- Optionaltarget: Texture
Returns Texture
A new Texture instance.
Inherited from Texture.clone
- Defined in texture.ts:369

deactivate

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

Returns void
- Defined in texture.ts:566

destroy

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

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

GetColorAt

GetColorAt(x: number, y: number): Color
Get the color at a pixel in the render texture.
Parameters
- x: number
  X coordinate in logical pixel space (top-left origin).
- y: number
  Y coordinate in logical pixel space (top-left origin).
Returns Color
- Defined in texture.ts:614

GetPixels

GetPixels(x?: number, y?: number, width?: number, height?: number): Uint8Array
Get raw pixels from the render texture.
Parameters
- x: number = 0
  X coordinate in logical pixel space (top-left origin).
- y: number = 0
  Y coordinate in logical pixel space (top-left origin).
- width: number = ...
  Width of the region to read.
- height: number = ...
  Height of the region to read.
Returns Uint8Array
- Defined in texture.ts:578

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:352

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:495

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:303

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:326

splitGrid

splitGrid(
    cellWidth: number,
    cellHeight: number,
    cols?: number,
    rows?: number,
    gap?: 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.
- gap: number = 0
  Optional pixel gap between cells.
Returns Texture[]
An array of split Textures.
Inherited from Texture.splitGrid
- Defined in texture.ts:398

`Static`fromImageSource

fromImageSource(
    render: Rapid,
    source: Images,
    options?: ITextureOptions,
): Texture
Creates a Texture directly from an image source, bypassing the TextureManager.
Parameters
- render: Rapid
- source: Images
  The image element, canvas, video, or bitmap.
- options: ITextureOptions = {}
  Optional antialias and wrap mode settings.
Returns Texture
Inherited from Texture.fromImageSource
- Defined in texture.ts:424

Class RenderTexture

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderTexture

Properties

Protected_ph

Protected_pw

Protected_px

Protected_py

Optionalbase

OptionalclearColor

flipY

glTexture

isAtlas

isRotated

offsetX

offsetY

rawHeight

rawWidth

scale

uvH

uvW

uvX

uvY

Accessors

height

Returns number

width

Returns number

Methods

activate

Parameters

Returns void

clear

Parameters

Returns void

clone

Parameters

Returns Texture

deactivate

Returns void

destroy

Returns void

GetColorAt

Parameters

Returns Color

GetPixels

Parameters

Returns Uint8Array

getSubTexture

Parameters

Returns Texture

resize

Parameters

Returns void

setBase

Parameters

Returns this

setRegion

Parameters

Returns this

splitGrid

Parameters

Returns Texture[]

StaticfromImageSource

Parameters

Returns Texture

Settings

On This Page

`Protected`_ph

`Protected`_pw

`Protected`_px

`Protected`_py

`Optional`base

`Optional`clearColor

`Static`fromImageSource