Texture Management#
arcade.Texture#
- class arcade.Texture(image: Image | ImageData, *, hit_box_algorithm: HitBoxAlgorithm | None = None, hit_box_points: Sequence[Tuple[float, float]] | None = None, hash: str | None = None, **kwargs)[source]#
An arcade.Texture is simply a wrapper for image data as a Pillow image and the hit box data for this image used in collision detection. Usually created by the
load_texture
orload_textures
commands.- Parameters:
image (PIL.Image.Image) – The image or ImageData for this texture
hit_box_algorithm (str) – The algorithm to use for calculating the hit box.
hit_box_points (HitBox) – A list of hitbox points for the texture to use (Optional). Completely overrides the hit box algorithm.
hash (str) – Optional unique name for the texture. Can be used to make this texture globally unique. By default the hash of the pixel data is used.
- add_atlas_ref(atlas: TextureAtlas) None [source]#
Add a reference to an atlas that this texture is in.
- property atlas_name: str#
The name of the texture used for the texture atlas (read only).
- Returns:
str
- classmethod create_cache_name(*, hash: str, hit_box_algorithm: HitBoxAlgorithm, vertex_order: Tuple[int, int, int, int] = (0, 1, 2, 3)) str [source]#
Create a cache name for the texture.
- classmethod create_empty(name: str, size: Tuple[int, int], color: Tuple[int, int, int, int] = Color(r=0, g=0, b=0, a=0)) Texture [source]#
Create a texture with all pixels set to transparent black.
The hit box of the returned Texture will be set to a rectangle with the dimensions in
size
because there is no non-blank pixel data to calculate a hit box.- Parameters:
This function has multiple uses, including:
Allocating space in texture atlases
Generating custom cached textures from component images
The internal image can be altered with Pillow draw commands and then written/updated to a texture atlas. This works best for infrequent changes such as generating custom cached sprites. For frequent texture changes, you should instead render directly into the texture atlas.
Warning
If you plan to alter images using Pillow, read its documentation thoroughly! Some of the functions can have unexpected behavior.
For example, if you want to draw one or more images that contain transparency onto a base image that also contains transparency, you will likely need to use PIL.Image.alpha_composite as part of your solution. Otherwise, blending may behave in unexpected ways.
This is especially important for customizable characters.
Be careful of your RAM usage when using this function. The Texture this method returns will have a new internal RGBA Pillow image which uses 4 bytes for every pixel in it. This will quickly add up if you create many large Textures.
If you want to create more than one blank texture with the same dimensions, you can save CPU time and RAM by calling this function once, then passing the
image
attribute of the resulting Texture object to the class constructor for each additional blank Texture instance you would like to create. This can be especially helpful if you are creating multiple large Textures.
- classmethod create_filled(name: str, size: Tuple[int, int], color: Tuple[int, int, int, int]) Texture [source]#
Create a filled texture. This is an alias for
create_empty()
.
- crop(x: int, y: int, width: int, height: int) Texture [source]#
Create a new texture from a sub-section of this texture.
If the crop is the same size as the original texture or the crop is 0 width or height, the original texture is returned.
- property crop_values: Tuple[int, int, int, int] | None#
The crop values used to create this texture in the referenced file
- Returns:
Tuple[int, int, int, int]
- draw_scaled(center_x: float, center_y: float, scale: float = 1.0, angle: float = 0.0, alpha: int = 255)[source]#
Draw the texture.
Warning
This is a very slow method of drawing a texture, and should be used sparingly. The method simply creates a sprite internally and draws it.
- draw_sized(center_x: float, center_y: float, width: float, height: float, angle: float = 0.0, alpha: int = 255)[source]#
Draw a texture with a specific width and height.
Warning
This is a very slow method of drawing a texture, and should be used sparingly. The method simply creates a sprite internally and draws it.
- property file_path: Path | None#
A Path object to the file this texture was loaded from
- Returns:
Path
- flip_diagonally() Texture [source]#
Returns a new texture that is flipped diagonally from this texture. This is an alias for
transpose()
.This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- flip_horizontally() Texture [source]#
Flip the texture left to right / horizontally.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- flip_left_right() Texture [source]#
Flip the texture left to right / horizontally.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- flip_top_bottom() Texture [source]#
Flip the texture top to bottom / vertically.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- flip_vertically() Texture [source]#
Flip the texture top to bottom / vertically.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- property height: int#
The virtual width of the texture in pixels.
This can be different from the actual width if the texture has been transformed or the size have been set manually.
- Return type:
- property hit_box_algorithm: HitBoxAlgorithm#
(read only) The algorithm used to calculate the hit box for this texture.
- property hit_box_points: Sequence[Tuple[float, float]]#
Get the hit box points for this texture.
Custom hit box points must be supplied during texture creation and should ideally not be changed after creation.
- Returns:
PointList
- property image: Image#
Get or set the image of the texture.
Warning
This is an advanced function. Be absolutely sure you know the consequences of changing the image. It can cause problems with the texture atlas and hit box points.
- Parameters:
image (PIL.Image.Image) – The image to set
- property image_data: ImageData#
The image data of the texture (read only).
This is a simple wrapper around the image containing metadata like hash and is used to determine the uniqueness of the image in texture atlases.
- Returns:
ImageData
- property properties: Dict[str, Any]#
A dictionary of properties for this texture. This can be used to store any data you want.
- Returns:
Dict[str, Any]
- remove_atlas_ref(atlas: TextureAtlas) None [source]#
Remove a reference to an atlas that this texture is in.
- remove_from_cache(ignore_error: bool = True) None [source]#
Remove this texture from the cache.
- Parameters:
ignore_error (bool) – If True, ignore errors if the texture is not in the cache
- Returns:
None
- rotate_180() Texture [source]#
Rotate the texture 180 degrees.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- rotate_270() Texture [source]#
Rotate the texture 270 degrees.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- rotate_90(count: int = 1) Texture [source]#
Rotate the texture by a given number of 90 degree steps.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Parameters:
count (int) – Number of 90 degree steps to rotate.
- Returns:
Texture
- property size: Tuple[int, int]#
The virtual size of the texture in pixels.
This can be different from the actual width if the texture has been transformed or the size have been set manually.
- transform(transform: Type[Transform]) Texture [source]#
Create a new texture with the given transform applied.
- Parameters:
transform (Transform) – Transform to apply
- Returns:
New texture
- transpose() Texture [source]#
Returns a new texture that is transposed from this texture. This flips the texture diagonally from lower right to upper left.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
- transverse() Texture [source]#
Returns a new texture that is transverse from this texture. This flips the texture diagonally from lower left to upper right.
This returns a new texture with the same image data, but has updated hit box data and a transform that will be applied to the image when it’s drawn (GPU side).
- Returns:
Texture
arcade.cleanup_texture_cache#
arcade.get_default_image#
arcade.get_default_texture#
arcade.load_spritesheet#
- arcade.load_spritesheet(file_name: str | Path, sprite_width: int, sprite_height: int, columns: int, count: int, margin: int = 0, hit_box_algorithm: HitBoxAlgorithm | None = None) List[Texture] [source]#
- Parameters:
file_name (str) – Name of the file to that holds the texture.
sprite_width (int) – Width of the sprites in pixels
sprite_height (int) – Height of the sprites in pixels
columns (int) – Number of tiles wide the image is.
count (int) – Number of tiles in the image.
margin (int) – Margin between images
hit_box_algorithm (str) – The hit box algorithm
- Returns List:
List of
Texture
objects.
arcade.load_texture#
- arcade.load_texture(file_path: str | Path, *, x: int = 0, y: int = 0, width: int = 0, height: int = 0, hit_box_algorithm: HitBoxAlgorithm | None = None) Texture [source]#
Load an image from disk and create a texture.
The
x
,y
,width
, andheight
parameters are used to specify a sub-rectangle of the image to load. If not specified, the entire image is loaded.- Parameters:
- Returns:
New
Texture
object.- Raises:
ValueError
arcade.load_texture_pair#
arcade.load_textures#
- arcade.load_textures(file_name: str | Path, image_location_list: Tuple[Tuple[int, int, int, int] | List[int], ...] | List[Tuple[int, int, int, int] | List[int]], mirrored: bool = False, flipped: bool = False, hit_box_algorithm: HitBoxAlgorithm | None = None) List[Texture] [source]#
Load a set of textures from a single image file.
Note: If the code is to load only part of the image, the given x, y coordinates will start with the origin (0, 0) in the upper left of the image. When drawing, Arcade uses (0, 0) in the lower left corner. Be careful with this reversal.
For a longer explanation of why computers sometimes start in the upper left, see: http://programarcadegames.com/index.php?chapter=introduction_to_graphics&lang=en#section_5
- Parameters:
file_name (str) – Name of the file.
image_location_list (List) – List of image sub-locations. Each rectangle should be a List of four floats: [x, y, width, height].
mirrored (bool) – If set to True, the image is mirrored left to right.
flipped (bool) – If set to True, the image is flipped upside down.
hit_box_algorithm (str) – One of None, ‘None’, ‘Simple’ (default) or ‘Detailed’.
hit_box_detail (float) – Float, defaults to 4.5. Used with ‘Detailed’ to hit box
- Returns:
List of
Texture
’s.- Raises:
ValueError
arcade.make_circle_texture#
arcade.make_soft_circle_texture#
- arcade.make_soft_circle_texture(diameter: int, color: Tuple[int, int, int, int], center_alpha: int = 255, outer_alpha: int = 0, name: str | None = None, hit_box_algorithm: HitBoxAlgorithm | None = None) Texture [source]#
Return a
Texture
of a circle with the given diameter and color, fading out at its edges.- Parameters:
diameter (int) – Diameter of the circle and dimensions of the square
Texture
returned.color (RGBA255) – Color of the circle as a 4-length tuple or
Color
instance.center_alpha (int) – Alpha value of the circle at its center.
outer_alpha (int) – Alpha value of the circle at its edges.
name (str) – Custom or pre-chosen name for this texture
hit_box_algorithm (str) – The hit box algorithm
- Returns:
New
Texture
object.- Return type: