puzzle.utils.pygameProcessing Namespace Reference

Classes
class	TextRectException

Functions
def	multiLineSurface (str string, pygame.font.Font font, pygame.rect.Rect rect, tuple fontColour, tuple BGColour, justification=0)

Function Documentation

multiLineSurface()

def puzzle.utils.pygameProcessing.multiLineSurface	(	str	string,
		pygame.font.Font	font,
		pygame.rect.Rect	rect,
		tuple	fontColour,
		tuple	BGColour,
			justification = 0
	)

Returns a surface containing the passed text string, reformatted
to fit within the given rect, word-wrapping as necessary. The text
will be anti-aliased.

See https://stackoverflow.com/a/32624909

Parameters
----------
string - the text you wish to render. \n begins a new line.
font - a Font object
rect - a rect style giving the size of the surface requested.
fontColour - a three-byte tuple of the rgb value of the
         text color. ex (0, 0, 0) = BLACK
BGColour - a three-byte tuple of the rgb value of the surface.
justification - 0 (default) left-justified
            1 horizontally centered
            2 right-justified

Returns
-------
Success - a surface object with the text rendered onto it.
Failure - raises a TextRectException if the text won't fit onto the surface.