Class: GraphicsGeometry

PIXI.GraphicsGeometry

The Graphics class contains methods used to draw primitive shapes such as lines, circles and rectangles to the display, and to color and fill them.

GraphicsGeometry is designed to not be continually updating the geometry since it's expensive to re-tesselate using earcut. Consider using PIXI.Mesh for this use-case, it's much faster.

new PIXI.GraphicsGeometry ()

Extends

Members

PIXI.GraphicsGeometry.BATCHABLE_SIZE number static

The maximum number of points to consider an object "batchable", able to be batched by the renderer's batch system.

Default Value:
  • 100

_bounds PIXI.Bounds protected

Cached bounds.

_buffer PIXI.Buffer protected inherited

Buffer used for position, color, texture IDs

_indexBuffer PIXI.Buffer protected inherited

Index buffer data

batchDirty number protected

Batches need to regenerated if the geometry is updated.

batches Array.<object> protected

Intermediate abstract format sent to batch system. Can be converted to drawCalls or to batchable objects.

bounds PIXI.Bounds readonly

Get the current bounds of the graphic geometry.

boundsDirty number protected

The bounds dirty flag.

boundsPadding number

Padding to add to the bounds.

Default Value:
  • 0

cacheDirty number protected

Used to check if the cache is dirty.

clearDirty number protected

Used to detect if we clear the graphics WebGL data.

Default Value:
  • 0

colors Array.<number> protected

The collection of colors

dirty number protected

Used to detect if the graphics object has changed. If this is set to true then the graphics object will be recalculated.

drawCalls Array.<object> protected

List of current draw calls drived from the batches.

graphicsData Array.<PIXI.GraphicsData> protected

The collection of drawn shapes.

indices Array.<number> protected

The indices of the vertices

points Array.<PIXI.Point> protected

An array of points to draw

shapeIndex number protected

Index of the current last shape in the stack of calls.

textureIds Array.<number> protected

Reference to the texture IDs.

uvs Array.<number> protected

The UVs collection

Methods

addColors (colors, color, alpha, size) protected

Add colors.

Name Type Description
colors Array.<number>

List of colors to add to

color number

Color to add

alpha number

Alpha to use

size number

Number of colors to add

addTextureIds (textureIds, id, size) protected

Add texture id that the shader/fragment wants to use.

Name Type Description
textureIds Array.<number>
id number
size number

addUvs (verts, uvs, texture, start, size, matrix) protected

Generates the UVs for a shape.

Name Type Description
verts Array.<number>

Vertices

uvs Array.<number>

UVs

texture PIXI.Texture

Reference to Texture

start number

Index buffer start index.

size number

The size/length for index buffer.

matrix PIXI.Matrix optional

Optional transform for all points.

adjustUvs (uvs, texture, start, size)

Modify uvs array according to position of texture region Does not work with rotated or trimmed textures

Name Type Description
uvs number

array

texture PIXI.Texture

region

start number

starting index for uvs

size number

how many points to adjust

buildDrawCalls () protected

Converts intermediate batches data to drawCalls.

calculateBounds () protected

Update the local bounds of the object. Expensive to use performance-wise.

Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.

Returns:
Type Description
PIXI.GraphicsGeometry This GraphicsGeometry object. Good for chaining method calls

containsPoint (point)Boolean

Check to see if a point is contained within this geometry.

Name Type Description
point PIXI.Point

Point to check if it's contained.

Returns:
Type Description
Boolean true if the point is contained within geometry.

destroy (options)

Destroys the Graphics object.

Name Type Description
options object | boolean optional

Options parameter. A boolean will act as if all options have been set to that value

Name Type Default Description
children boolean false optional

if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.

texture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite

baseTexture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.

Name Type Description
shape PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle

The shape object to draw.

matrix PIXI.Matrix

Transform applied to the points of the shape.

Returns:
Type Description
PIXI.GraphicsGeometry Returns geometry for chaining.

drawShape (shape, fillStyle, lineStyle, matrix)PIXI.GraphicsGeometry

Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.

Name Type Description
shape PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle

The shape object to draw.

fillStyle PIXI.FillStyle

Defines style of the fill.

lineStyle PIXI.LineStyle

Defines style of the lines.

matrix PIXI.Matrix

Transform applied to the points of the shape.

Returns:
Type Description
PIXI.GraphicsGeometry Returns geometry for chaining.

isBatchable () protected

Checks to see if this graphics geometry can be batched. Currently it needs to be small enough and not contain any native lines.

processHoles (holes) protected

Process the holes data.

Name Type Description
holes Array.<PIXI.GraphicsData>

Holes to render

transformPoints (points, matrix) protected

Transform points using matrix.

Name Type Description
points Array.<number>

Points to transform

matrix PIXI.Matrix

Transform matrix

updateBatches () protected

Generates intermediate batch data. Either gets converted to drawCalls or used to convert to batch objects directly by the Graphics object.