@latticexyz/phaserx / MultiHueTintPipeline
#
Class: MultiHueTintPipeline
#
Hierarchy
MultiPipeline↳
MultiHueTintPipeline
#
Table of contents
#
Constructors
constructor
#
Properties
active activeBuffer activeTextures batch bytes calcMatrix config currentBatch currentRenderTarget currentShader currentTexture currentUnit forceZero game gl glReset hasBooted height isPostFX isSpriteFX manager name projectionHeight projectionMatrix projectionWidth renderTargets renderer shaders topology vertexBuffer vertexCapacity vertexCount vertexData vertexViewF32 vertexViewU32 view width KEY
#
Methods
addListener addTextureToBatch batchFillPath batchFillRect batchFillTriangle batchLine batchQuad batchSprite batchStrokePath batchStrokeTriangle batchTexture batchTextureFrame batchTri batchVert bind bindRenderTarget bindTexture boot createBatch destroy drawFillRect emit eventNames flipProjectionMatrix flush getShaderByName listenerCount listeners off on onActive onAfterFlush onBatch onBeforeFlush onBind onBoot onDraw onPostBatch onPostRender onPreBatch onPreRender onRebind onRender onResize once postBatch preBatch pushBatch rebind removeAllListeners removeListener resize set1f set1fv set1i set1iv set2f set2fv set2i set2iv set3f set3fv set3i set3iv set4f set4fv set4i set4iv setBoolean setGameObject setMatrix2fv setMatrix3fv setMatrix4fv setProjectionMatrix setShader setShadersFromConfig setTexture2D setTime setVertexBuffer shouldFlush shutdown unbind updateProjectionMatrix
#
Constructors
#
constructor
• new MultiHueTintPipeline(game)
#
Parameters
#
Overrides
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.constructor
#
Defined in
packages/phaserx/src/pipelines/MultiHueTintPipeline.ts:3
#
Properties
#
active
• active: boolean
Indicates if the current pipeline is active, or not.
Toggle this property to enable or disable a pipeline from rendering anything.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.active
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86724
#
activeBuffer
• activeBuffer: WebGLBuffer
The currently active WebGLBuffer.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.activeBuffer
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86695
#
activeTextures
• activeTextures: WebGLTexture[]
The currently active WebGLTextures, used as part of the batch process.
Reset to empty as part of the bind method.
Treat this array as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.activeTextures
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86855
#
batch
• batch: WebGLPipelineBatchEntry[]
The temporary Pipeline batch. This array contains the batch entries for the current frame, which is a package of textures and vertex offsets used for drawing. This package is built dynamically as the frame is built and cleared during the flush method.
Treat this array and all of its contents as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86821
#
bytes
• bytes: Uint8Array
Uint8 view to the vertexData ArrayBuffer. Used for uploading vertex buffer resources to the GPU.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.bytes
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86707
#
calcMatrix
• calcMatrix: TransformMatrix
A temporary Transform Matrix, re-used internally during batching by the Shape Game Objects.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.calcMatrix
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85292
#
config
• config: WebGLPipelineConfig
The configuration object that was used to create this pipeline.
Treat this object as 'read only', because changing it post-creation will not impact this pipeline in any way. However, it is used internally for cloning and post-boot set-up.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.config
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86802
#
currentBatch
• currentBatch: null | WebGLPipelineBatchEntry
The most recently created Pipeline batch entry.
Reset to null as part of the flush method.
Treat this value as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.currentBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86830
#
currentRenderTarget
• currentRenderTarget: RenderTarget
A reference to the currently bound Render Target instance from the WebGLPipeline.renderTargets array.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.currentRenderTarget
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86759
#
currentShader
• currentShader: WebGLShader
A reference to the currently bound WebGLShader instance from the WebGLPipeline.shaders array.
For lots of pipelines, this is the only shader, so it is a quick way to reference it without an array look-up.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.currentShader
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86778
#
currentTexture
• currentTexture: null | WebGLTexture
The most recently bound WebGLTexture, used as part of the batch process.
Reset to null as part of the flush method.
Treat this value as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.currentTexture
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86839
#
currentUnit
• currentUnit: number
Holds the most recently assigned texture unit.
Treat this value as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.currentUnit
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86846
#
forceZero
• forceZero: boolean
Some pipelines require the forced use of texture zero (like the light pipeline).
This property should be set when that is the case.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.forceZero
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86731
#
game
• game: Game
The Phaser Game instance to which this pipeline is bound.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.game
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86629
#
gl
• gl: WebGLRenderingContext
The WebGL context this WebGL Pipeline uses.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.gl
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86647
#
glReset
• glReset: boolean
Has the GL Context been reset to the Phaser defaults since the last time this pipeline was bound? This is set automatically when the Pipeline Manager resets itself, usually after handing off to a 3rd party renderer like Spine.
You should treat this property as read-only.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.glReset
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86811
#
hasBooted
• Readonly hasBooted: boolean
Indicates if this pipeline has booted or not.
A pipeline boots only when the Game instance itself, and all associated systems, is fully ready.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.hasBooted
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86739
#
height
• height: number
Height of the current viewport.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.height
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86662
#
isPostFX
• Readonly isPostFX: boolean
Indicates if this is a Post FX Pipeline, or not.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.isPostFX
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86744
#
isSpriteFX
• Readonly isSpriteFX: boolean
Indicates if this is a Sprite FX Pipeline, or not.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.isSpriteFX
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86749
#
manager
• manager: null | PipelineManager
A reference to the WebGL Pipeline Manager.
This is initially undefined and only set when this pipeline is added to the manager.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.manager
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86642
#
name
• name: string
Name of the pipeline. Used for identification and setting from Game Objects.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.name
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86624
#
projectionHeight
• projectionHeight: number
The cached height of the Projection matrix.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.projectionHeight
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86793
#
projectionMatrix
• projectionMatrix: Matrix4
The Projection matrix, used by shaders as 'uProjectionMatrix' uniform.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.projectionMatrix
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86783
#
projectionWidth
• projectionWidth: number
The cached width of the Projection matrix.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.projectionWidth
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86788
#
renderTargets
• renderTargets: RenderTarget[]
An array of RenderTarget instances that belong to this pipeline.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.renderTargets
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86754
#
renderer
• renderer: WebGLRenderer
The WebGL Renderer instance to which this pipeline is bound.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.renderer
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86634
#
shaders
• shaders: WebGLShader[]
An array of all the WebGLShader instances that belong to this pipeline.
Shaders manage their own attributes and uniforms, but share the same vertex data buffer, which belongs to this pipeline.
Shaders are set in a call to the setShadersFromConfig method, which happens automatically,
but can also be called at any point in your game. See the method documentation for details.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.shaders
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86770
#
topology
• topology: number
The primitive topology which the pipeline will use to submit draw calls.
Defaults to GL_TRIANGLES if not otherwise set in the config.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.topology
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86702
#
vertexBuffer
• Readonly vertexBuffer: WebGLBuffer
The WebGLBuffer that holds the vertex data.
Created from the vertexData ArrayBuffer. If vertices are set in the config, a STATIC_DRAW buffer
is created. If not, a DYNAMIC_DRAW buffer is created.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexBuffer
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86690
#
vertexCapacity
• vertexCapacity: number
The total number of vertices that this pipeline batch can hold before it will flush.
This defaults to renderer batchSize * 6, where batchSize is defined in the Renderer Game Config.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexCapacity
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86674
#
vertexCount
• vertexCount: number
The current number of vertices that have been added to the pipeline batch.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexCount
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86667
#
vertexData
• Readonly vertexData: ArrayBuffer
Raw byte buffer of vertices.
Either set via the config object vertices property, or generates a new Array Buffer of
size vertexCapacity * vertexSize.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexData
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86682
#
vertexViewF32
• vertexViewF32: Float32Array
Float32 view of the array buffer containing the pipeline's vertices.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexViewF32
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86712
#
vertexViewU32
• vertexViewU32: Uint32Array
Uint32 view of the array buffer containing the pipeline's vertices.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.vertexViewU32
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86717
#
view
• view: HTMLCanvasElement
The canvas which this WebGL Pipeline renders to.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.view
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86652
#
width
• width: number
Width of the current viewport.
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.width
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86657
#
KEY
▪ Static Readonly KEY: "MultiHueTintPipeline"
#
Defined in
packages/phaserx/src/pipelines/MultiHueTintPipeline.ts:2
#
Methods
#
addListener
▸ addListener(event, fn, context?): MultiHueTintPipeline
Add a listener for a given event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.addListener
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9655
#
addTextureToBatch
▸ addTextureToBatch(texture): void
Adds the given texture to the current WebGL Pipeline Batch Entry and increases the batch entry unit and maxUnit values by 1.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.addTextureToBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86918
#
batchFillPath
▸ batchFillPath(path, currentMatrix, parentMatrix): void
Adds the given path to the vertex batch for rendering.
It works by taking the array of path data and then passing it through Earcut, which creates a list of polygons. Each polygon is then added to the batch.
The path is always automatically closed because it's filled.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchFillPath
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85415
#
batchFillRect
▸ batchFillRect(x, y, width, height, currentMatrix, parentMatrix): void
Pushes a filled rectangle into the vertex batch.
Rectangle factors in the given transform matrices before adding to the batch.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchFillRect
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85369
#
batchFillTriangle
▸ batchFillTriangle(x0, y0, x1, y1, x2, y2, currentMatrix, parentMatrix): void
Pushes a filled triangle into the vertex batch.
Triangle factors in the given transform matrices before adding to the batch.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchFillTriangle
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85384
#
batchLine
▸ batchLine(ax, ay, bx, by, aLineWidth, bLineWidth, index, closePath, currentMatrix, parentMatrix): void
Creates a line out of 4 quads and adds it to the vertex batch based on the given line values.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchLine
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85445
#
batchQuad
▸ batchQuad(gameObject, x0, y0, x1, y1, x2, y2, x3, y3, u0, v0, u1, v1, tintTL, tintTR, tintBL, tintBR, tintEffect, texture?, unit?): boolean
Adds the vertices data into the batch and flushes if full.
Assumes 6 vertices in the following arrangement:
0----3
|\ B|
| \ |
| \ |
| A \|
| \
1----2Where tx0/ty0 = 0, tx1/ty1 = 1, tx2/ty2 = 2 and tx3/ty3 = 3
#
Parameters
#
Returns
boolean
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchQuad
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87242
#
batchSprite
▸ batchSprite(gameObject, camera, parentTransformMatrix?): void
Takes a Sprite Game Object, or any object that extends it, and adds it to the batch.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchSprite
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85307
#
batchStrokePath
▸ batchStrokePath(path, lineWidth, pathOpen, currentMatrix, parentMatrix): void
Adds the given path to the vertex batch for rendering.
It works by taking the array of path data and calling batchLine for each section
of the path.
The path is optionally closed at the end.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchStrokePath
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85430
#
batchStrokeTriangle
▸ batchStrokeTriangle(x0, y0, x1, y1, x2, y2, lineWidth, currentMatrix, parentMatrix): void
Pushes a stroked triangle into the vertex batch.
Triangle factors in the given transform matrices before adding to the batch.
The triangle is created from 3 lines and drawn using the batchStrokePath method.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchStrokeTriangle
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85402
#
batchTexture
▸ batchTexture(gameObject, texture, textureWidth, textureHeight, srcX, srcY, srcWidth, srcHeight, scaleX, scaleY, rotation, flipX, flipY, scrollFactorX, scrollFactorY, displayOriginX, displayOriginY, frameX, frameY, frameWidth, frameHeight, tintTL, tintTR, tintBL, tintBR, tintEffect, uOffset, vOffset, camera, parentTransformMatrix, skipFlip?, textureUnit?): void
Generic function for batching a textured quad using argument values instead of a Game Object.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchTexture
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85344
#
batchTextureFrame
▸ batchTextureFrame(frame, x, y, tint, alpha, transformMatrix, parentTransformMatrix?): void
Adds a Texture Frame into the batch for rendering.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchTextureFrame
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85356
#
batchTri
▸ batchTri(gameObject, x1, y1, x2, y2, x3, y3, u0, v0, u1, v1, tintTL, tintTR, tintBL, tintEffect, texture?, unit?): boolean
Adds the vertices data into the batch and flushes if full.
Assumes 3 vertices in the following arrangement:
0
|\
| \
| \
| \
| \
1-----2
#
Parameters
#
Returns
boolean
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchTri
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87276
#
batchVert
▸ batchVert(x, y, u, v, unit, tintEffect, tint): void
Adds a single vertex to the current vertex buffer and increments the
vertexCount property by 1.
This method is called directly by batchTri and batchQuad.
It does not perform any batch limit checking itself, so if you need to call
this method directly, do so in the same way that batchQuad does, for example.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.batchVert
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87203
#
bind
▸ bind(currentShader?): MultiHueTintPipeline
This method is called every time the Pipeline Manager makes this pipeline the currently active one.
It binds the resources and shader needed for this pipeline, including setting the vertex buffer and attribute pointers.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.bind
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86999
#
bindRenderTarget
▸ bindRenderTarget(target?, unit?): MultiHueTintPipeline
Activates the given Render Target texture and binds it to the requested WebGL texture slot.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.bindRenderTarget
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87317
#
bindTexture
▸ bindTexture(target?, unit?): MultiHueTintPipeline
Activates the given WebGL Texture and binds it to the requested texture slot.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.bindTexture
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87309
#
boot
▸ boot(): void
Called every time the pipeline is bound by the renderer. Sets the shader program, vertex buffer and other resources. Should only be called when changing pipeline.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.boot
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85299
#
createBatch
▸ createBatch(texture): number
Creates a new WebGL Pipeline Batch Entry, sets the texture unit as zero and pushes the entry into the batch.
#
Parameters
#
Returns
number
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.createBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86911
#
destroy
▸ destroy(): MultiHueTintPipeline
Destroys all shader instances, removes all object references and nulls all external references.
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.destroy
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:85450
#
drawFillRect
▸ drawFillRect(x, y, width, height, color, alpha, texture?, flipUV?): void
Pushes a filled rectangle into the vertex batch.
The dimensions are run through Math.floor before the quad is generated.
Rectangle has no transform values and isn't transformed into the local space.
Used for directly batching untransformed rectangles, such as Camera background colors.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.drawFillRect
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87295
#
emit
▸ emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
#
Parameters
#
Returns
boolean
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.emit
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9639
#
eventNames
▸ eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.
#
Returns
(string | symbol)[]
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.eventNames
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9620
#
flipProjectionMatrix
▸ flipProjectionMatrix(flipY?): void
Adjusts this pipelines ortho Projection Matrix to flip the y and bottom values. Call with 'false' as the parameter to flip them back again.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.flipProjectionMatrix
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86981
#
flush
▸ flush(isPostFlush?): MultiHueTintPipeline
Uploads the vertex data and emits a draw call for the current batch of vertices.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.flush
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87062
#
getShaderByName
▸ getShaderByName(name): WebGLShader
Searches all shaders in this pipeline for one matching the given name, then returns it.
#
Parameters
#
Returns
WebGLShader
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.getShaderByName
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86894
#
listenerCount
▸ listenerCount(event): number
Return the number of listeners listening to a given event.
#
Parameters
#
Returns
number
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.listenerCount
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9632
#
listeners
▸ listeners(event): Function[]
Return the listeners registered for a given event.
#
Parameters
#
Returns
Function[]
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.listeners
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9626
#
off
▸ off(event, fn?, context?, once?): MultiHueTintPipeline
Remove the listeners of a given event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.off
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9681
#
on
▸ on(event, fn, context?): MultiHueTintPipeline
Add a listener for a given event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.on
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9647
#
onActive
▸ onActive(currentShader): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called every time the Pipeline Manager makes this the active pipeline. It is called
at the end of the WebGLPipeline.bind method, after the current shader has been set. The current
shader is passed to this hook.
For example, if a display list has 3 Sprites in it that all use the same pipeline, this hook will only be called for the first one, as the 2nd and 3rd Sprites do not cause the pipeline to be changed.
If you need to listen for that event instead, use the onBind hook.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onActive
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87077
#
onAfterFlush
▸ onAfterFlush(isPostFlush?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called immediately after this pipeline has finished flushing its batch.
It is called after the gl.drawArrays call.
You can perform additional post-render effects, but be careful not to call flush
on this pipeline from within this method, or you'll cause an infinite loop.
To apply changes pre-render, see onBeforeFlush.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onAfterFlush
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87185
#
onBatch
▸ onBatch(gameObject?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called every time the batchQuad or batchTri methods are called. If this was
as a result of a Game Object, then the Game Object reference is passed to this hook too.
This hook is called after the quad (or tri) has been added to the batch, so you can safely call 'flush' from within this.
Note that Game Objects may call batchQuad or batchTri multiple times for a single draw,
for example the Graphics Game Object.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87114
#
onBeforeFlush
▸ onBeforeFlush(isPostFlush?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called every time this pipeline is asked to flush its batch.
It is called immediately before the gl.bufferData and gl.drawArrays calls are made, so you can
perform any final pre-render modifications. To apply changes post-render, see onAfterFlush.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onBeforeFlush
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87170
#
onBind
▸ onBind(gameObject?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called every time a Game Object asks the Pipeline Manager to use this pipeline, even if the pipeline is already active.
Unlike the onActive method, which is only called when the Pipeline Manager makes this pipeline
active, this hook is called for every Game Object that requests use of this pipeline, allowing you to
perform per-object set-up, such as loading shader uniform data.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onBind
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87090
#
onBoot
▸ onBoot(): void
This method is called once when this pipeline has finished being set-up at the end of the boot process. By the time this method is called, all of the shaders are ready and configured.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onBoot
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86870
#
onDraw
▸ onDraw(renderTarget, swapTarget?): void
This method is only used by Sprite FX and Post FX Pipelines and those that extend from them.
This method is called every time the postBatch method is called and is passed a
reference to the current render target.
At the very least a Post FX Pipeline should call this.bindAndDraw(renderTarget),
however, you can do as much additional processing as you like in this method if
you override it from within your own pipelines.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onDraw
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87050
#
onPostBatch
▸ onPostBatch(gameObject?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called immediately after a Game Object has been added to the batch.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onPostBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87130
#
onPostRender
▸ onPostRender(): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called once per frame, after all rendering has happened and snapshots have been taken.
It is called at the very end of the rendering process, once all Cameras, for all Scenes, have been rendered.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onPostRender
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87159
#
onPreBatch
▸ onPreBatch(gameObject?): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called immediately before a Game Object is about to add itself to the batch.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onPreBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87122
#
onPreRender
▸ onPreRender(): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called once per frame, right before anything has been rendered, but after the canvas has been cleared. If this pipeline has a render target, it will also have been cleared by this point.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onPreRender
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87138
#
onRebind
▸ onRebind(): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called when the Pipeline Manager needs to rebind this pipeline. This happens after a pipeline has been cleared, usually when passing control over to a 3rd party WebGL library, like Spine, and then returing to Phaser again.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onRebind
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87099
#
onRender
▸ onRender(scene, camera): void
By default this is an empty method hook that you can override and use in your own custom pipelines.
This method is called once per frame, by every Camera in a Scene that wants to render.
It is called at the start of the rendering process, before anything has been drawn to the Camera.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onRender
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87149
#
onResize
▸ onResize(width, height): void
This method is called once when this pipeline has finished being set-up at the end of the boot process. By the time this method is called, all of the shaders are ready and configured. It's also called if the renderer changes size.
#
Parameters
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.onResize
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86880
#
once
▸ once(event, fn, context?): MultiHueTintPipeline
Add a one-time listener for a given event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.once
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9663
#
postBatch
▸ postBatch(gameObject?): MultiHueTintPipeline
This method is called as a result of the WebGLPipeline.batchQuad method, right after a quad
belonging to a Game Object has been added to the batch. When this is called, the
renderer has just performed a flush.
It calls the onDraw hook followed by the onPostBatch hook, which can be used to perform
additional Post FX Pipeline processing.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.postBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87036
#
preBatch
▸ preBatch(gameObject?): MultiHueTintPipeline
This method is called as a result of the WebGLPipeline.batchQuad method, right before a quad
belonging to a Game Object is about to be added to the batch. When this is called, the
renderer has just performed a flush. It will bind the current render target, if any are set
and finally call the onPreBatch hook.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.preBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87025
#
pushBatch
▸ pushBatch(texture): number
Takes the given WebGLTexture and determines what to do with it.
If there is no current batch (i.e. after a flush) it will create a new batch from it.
If the texture is already bound, it will return the current texture unit.
If the texture already exists in the current batch, the unit gets reset to match it.
If the texture cannot be found in the current batch, and it supports multiple textures, it's added into the batch and the unit indexes are advanced.
#
Parameters
#
Returns
number
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.pushBatch
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86936
#
rebind
▸ rebind(currentShader?): MultiHueTintPipeline
This method is called every time the Pipeline Manager rebinds this pipeline.
It resets all shaders this pipeline uses, setting their attributes again.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.rebind
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87007
#
removeAllListeners
▸ removeAllListeners(event?): MultiHueTintPipeline
Remove all listeners, or those of the specified event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.removeAllListeners
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9687
#
removeListener
▸ removeListener(event, fn?, context?, once?): MultiHueTintPipeline
Remove the listeners of a given event.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.removeListener
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9672
#
resize
▸ resize(width, height): MultiHueTintPipeline
Resizes the properties used to describe the viewport.
This method is called automatically by the renderer during its resize handler.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.resize
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86963
#
set1f
▸ set1f(name, x, shader?): MultiHueTintPipeline
Sets a 1f uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set1f
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87353
#
set1fv
▸ set1fv(name, arr, shader?): MultiHueTintPipeline
Sets a 1fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set1fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87415
#
set1i
▸ set1i(name, x, shader?): MultiHueTintPipeline
Sets a 1i uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set1i
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87527
#
set1iv
▸ set1iv(name, arr, shader?): MultiHueTintPipeline
Sets a 1iv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set1iv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87471
#
set2f
▸ set2f(name, x, y, shader?): MultiHueTintPipeline
Sets a 2f uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set2f
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87368
#
set2fv
▸ set2fv(name, arr, shader?): MultiHueTintPipeline
Sets a 2fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set2fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87429
#
set2i
▸ set2i(name, x, y, shader?): MultiHueTintPipeline
Sets a 2i uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set2i
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87542
#
set2iv
▸ set2iv(name, arr, shader?): MultiHueTintPipeline
Sets a 2iv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set2iv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87485
#
set3f
▸ set3f(name, x, y, z, shader?): MultiHueTintPipeline
Sets a 3f uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set3f
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87384
#
set3fv
▸ set3fv(name, arr, shader?): MultiHueTintPipeline
Sets a 3fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set3fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87443
#
set3i
▸ set3i(name, x, y, z, shader?): MultiHueTintPipeline
Sets a 3i uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set3i
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87558
#
set3iv
▸ set3iv(name, arr, shader?): MultiHueTintPipeline
Sets a 3iv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set3iv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87499
#
set4f
▸ set4f(name, x, y, z, w, shader?): MultiHueTintPipeline
Sets a 4f uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set4f
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87401
#
set4fv
▸ set4fv(name, arr, shader?): MultiHueTintPipeline
Sets a 4fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set4fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87457
#
set4i
▸ set4i(name, x, y, z, w, shader?): MultiHueTintPipeline
Sets a 4i uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set4i
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87575
#
set4iv
▸ set4iv(name, arr, shader?): MultiHueTintPipeline
Sets a 4iv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.set4iv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87513
#
setBoolean
▸ setBoolean(name, value, shader?): MultiHueTintPipeline
Sets a boolean uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setBoolean
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87339
#
setGameObject
▸ setGameObject(gameObject, frame?): number
Custom pipelines can use this method in order to perform any required pre-batch tasks for the given Game Object. It must return the texture unit the Game Object was assigned.
#
Parameters
#
Returns
number
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setGameObject
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86944
#
setMatrix2fv
▸ setMatrix2fv(name, transpose, matrix, shader?): MultiHueTintPipeline
Sets a matrix 2fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setMatrix2fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87590
#
setMatrix3fv
▸ setMatrix3fv(name, transpose, matrix, shader?): MultiHueTintPipeline
Sets a matrix 3fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setMatrix3fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87605
#
setMatrix4fv
▸ setMatrix4fv(name, transpose, matrix, shader?): MultiHueTintPipeline
Sets a matrix 4fv uniform value based on the given name on the currently set shader.
The current shader is bound, before the uniform is set, making it active within the
WebGLRenderer. This means you can safely call this method from a location such as
a Scene create or update method. However, when working within a Shader file
directly, use the WebGLShader method equivalent instead, to avoid the program
being set.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setMatrix4fv
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87620
#
setProjectionMatrix
▸ setProjectionMatrix(width, height): MultiHueTintPipeline
Adjusts this pipelines ortho Projection Matrix to use the given dimensions
and resets the uProjectionMatrix uniform on all bound shaders.
This method is called automatically by the renderer during its resize handler.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setProjectionMatrix
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86973
#
setShader
▸ setShader(shader, setAttributes?, vertexBuffer?): MultiHueTintPipeline
Sets the currently active shader within this pipeline.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setShader
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86888
#
setShadersFromConfig
▸ setShadersFromConfig(config): MultiHueTintPipeline
Destroys all shaders currently set in the WebGLPipeline.shaders array and then parses the given
config object, extracting the shaders from it, creating WebGLShader instances and finally
setting them into the shaders array of this pipeline.
This is a destructive process. Be very careful when you call it, should you need to.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setShadersFromConfig
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86904
#
setTexture2D
▸ setTexture2D(texture?): number
Sets the texture to be bound to the next available texture unit and returns the unit id.
#
Parameters
#
Returns
number
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setTexture2D
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87302
#
setTime
▸ setTime(name): MultiHueTintPipeline
Sets the current duration into a 1f uniform value based on the given name.
This can be used for mapping time uniform values, such as iTime.
#
Parameters
#
Returns
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setTime
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87325
#
setVertexBuffer
▸ setVertexBuffer(buffer?): boolean
Binds the vertex buffer to be the active ARRAY_BUFFER on the WebGL context.
It first checks to see if it's already set as the active buffer and only binds itself if not.
#
Parameters
#
Returns
boolean
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.setVertexBuffer
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87016
#
shouldFlush
▸ shouldFlush(amount?): boolean
Check if the current batch of vertices is full.
You can optionally provide an amount parameter. If given, it will check if the batch
needs to flush if the amount is added to it. This allows you to test if you should
flush before populating the batch.
#
Parameters
#
Returns
boolean
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.shouldFlush
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86954
#
shutdown
▸ shutdown(): void
Removes all listeners.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.shutdown
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:9610
#
unbind
▸ unbind(): void
This method is called every time the Pipeline Manager deactivates this pipeline, swapping from
it to another one. This happens after a call to flush and before the new pipeline is bound.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.unbind
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:87056
#
updateProjectionMatrix
▸ updateProjectionMatrix(): void
Adjusts this pipelines ortho Projection Matrix to match that of the global WebGL Renderer Projection Matrix.
This method is called automatically by the Pipeline Manager when this pipeline is set.
#
Returns
void
#
Inherited from
Phaser.Renderer.WebGL.Pipelines.MultiPipeline.updateProjectionMatrix
#
Defined in
node_modules/.pnpm/phaser@3.60.0-beta.14/node_modules/phaser/types/phaser.d.ts:86990