Class GeometrySystem

System plugin to the renderer to manage geometry.

Memberof

PIXI

Implements

ISystem

Constructors

constructor

new GeometrySystem(renderer: Renderer): GeometrySystem
Parameters
- renderer: Renderer
  The renderer this System works for.
Returns GeometrySystem
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:44

Properties

`Protected`_activeGeometry

_activeGeometry: Geometry

`Protected`_activeVao

_activeVao: WebGLVertexArrayObject

`Protected`_boundBuffer

_boundBuffer: GLBuffer

`Readonly`canUseUInt32ElementIndex

canUseUInt32ElementIndex: boolean

true if support gl.UNSIGNED_INT in gl.drawElements or gl.drawElementsInstanced.

`Protected`CONTEXT_UID

CONTEXT_UID: number

`Protected`gl

gl: IRenderingContext

`Readonly`hasInstance

hasInstance: boolean

true if has ANGLE_instanced_arrays extension.

`Readonly`hasVao

hasVao: boolean

true if we has *_vertex_array_object extension.

`Readonly`managedGeometries

managedGeometries: { [key: number]: Geometry }

Cache for all geometries by id, used in case renderer gets destroyed or for profiling.

Methods

`Protected`activateVao

activateVao(geometry: Geometry, program: Program): void
Activate vertex array object.
Parameters
- geometry: Geometry
  Geometry instance.
- program: Program
  Shader program instance.
Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:95

bind

bind(geometry?: Geometry, shader?: Shader): void
Binds geometry so that is can be drawn. Creating a Vao if required
Parameters
- Optionalgeometry: Geometry
  Instance of geometry to bind.
- Optionalshader: Shader
  Instance of shader to use vao for.
Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:52

`Protected`checkCompatibility

checkCompatibility(geometry: Geometry, program: Program): void
Check compatibility between a geometry and a program
Parameters
- geometry: Geometry
  Geometry instance.
- program: Program
  Program instance.
Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:62

`Protected`contextChange

contextChange(): void
Sets up the renderer context and necessary buffers.

Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:46

destroy

destroy(): void
Generic destroy methods to be overridden by the subclass

Returns void
Implementation of ISystem.destroy
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:109

disposeAll

disposeAll(contextLost?: boolean): void
Dispose all WebGL resources of all managed geometries.
Parameters
- OptionalcontextLost: boolean
  If context was lost, we suppress gl.delete calls
Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:89

disposeGeometry

disposeGeometry(geometry: Geometry, contextLost?: boolean): void
Disposes geometry.
Parameters
- geometry: Geometry
  Geometry with buffers. Only VAO will be disposed
- OptionalcontextLost: boolean
  If context was lost, we suppress deleteVertexArray
Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:84

draw

draw(
    type: DRAW_MODES,
    size?: number,
    start?: number,
    instanceCount?: number,
): this
Draws the currently bound geometry.
Parameters
- type: DRAW_MODES
  The type primitive to render.
- Optionalsize: number
  The number of elements to be rendered. If not specified, all vertices after the starting vertex will be drawn.
- Optionalstart: number
  The starting vertex in the geometry to start drawing from. If not specified, drawing will start from the first vertex.
- OptionalinstanceCount: number
  The number of instances of the set of elements to execute. If not specified, all instances will be drawn.
Returns this
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:106

`Protected`getSignature

getSignature(geometry: Geometry, program: Program): string
Takes a geometry and program and generates a unique signature for them.
Parameters
- geometry: Geometry
  To get signature from.
- program: Program
  To test geometry against.
Returns string
- Unique signature of the geometry and program
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:69

`Protected`initGeometryVao

initGeometryVao(
    geometry: Geometry,
    shader: Shader,
    incRefCount?: boolean,
): WebGLVertexArrayObject
Creates or gets Vao with the same structure as the geometry and stores it on the geometry. If vao is created, it is bound automatically. We use a shader to infer what and how to set up the attribute locations.
Parameters
- geometry: Geometry
  Instance of geometry to to generate Vao for.
- shader: Shader
  Instance of the shader.
- OptionalincRefCount: boolean
  Increment refCount of all geometry buffers.
Returns WebGLVertexArrayObject
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:78

reset

reset(): void
Reset and unbind any active VAO and geometry.

Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:54

`Protected`unbind

unbind(): void
Unbind/reset everything.

Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:108

updateBuffers

updateBuffers(): void
Update buffers of the currently bound geometry.

Returns void
- Defined in node_modules/@pixi/core/lib/geometry/GeometrySystem.d.ts:56

Class GeometrySystem

Memberof

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GeometrySystem

Properties

Protected_activeGeometry

Protected_activeVao

Protected_boundBuffer

ReadonlycanUseUInt32ElementIndex

ProtectedCONTEXT_UID

Protectedgl

ReadonlyhasInstance

ReadonlyhasVao

ReadonlymanagedGeometries

Methods

ProtectedactivateVao

Parameters

Returns void

bind

Parameters

Returns void

ProtectedcheckCompatibility

Parameters

Returns void

ProtectedcontextChange

Returns void

destroy

Returns void

disposeAll

Parameters

Returns void

disposeGeometry

Parameters

Returns void

draw

Parameters

Returns this

ProtectedgetSignature

Parameters

Returns string

ProtectedinitGeometryVao

Parameters

Returns WebGLVertexArrayObject

reset

Returns void

Protectedunbind

Returns void

updateBuffers

Returns void

Settings

On This Page

`Protected`_activeGeometry

`Protected`_activeVao

`Protected`_boundBuffer

`Readonly`canUseUInt32ElementIndex

`Protected`CONTEXT_UID

`Protected`gl

`Readonly`hasInstance

`Readonly`hasVao

`Readonly`managedGeometries

`Protected`activateVao

`Protected`checkCompatibility

`Protected`contextChange

`Protected`getSignature

`Protected`initGeometryVao

`Protected`unbind