BaseImage¶
Object that loads an image, stores as a surface, transform it and let write the image to an surface.
- Parameters
image_path (str,
pathlib.Path
) – Path of the image to be loaded. It can be a string orpathlib.Path
onPython 3+
drawing_mode (int) – Drawing mode of the image
drawing_offset (tuple, list) – Offset of the image in drawing method
load_from_file (bool) – Loads the image from the given path
Apply a function to each pixel of the image. The function will receive the red, green, blue and alpha colors and must return the same values. The color pixel will be overriden by the function output.
Note
See
BaseImage.to_bw()
method as an example.- Parameters
image_function (callable) – Color function, takes colors as
image_function=myfunc(r, g, b, a)
. Returns the same tuple (r,g,b,a)- Returns
Self reference
- Return type
Updates the original surface to the current surface.
- Returns
None
Return a copy of the image.
- Returns
Image
- Return type
Draw the image in a given surface.
- Parameters
surface (
pygame.Surface
) – Pygame surface objectarea (
pygame.Rect
, None) – Area to draw, if None, Image will be drawn on entire surfaceposition (tuple) – Position to draw in (x, y)
- Returns
None
Return true if the image is the same as the object.
- Parameters
image (
pygame_menu.baseimage.BaseImage
) – Image object- Returns
True if the image is the same (note, the surface)
- Return type
This method can flip the image either vertically, horizontally, or both. Flipping a image is non-destructive and does not change the dimensions.
Return the image drawing mode.
- Returns
Image drawing mode
- Return type
Return the image drawing offset.
- Returns
Image drawing offset
- Return type
Return the extension of the image file.
- Returns
File extension
- Return type
Return the name of the image file.
- Returns
Filename
- Return type
Return the image path.
- Returns
Image path
- Return type
Return the rect of the image.
- Returns
Pygame rect object
- Return type
Return the size in pixels of the image.
- Returns
(width,height)
- Return type
Return the surface object of the image.
- Returns
Image surface
- Return type
Pick certain channels of the image, channels are ‘r’ (red), ‘g’ (green) and ‘b’ (blue),
channels param
is a list/tuple of channels (non empty).For example,
pick_channels(['r', 'g'])
: All channels not included on the list will be discarded.
Set the image size to another size.
Restore image to the original surface.
- Returns
None
Unfiltered counterclockwise rotation. The angle argument represents degrees and can be any floating point value. Negative angle amounts will rotate clockwise.
Note
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.
Scale the image to a desired width and height factor.
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
Self reference
- Return type
Set the image drawing mode.
- Parameters
drawing_mode (int) – Drawing mode
- Returns
None
Set the image drawing offset.
Converts the image to black and white.
- Returns
Self reference
- Return type