BaseImage

class pygame_menu.baseimage.BaseImage(image_path, drawing_mode=101, drawing_offset=(0, 0))[source]

Object that loads an image, stores as a surface, transform it and let write the image to an surface.

Parameters:
  • image_path (str) – Path of the image to be loaded
  • drawing_mode (int) – Drawing mode of the image
  • drawing_offset (tuple, list) – Offset of the image in drawing method
checkpoint()[source]

Updates the original surface to the current surface.

Returns:None
draw(surface, area, position=(0, 0))[source]

Draw the image in a given surface.

Parameters:
Returns:

None

equals(image)[source]

Returns true if the image is the same as the object

Parameters:image (BaseImage) – Image object
Returns:True if the image is the same (note, the surface)
Return type:bool
flip(x, y)[source]

This can flip the image either vertically, horizontally, or both. Flipping a image is non-destructive and does not change the dimensions.

Parameters:
  • x (bool) – Flip in x axis
  • y (bool) – Flip on y axis
Returns:

None

get_drawing_mode()[source]
Returns:Image drawing mode
Return type:int
get_extension()[source]
Returns:Return the extension of the image file
Return type:str
get_namefile()[source]
Returns:Return the name of the image file
Return type:str
get_rect()[source]

Return the rect of the image.

Returns:Pygame rect object
Return type:pygame.Rect
get_size()[source]

Return the size in pixels of the image.

Returns:(width,height)
Return type:tuple
get_surface()[source]

Return the surface object.

Returns:Image surface
Return type:pygame.Surface
resize(width, height, smooth=False)[source]

Set the image size to another size. This is a fast scale operation.

Parameters:
  • width (int, float) – New width of the image
  • height (int, float) – New height of the image
  • smooth (bool) – Smooth scaling
Returns:

None

restore()[source]

Restore image to the original surface.

Returns:None
rotate(angle)[source]

Unfiltered counterclockwise rotation. The angle argument represents degrees and can be any floating point value. Negative angle amounts will rotate clockwise.

Unless rotating by 90 degree increments, the image will be padded larger to hold the new size. If the image has pixel alphas, the padded area will be transparent. Otherwise pygame will pick a color that matches the image colorkey or the topleft pixel value.

Parameters:angle (int, float) – Rotation angle
Returns:None
scale(width, height, smooth=False)[source]

Scale the image to a desired width and height factor.

Parameters:
  • width (int, float) – Scale factor of the width
  • height (int, float) – Scale factor of the height
  • smooth (bool) – Smooth scaling
Returns:

None

scale2x()[source]

This will return a new image that is double the size of the original. It uses the AdvanceMAME Scale2X algorithm which does a ‘jaggy-less’ scale of bitmap graphics.

This really only has an effect on simple images with solid colors. On photographic and antialiased images it will look like a regular unfiltered scale.

Returns:None