Can't get pygame font to render on image

Question

I've found lots of tutorials for using pygame, and its font library, but they all show the same exact thing. They all show you how to write some plain text on to a background, which is great, but going beyond that there's not a lot of useful information that I've found.

With the project I'm working on, I have menu buttons that I've implemented as sprites. When you hover over them they change colors, and that all works pretty well. What I'd like to do is write text on these buttons, but I'm baffled on how to do that. From the docs font.render works as so:

"This creates a new Surface with the specified text rendered on it. Pygame provides no way to directly draw text on an existing Surface: instead you must use Font.render - draw text on a new Surface to create an image (Surface) of the text, then blit this image onto another Surface."

So I've tried to take the image that's attached to my sprite and directly blit my text onto that. That seems to mostly do absolutely nothing:

    resume = self.button_font.render(
        'Resume Game',
        True,
        constants.WHITE,
        (23, 56, 245) # Main color of the button, tried without this as well
    )
    self.resume_button.image.blit(
        resume,
        self.resume_button.rect,
    )

I know that code runs, but you never see any text. If I blit the text directly to my main screen surface, it'll just write over the top of my resume button (depending on the blit order of course). What am I doing wrong? The docs seem to indicate that this is the right way to handle it, but I've yet to find anyone else doing this. Any help would be greatly appreciated.

sloth sloth · Accepted Answer · 2012-07-08T20:08:08

Did you call convert on the surface of your Sprite? If not, better do so.

Having different pixel formats on your surfaces will lead to all kind of annoying and hard to understand bugs.

Example:

import pygame

pygame.init()
screen = pygame.display.set_mode((400, 400))
image = pygame.image.load('1.png')

sprite = pygame.sprite.Sprite()
sprite.image = image
sprite.rect = image.get_rect()

font = pygame.font.SysFont('Sans', 50)
text = font.render('This is a text', True, (255, 0, 0))

sprite.image.blit(text, sprite.rect)

group = pygame.sprite.Group()
group.add(sprite)
group.draw(screen)

pygame.display.flip()

print 'bits per pixel:'
print 'image', image.get_bitsize()
print 'screen', screen.get_bitsize()

This will lead to the following bug:

without convert

Output:

bits per pixel
image 8
screen 32

Now change the line

image = pygame.image.load('1.png')

to

image = pygame.image.load('1.png').convert()

and everything will be fine:

with convert

Output:

bits per pixel
image 32
screen 32

Can't get pygame font to render on image

1 Answers