pygame :: Surface :: Class Surface
[hide private]
[frames] | no frames]

Class Surface

source code

object --+
         |
        Surface

pygame.Surface((width, height), flags=0, depth=0, masks=None): return Surface pygame.Surface((width, height), flags=0, Surface): return Surface pygame object for representing images

Instance Methods [hide private]
 
__copy__(...)
Surface.copy(): return Surface create a new copy of a Surface
source code
 
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
a new object with type S, a subtype of T
__new__(T, S, ...) source code
 
__repr__(x)
repr(x)
source code
 
blit(...)
Surface.blit(source, dest, area=None, special_flags = 0): return Rect draw one image onto another
source code
 
convert(...)
Surface.convert(Surface): return Surface Surface.convert(depth, flags=0): return Surface Surface.convert(masks, flags=0): return Surface Surface.convert(): return Surface change the pixel format of an image
source code
 
convert_alpha(...)
Surface.convert_alpha(Surface): return Surface Surface.convert_alpha(): return Surface change the pixel format of an image including per pixel alphas
source code
 
copy(...)
Surface.copy(): return Surface create a new copy of a Surface
source code
 
fill(...)
Surface.fill(color, rect=None, special_flags=0): return Rect fill Surface with a solid color
source code
 
get_abs_offset(...)
Surface.get_abs_offset(): return (x, y) find the absolute position of a child subsurface inside its top level parent
source code
 
get_abs_parent(...)
Surface.get_abs_parent(): return Surface find the top level parent of a subsurface
source code
 
get_alpha(...)
Surface.get_alpha(): return int_value or None get the current Surface transparency value
source code
 
get_at(...)
Surface.get_at((x, y)): return Color get the color value at a single pixel
source code
 
get_bitsize(...)
Surface.get_bitsize(): return int get the bit depth of the Surface pixel format
source code
 
get_bounding_rect(...)
Surface.get_bounding_rect(min_alpha = 1): return Rect find the smallest rect containing data
source code
 
get_buffer(...)
Surface.get_buffer(): return BufferProxy acquires a buffer object for the pixels of the Surface.
source code
 
get_bytesize(...)
Surface.get_bytesize(): return int get the bytes used per Surface pixel
source code
 
get_clip(...)
Surface.get_clip(): return Rect get the current clipping area of the Surface
source code
 
get_colorkey(...)
Surface.get_colorkey(): return RGB or None Get the current transparent colorkey
source code
 
get_flags(...)
Surface.get_flags(): return int get the additional flags used for the Surface
source code
 
get_height(...)
Surface.get_height(): return height get the height of the Surface
source code
 
get_locked(...)
Surface.get_locked(): return bool test if the Surface is current locked
source code
 
get_locks(...)
Surface.get_locks(): return tuple Gets the locks for the Surface
source code
 
get_losses(...)
Surface.get_losses(): return (R, G, B, A) the significant bits used to convert between a color and a mapped integer
source code
 
get_masks(...)
Surface.get_masks(): return (R, G, B, A) the bitmasks needed to convert between a color and a mapped integer
source code
 
get_offset(...)
Surface.get_offset(): return (x, y) find the position of a child subsurface inside a parent
source code
 
get_palette(...)
Surface.get_palette(): return [RGB, RGB, RGB, ...] get the color index palette for an 8bit Surface
source code
 
get_palette_at(...)
Surface.get_palette_at(index): return RGB get the color for a single entry in a palette
source code
 
get_parent(...)
Surface.get_parent(): return Surface find the parent of a subsurface
source code
 
get_pitch(...)
Surface.get_pitch(): return int get the number of bytes used per Surface row
source code
 
get_rect(...)
Surface.get_rect(**kwargs): return Rect get the rectangular area of the Surface
source code
 
get_shifts(...)
Surface.get_shifts(): return (R, G, B, A) the bit shifts needed to convert between a color and a mapped integer
source code
 
get_size(...)
Surface.get_size(): return (width, height) get the dimensions of the Surface
source code
 
get_width(...)
Surface.get_width(): return width get the width of the Surface
source code
 
lock(...)
Surface.lock(): return None lock the Surface memory for pixel access
source code
 
map_rgb(...)
Surface.map_rgb(Color): return mapped_int convert a color into a mapped color value
source code
 
mustlock(...)
Surface.mustlock(): return bool test if the Surface requires locking
source code
 
scroll(...)
Surface.scroll(dx=0, dy=0): return None Shift the surface image in place
source code
 
set_alpha(...)
Surface.set_alpha(value, flags=0): return None Surface.set_alpha(None): return None set the alpha value for the full Surface image
source code
 
set_at(...)
Surface.set_at((x, y), Color): return None set the color value for a single pixel
source code
 
set_clip(...)
Surface.set_clip(rect): return None Surface.set_clip(None): return None set the current clipping area of the Surface
source code
 
set_colorkey(...)
Surface.set_colorkey(Color, flags=0): return None Surface.set_colorkey(None): return None Set the transparent colorkey
source code
 
set_masks(...)
Surface.set_masks((r,g,b,a)): return None set the bitmasks needed to convert between a color and a mapped integer
source code
 
set_palette(...)
Surface.set_palette([RGB, RGB, RGB, ...]): return None set the color palette for an 8bit Surface
source code
 
set_palette_at(...)
Surface.set_at(index, RGB): return None set the color for a single index in an 8bit Surface palette
source code
 
set_shifts(...)
Surface.get_shifts((r,g,b,a)): return None sets the bit shifts needed to convert between a color and a mapped integer
source code
 
subsurface(...)
Surface.subsurface(Rect): return Surface create a new surface that references its parent
source code
 
unlock(...)
Surface.unlock(): return None unlock the Surface memory from pixel access
source code
 
unmap_rgb(...)
Surface.map_rgb(mapped_int): return Color convert a mapped integer color value into a Color
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

__new__(T, S, ...)

source code 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__repr__(x)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__