Class Quad

attributes

buffers

disposeRunner

glVertexArrayObjects

id

indexBuffer

instanceCount

1
Copy

instanced

refCount

addAttribute

• addAttribute(
      id: string,
      buffer:
          | number[]
          | Float32Array<ArrayBufferLike>
          | Buffer
          | Uint32Array<ArrayBufferLike>,
      size?: number,
      normalized?: boolean,
      type?: TYPES,
      stride?: number,
      start?: number,
      instance?: boolean,
  ): this

  Adds an attribute to the geometry Note: stride and start should be undefined if you dont know them, not 0!

  Parameters

  • id: string

    the name of the attribute (matching up to a shader)

  • buffer: number[] | Float32Array<ArrayBufferLike> | Buffer | Uint32Array<ArrayBufferLike>

    the buffer that holds the data of the attribute . You can also provide an Array and a buffer will be created from it.

  • Optionalsize: number

    the size of the attribute. If you have 2 floats per vertex (eg position x and y) this would be 2

  • Optionalnormalized: boolean

    should the data be normalized.

  • Optionaltype: TYPES

    what type of number is the attribute. Check PIXI.TYPES to see the ones available

  • Optionalstride: number

    How far apart, in bytes, the start of each value is. (used for interleaving data)

  • Optionalstart: number

    How far into the array to start reading values (used for interleaving data)

  • Optionalinstance: boolean

    Instancing flag

  Returns this

  • Returns self, useful for chaining.

addIndex

• addIndex(buffer?: number[] | Buffer | IArrayBuffer): Geometry

  Adds an index buffer to the geometry The index buffer contains integers, three for each triangle in the geometry, which reference the various attribute buffers (position, colour, UV coordinates, other UV coordinates, normal, …). There is only ONE index buffer.

  Parameters

  • Optionalbuffer: number[] | Buffer | IArrayBuffer

    The buffer that holds the data of the index buffer. You can also provide an Array and a buffer will be created from it.

  Returns Geometry

  • Returns self, useful for chaining.

clone

• clone(): Geometry

  Returns a clone of the geometry.

  Returns Geometry

  • A new clone of this geometry.

destroy

• destroy(): void

  Destroys the geometry.

  Returns void

dispose

• dispose(): void

  Disposes WebGL resources that are connected to this geometry.

  Returns void

getAttribute

• getAttribute(id: string): Attribute

  Returns the requested attribute.

  Parameters

  • id: string

    The name of the attribute required

  Returns Attribute

  • The attribute requested.

getBuffer

• getBuffer(id: string): Buffer

  Returns the requested buffer.

  Parameters

  • id: string

    The name of the buffer required.

  Returns Buffer

  • The buffer requested.

getIndex

• getIndex(): Buffer

  Returns the index buffer

  Returns Buffer

  • The index buffer.

getSize

• getSize(): number

  Get the size of the geometries, in vertices.

  Returns number

interleave

• interleave(): Geometry

  This function modifies the structure so that all current attributes become interleaved into a single buffer This can be useful if your model remains static as it offers a little performance boost

  Returns Geometry

  • Returns self, useful for chaining.

Staticmerge

• merge(geometries: Geometry[]): Geometry

  Merges an array of geometries into a new single one.

  Geometry attribute styles must match for this operation to work.

  Parameters

  • geometries: Geometry[]

    array of geometries to merge

  Returns Geometry

  • Shiny new geometry!