pixi.js
    Preparing search index...

    Class BatchGeometryAdvanced

    This class represents a geometry used for batching in the rendering system. It defines the structure of vertex attributes and index buffers for batched rendering.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    attributes: Record<string, Attribute>

    A record of the attributes of the geometry.

    buffers: Buffer[]

    The buffers that the attributes use

    indexBuffer: Buffer

    The index buffer of the geometry

    instanceCount: number = 1

    the instance count of the geometry to draw

    topology: Topology

    The topology of the geometry.

    uid: number = ...

    The unique id of the geometry.

    Accessors

    • get bounds(): Bounds

      Returns the bounds of the geometry.

      Returns Bounds

    Methods

    • Adds an attribute to the geometry.

      Parameters

      • name: string

        The name of the attribute to add.

      • attributeOption: AttributeOption

        The attribute option to add.

      Returns void

    • Adds an index buffer to the geometry.

      Parameters

      • indexBuffer: number[] | TypedArray | Buffer

        The index buffer to add. Can be a Buffer, TypedArray, or an array of numbers.

      Returns void

    • destroys the geometry.

      Parameters

      • destroyBuffers: boolean = false

        destroy the buffers associated with this geometry

      Returns void

    • Returns the requested attribute.

      Parameters

      • id: string

        The name of the attribute required

      Returns Attribute

      • The attribute requested.
    • Returns the requested buffer.

      Parameters

      • id: string

        The name of the buffer required.

      Returns Buffer

      • The buffer requested.
    • Used to figure out how many vertices there are in this geometry

      Returns number

      the number of vertices in the geometry