BufferImage
(x, y, width, height)¶An abstract framebuffer.
Constructor:
__init__
(x, y, width, height)¶Methods:
blit
(x, y[, z])Draw this image to the active framebuffers. blit_into
(source, x, y, z)Draw source on this image. blit_to_texture
(target, level, x, y[, z])Draw this image on the currently bound texture at target. get_image_data
()get_mipmapped_texture
()Retrieve a Texture instance with all mipmap levels filled in. get_region
(x, y, width, height)get_texture
([rectangle, force_rectangle])A Texture view of this image. save
([filename, file, encoder])Save this image to a file.
Attributes:
BufferImage.
format
= ''¶The format string used for image data.
BufferImage.
owner
= None¶Methods
BufferImage.
blit
(x, y, z=0)Draw this image to the active framebuffers.
The image will be drawn with the lower-left corner at (
x -
anchor_x,y -
anchor_y,z
).
BufferImage.
blit_into
(source, x, y, z)Draw source on this image.
source will be copied into this image such that its anchor point is aligned with the x and y parameters. If this image is a 3D texture, the z coordinate gives the image slice to copy into.
Note that if source is larger than this image (or the positioning would cause the copy to go out of bounds) then you must pass a region of source to this method, typically using get_region().
BufferImage.
blit_to_texture
(target, level, x, y, z=0)Draw this image on the currently bound texture at target.
This image is copied into the texture such that this image’s anchor point is aligned with the given x and y coordinates of the destination texture. If the currently bound texture is a 3D texture, the z coordinate gives the image slice to blit into.
BufferImage.
get_mipmapped_texture
()Retrieve a Texture instance with all mipmap levels filled in.
Requires that image dimensions be powers of 2.
Return type: Texture Note
Since pyglet 1.1
BufferImage.
get_texture
(rectangle=False, force_rectangle=False)A Texture view of this image.
By default, textures are created with dimensions that are powers of two. Smaller images will return a TextureRegion that covers just the image portion of the larger texture. This restriction is required on older video cards, and for compressed textures, or where texture repeat modes will be used, or where mipmapping is desired.
If the rectangle parameter is
True
, this restriction is ignored and a texture the size of the image may be created if the driver supports theGL_ARB_texture_rectangle
orGL_NV_texture_rectangle
extensions. If the extensions are not present, the image already is a texture, or the image has power 2 dimensions, the rectangle parameter is ignored.Examine Texture.target to determine if the returned texture is a rectangle (
GL_TEXTURE_RECTANGLE_ARB
orGL_TEXTURE_RECTANGLE_NV
) or not (GL_TEXTURE_2D
).If the force_rectangle parameter is
True
, one of these extensions must be present, and the returned texture always has targetGL_TEXTURE_RECTANGLE_ARB
orGL_TEXTURE_RECTANGLE_NV
.Changes to the returned instance may or may not be reflected in this image.
Parameters:
- rectangle (bool) – True if the texture can be created as a rectangle.
- force_rectangle (bool) – True if the texture must be created as a rectangle. Since: pyglet 1.1.4.
Return type: Texture
Note
Since pyglet 1.1
BufferImage.
save
(filename=None, file=None, encoder=None)Save this image to a file.
Parameters:
- filename (str) – Used to set the image file format, and to open the output file if file is unspecified.
- file (file-like object or None) – File to write image data to.
- encoder (ImageEncoder or None) – If unspecified, all encoders matching the filename extension are tried. If all fail, the exception from the first one attempted is raised.
Attributes
BufferImage.
anchor_x
= 0
BufferImage.
anchor_y
= 0
BufferImage.
image_data
An ImageData view of this image.
Changes to the returned instance may or may not be reflected in this image. Read-only.
Warning
Deprecated. Use get_image_data.
Type: ImageData
BufferImage.
mipmapped_texture
A Texture view of this image.
The returned Texture will have mipmaps filled in for all levels. Requires that image dimensions be powers of 2. Read-only.
Warning
Deprecated. Use get_mipmapped_texture.
Type: Texture
BufferImage.
texture
Get a Texture view of this image.
Changes to the returned instance may or may not be reflected in this image.
Warning
Deprecated. Use get_texture.
Type: Texture