pyglet.graphics

Submodules

Details

Low-level graphics rendering and abstractions.

This module provides efficient abstractions over OpenGL objects, such as Shaders and Buffers. It also provides classes for highly performant batched rendering and grouping.

See the Shaders and Rendering for details on how to use this graphics API.

class Batch

Manage a collection of drawables for batched rendering.

Many drawable pyglet objects accept an optional Batch argument in their constructors. By giving a Batch to multiple objects, you can tell pyglet that you expect to draw all of these objects at once, so it can optimise its use of OpenGL. Hence, drawing a Batch is often much faster than drawing each contained drawable separately.

The following example creates a batch, adds two sprites to the batch, and then draws the entire batch:

batch = pyglet.graphics.Batch()
car = pyglet.sprite.Sprite(car_image, batch=batch)
boat = pyglet.sprite.Sprite(boat_image, batch=batch)

def on_draw():
    batch.draw()

While any drawables can be added to a Batch, only those with the same draw mode, shader program, and group can be optimised together.

Internally, a Batch manages a set of VertexDomains along with information about how the domains are to be drawn. To implement batching on a custom drawable, get your vertex domains from the given batch instead of setting them up yourself.

draw()

Draw the batch.

draw_subset(vertex_lists)

Draw only some vertex lists in the batch.

The use of this method is highly discouraged, as it is quite inefficient. Usually an application can be redesigned so that batches can always be drawn in their entirety, using draw.

The given vertex lists must belong to this batch; behaviour is undefined if this condition is not met.

Parameters:
vertex_listssequence of VertexList or IndexedVertexList

Vertex lists to draw.

get_domain(indexed, mode, group, program, attributes)

Get, or create, the vertex domain corresponding to the given arguments.

invalidate()

Force the batch to update the draw list.

This method can be used to force the batch to re-compute the draw list when the ordering of groups has changed.

New in version 1.2.

migrate(vertex_list, mode, group, batch)

Migrate a vertex list to another batch and/or group.

vertex_list and mode together identify the vertex list to migrate. group and batch are new owners of the vertex list after migration.

The results are undefined if mode is not correct or if vertex_list does not belong to this batch (they are not checked and will not necessarily throw an exception immediately).

batch can remain unchanged if only a group change is desired.

Parameters:
vertex_list~pyglet.graphics.vertexdomain.VertexList

A vertex list currently belonging to this batch.

modeint

The current GL drawing mode of the vertex list.

group~pyglet.graphics.Group

The new group to migrate to.

batch~pyglet.graphics.Batch

The batch to migrate to (or the current batch).

class Group(order=0, parent=None)

Group of common OpenGL state.

Group provides extra control over how drawables are handled within a Batch. When a batch draws a drawable, it ensures its group’s state is set; this can include binding textures, shaders, or setting any other parameters. It also sorts the groups before drawing.

In the following example, the background sprite is guaranteed to be drawn before the car and the boat:

batch = pyglet.graphics.Batch()
background = pyglet.graphics.Group(order=0)
foreground = pyglet.graphics.Group(order=1)

background = pyglet.sprite.Sprite(background_image, batch=batch, group=background)
car = pyglet.sprite.Sprite(car_image, batch=batch, group=foreground)
boat = pyglet.sprite.Sprite(boat_image, batch=batch, group=foreground)

def on_draw():
    batch.draw()
Parameters:
orderint

Set the order to render above or below other Groups. Lower orders are drawn first.

parent~pyglet.graphics.Group

Group to contain this Group; its state will be set before this Group’s state.

Variables:
visiblebool

Determines whether this Group is visible in any of the Batches it is assigned to. If False, objects in this Group will not be rendered.

batcheslist

Read Only. A list of which Batches this Group is a part of.

set_state()

Apply the OpenGL state change.

The default implementation does nothing.

set_state_recursive()

Set this group and its ancestry.

Call this method if you are using a group in isolation: the parent groups will be called in top-down order, with this class’s set being called last.

unset_state()

Repeal the OpenGL state change.

The default implementation does nothing.

unset_state_recursive()

Unset this group and its ancestry.

The inverse of set_state_recursive.

property batches
property order
property visible
class ShaderGroup(program, order=0, parent=None)

A group that enables and binds a ShaderProgram.

set_state()

Apply the OpenGL state change.

The default implementation does nothing.

unset_state()

Repeal the OpenGL state change.

The default implementation does nothing.

class TextureGroup(texture, order=0, parent=None)

A group that enables and binds a texture.

TextureGroups are equal if their textures’ targets and names are equal.

set_state()

Apply the OpenGL state change.

The default implementation does nothing.

draw(size, mode, **data)

Draw a primitive immediately.

Warning:

This function is deprecated as of 2.0.4, and will be removed in the next release.

Parameters:
sizeint

Number of vertices given

modegl primitive type

OpenGL drawing mode, e.g. GL_TRIANGLES, avoiding quotes.

**datakeyword arguments for passing vertex attribute data.

The keyword should be the vertex attribute name, and the argument should be a tuple of (format, data). For example: position=(‘f’, array)

draw_indexed(size, mode, indices, **data)

Draw a primitive with indexed vertices immediately.

Warning:

This function is deprecated as of 2.0.4, and will be removed in the next release.

Parameters:
sizeint

Number of vertices given

modeint

OpenGL drawing mode, e.g. GL_TRIANGLES

indicessequence of int

Sequence of integers giving indices into the vertex list.

**datakeyword arguments for passing vertex attribute data.

The keyword should be the vertex attribute name, and the argument should be a tuple of (format, data). For example: position=(‘f’, array)

get_default_batch()
get_default_shader()