Class TextTexture

A texture that renders text using an internal HTML Canvas.

Hierarchy (View Summary)

Texture
- TextTexture

Index

Constructors

Properties

_ph _pw _px _py base? flipY glTexture isAtlas isRotated offsetX offsetY rawHeight rawWidth scale uvH uvW uvX uvY

Accessors

height style text width

Methods

clone destroy getSubTexture setBase setRegion splitGrid update fromImageSource

Constructors

constructor

new TextTexture(render: Rapid, options?: ITextOptions): TextTexture
Parameters
- render: Rapid
- Optionaloptions: ITextOptions
Returns TextTexture
Overrides Texture.constructor
- Defined in texture.ts:668

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

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

style

get style(): ITextStyle
Returns ITextStyle
- Defined in texture.ts:703
set style(value: Partial<ITextStyle>): void
Set new style partially and update the texture
Parameters
- value: Partial<ITextStyle>
Returns void
- Defined in texture.ts:710

text

get text(): string
Returns string
- Defined in texture.ts:689
set text(value: string): void
Set new text and update the texture
Parameters
- value: string
Returns void
- Defined in texture.ts:696

width

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

Methods

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

destroy

destroy(): void
Marks this Texture as destroyed, decrementing the BaseTexture reference count.

Returns void
Inherited from Texture.destroy
- Defined in texture.ts:432

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

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

update

update(): void
Updates the internal canvas and uploads it to WebGL

Returns void
- Defined in texture.ts:730

`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