Class SpriteRegion

Hierarchy (View Summary)

Region
- SpriteRegion

Constructors

constructor

new SpriteRegion(rapid: Rapid): SpriteRegion
Parameters
- rapid: Rapid
Returns SpriteRegion
Overrides Region.constructor
- Defined in region/spriteRegion.ts:34

Properties

currentShader

currentShader: GLShader

customShader

customShader: CustomGlShader | null = null

customShaderUsedTextureNum

customShaderUsedTextureNum: number = 0

defaultShader

defaultShader: GLShader

fs

fs: string = ""

gl

gl: WebGL2RenderingContext

`Protected`instanceBuffer

instanceBuffer: WebglBufferArray

`Protected`instanceCount

instanceCount: number = 0

isDefaultShader

isDefaultShader: boolean = true

KEY

KEY: string = "Sprite"

`Protected`localSpriteMatrix

localSpriteMatrix: Float32Array<ArrayBuffer> = ...

matrixStore

matrixStore: MatrixStore

maxTextureUnits

maxTextureUnits: number

`Protected`quadBuffer

quadBuffer: WebglBufferArray

rapid

rapid: Rapid

`Protected`usedTexturePadding

usedTexturePadding: number[] = []

`Protected`usedTextures

usedTextures: WebGLTexture[] = []

vs

vs: string = ""

`Protected`worldSpriteMatrix

worldSpriteMatrix: Float32Array<ArrayBuffer> = ...

Accessors

freeTextureUnitNum

get freeTextureUnitNum(): number
Returns number
Inherited from Region.freeTextureUnitNum
- Defined in region/region.ts:38

Methods

createBuffer

createBuffer(): void
Returns void
Overrides Region.createBuffer
- Defined in region/spriteRegion.ts:41

createCustomShader

createCustomShader(customShader: CustomGlShader): GLShader | null
Parameters
- customShader: CustomGlShader
Returns GLShader | null
Overrides Region.createCustomShader
- Defined in region/spriteRegion.ts:90

createDefaultShader

createDefaultShader(): GLShader
Returns GLShader
Overrides Region.createDefaultShader
- Defined in region/spriteRegion.ts:56

createShader

createShader(vs: string, fs: string): GLShader
Parameters
- vs: string
- fs: string
Returns GLShader
Overrides Region.createShader
- Defined in region/spriteRegion.ts:66

drawSprite

drawSprite(
    texture: Texture,
    matrixIndex: number,
    u0?: number,
    v0?: number,
    u1?: number,
    v1?: number,
    color?: number,
    paddingX?: number,
    paddingY?: number,
    flipX?: boolean,
    flipY?: boolean,
    isRotated?: boolean,
): void
Draws a textured sprite via instanced rendering to significantly improve performance.
Parameters
- texture: Texture
  The WebGLTexture to map.
- matrixIndex: number
  The index for the transform matrix in MatrixStore.
- u0: number = 0
  Left UV mapped coordinate (default 0).
- v0: number = 0
  Top UV mapped coordinate (default 0).
- u1: number = 1
  Right UV mapped coordinate (default 1).
- v1: number = 1
  Bottom UV mapped coordinate (default 1).
- color: number = 0xFFFFFFFF
  The tint color as packed ABGR uniform uint32 (default 0xFFFFFFFF).
- paddingX: number = 0
- paddingY: number = 0
- flipX: boolean = false
- flipY: boolean = false
- isRotated: boolean = false
Returns void
- Defined in region/spriteRegion.ts:109

drawSpriteAffine

drawSpriteAffine(
    texture: Texture,
    matrixA: number,
    matrixB: number,
    matrixC: number,
    matrixD: number,
    matrixTx: number,
    matrixTy: number,
    u0?: number,
    v0?: number,
    u1?: number,
    v1?: number,
    color?: number,
    paddingX?: number,
    paddingY?: number,
    flipX?: boolean,
    flipY?: boolean,
    isRotated?: boolean,
): void
Parameters
- texture: Texture
- matrixA: number
- matrixB: number
- matrixC: number
- matrixD: number
- matrixTx: number
- matrixTy: number
- u0: number = 0
- v0: number = 0
- u1: number = 1
- v1: number = 1
- color: number = 0xFFFFFFFF
- paddingX: number = 0
- paddingY: number = 0
- flipX: boolean = false
- flipY: boolean = false
- isRotated: boolean = false
Returns void
- Defined in region/spriteRegion.ts:144

enter

enter(customShader?: GLShader | CustomGlShader): void
Parameters
- OptionalcustomShader: GLShader | CustomGlShader
Returns void
Inherited from Region.enter
- Defined in region/region.ts:113

exit

exit(): void
Returns void
Inherited from Region.exit
- Defined in region/region.ts:128

`Protected`findTextureUnit

findTextureUnit(
    texture: WebGLTexture,
    paddingX?: number,
    paddingY?: number,
): number
Parameters
- texture: WebGLTexture
- paddingX: number = 0
- paddingY: number = 0
Returns number
Inherited from Region.findTextureUnit
- Defined in region/region.ts:47

flush

flush(): void
Returns void
Inherited from Region.flush
- Defined in region/region.ts:135

getCustomShader

getCustomShader(customShader?: GLShader | CustomGlShader): GLShader
Parameters
- OptionalcustomShader: GLShader | CustomGlShader
Returns GLShader
Inherited from Region.getCustomShader
- Defined in region/region.ts:86

getTextureUnitList

getTextureUnitList(): number[]
Returns number[]
Inherited from Region.getTextureUnitList
- Defined in region/region.ts:42

hasPendingContent

hasPendingContent(): boolean
Returns boolean
Overrides Region.hasPendingContent
- Defined in region/spriteRegion.ts:268

isSameShader

isSameShader(customShader?: GLShader | CustomGlShader): boolean
Checks if the given shader is the same as the currently bound shader.
Parameters
- OptionalcustomShader: GLShader | CustomGlShader
  Optional custom shader.
Returns boolean
True if already bound, otherwise false.
Inherited from Region.isSameShader
- Defined in region/region.ts:105

`Protected`prepareRender

prepareRender(): void
Returns void
Inherited from Region.prepareRender
- Defined in region/region.ts:144

render

render(): void
Returns void
Overrides Region.render
- Defined in region/spriteRegion.ts:246

resetRender

resetRender(): void
Returns void
Overrides Region.resetRender
- Defined in region/spriteRegion.ts:262

useTexture

useTexture(texture: WebGLTexture, paddingX?: number, paddingY?: number): number
Parameters
- texture: WebGLTexture
- paddingX: number = 0
- paddingY: number = 0
Returns number
Inherited from Region.useTexture
- Defined in region/region.ts:62