Visual

Contents

• Visual
  • Sprites
  • Fonts
  • Drawing
  • SurfaceDrawing
  • Sprite
  • FontStore
  • Store
  • Text

Sprites

serge.visual.Sprites

Registry of all sprites (is a Store)

Fonts

serge.visual.Fonts

Registry of all fonts (is a FontStore)

Drawing

class serge.visual.Drawing

Bases: object

Represents something to draw on the screen

flipHorizontal()

Flip the drawing horizontally

flipVertical()

Flip the drawing vertically

getAngle()

Return the current angle

getCopy()

Return a copy

renderTo()

Render to a surface

rotateBy(angle)

Rotate by a certain amount

scaleBy(factor)

Scale the image by a factor

setAlpha(alpha)

Set the overall alpha

setAngle(angle)

Set the rotation to a certain angle

setHorizontalFlip(flip)

Set the horizontal flip state

setScale(scale)

Set the scaling to a certain factor

setSize(width, height)

Set the size of the drawing directly

setVerticalFlip(flip)

Set the vertical flip state

SurfaceDrawing

class serge.visual.SurfaceDrawing(width, height, pixel_format=65536)

Bases: serge.visual.Drawing

A visual object that renders to a surface.

You can create an instance of this class and then write to its surface or use this as a base class for your own class that will write the surface.

clearSurface()

Clear the surface

getSurface()

Return our surface

renderTo()

Render to a surface

scaleBy(factor)

Scale the image by a factor

setAngle(angle)

Change the angle - returning the amount by which the sprite has shifted

setSize(width, height)

Set the size of the drawing directly

setSurface(surface)

Update our surface

Sprite

class serge.visual.Sprite

Bases: serge.visual.Drawing

An object that gets drawn on the screen

flipHorizontal()

Flip the drawing horizontally

flipVertical()

Flip the drawing vertically

getCell()

Return the current cell number

getCopy()

Return a copy of this sprite

getNumberOfCells()

Return the number of animation cells

getSurface()

Return the current surface

renderTo()

Render to a surface

resetAnimation(running)

Reset the animation to the beginning

scaleBy(factor)

Scale the image by a factor

setAlpha(alpha)

Set the overall alpha

setAngle(angle)

Change the angle - returning the amount by which the sprite has shifted

setCell(number)

Set the current cell number

setCells()

Create the cells for the animation of this sprite

setImage()

Set the image of this sprite

setSize(width, height)

Set the size of the drawing directly

FontStore

class serge.visual.FontStore

Bases: serge.registry.GeneralStore

A store for fonts

clearItems()

Clear the items

Leaves the DEFAULT item in there if it is there.

getFont(name, size)

Return a font

This method implements a caching scheme. There seem to be problems on OSX repeatedly creating fonts and so we are caching here. This doesn’t seem to be needed on other platforms but we use it anyway as it should give a slight performance bonus.

registerItem(name, path)

Register a font

Store

class serge.visual.Store

Bases: serge.registry.GeneralStore

Stores sprites

registerFromFiles(name, path, number, framerate=0, running=False, rectangular=True, angle=0.0, zoom=1.0, start=1, loop=True, one_direction=False, convert_alpha=False)

Register a multi cell sprite from a number of files

The path should be a string with a single numerical substitution. We will pass the numbers 1..number to this substitution to find the names of the files.

registerItemsFromPattern(pattern, prefix='', w=1, h=1, framerate=0, running=False, rectangular=True, angle=0.0, zoom=1.0, loop=True, one_direction=False, convert_alpha=False)

Register all items matching a certain regular expression

The items will be registered as the filename with the extension dropped off. You can optionally specify a prefix to be used to put in front of the registered name.

registerMultipleItems(names, path, w, h=1, rectangular=True, angle=0.0, zoom=1.0, one_direction=False, convert_alpha=False)

Register a number of sprites from a single image

The image must be a horizontal row of sprites and you must provide a list of names the same size as the row of sprites. Each other sprites will be created.

Text

class serge.visual.Text(text, colour, font_name='DEFAULT', font_size=12, justify='center', fixed_char_width=None)

Bases: serge.visual.Drawing

Some text to display

convertAlpha(color_key=(127, 127, 127))

Convert this text to an surface alpha

renderTo()

Render to a surface

scaleBy(scale)

Scale our sprite by a certain certain amount

setAlpha(alpha)

Set our alpha

setAngle(angle)

Rotate our sprite by a certain angle

setColour(colour)

Set the colour

setFontSize(font_size)

Set our font size

setJustify(justify)

Set the justification

setText(text)

Set our text