Home       Trees       Index       Help   
Package pygame :: Class Surface
[show private | hide private]
[frames | no frames]

Type Surface

object --+
         |
        Surface

Known Subclasses:
FaderSurface
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
Method Summary
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __copy__(...)
Surface.copy(): return Surface create a new copy of a Surface
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __repr__(x)
x.__repr__() <==> repr(x)
  blit(...)
Surface.blit(source, dest, area=None, special_flags = 0): return Rect draw one image onto another
  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
  convert_alpha(...)
Surface.convert_alpha(Surface): return Surface Surface.convert_alpha(): return Surface change the pixel format of an image including per pixel alphas
  copy(...)
Surface.copy(): return Surface create a new copy of a Surface
  fill(...)
Surface.fill(color, rect=None, special_flags=0): return Rect fill Surface with a solid color
  get_abs_offset(...)
Surface.get_abs_offset(): return (x, y) find the absolute position of a child subsurface inside its top level parent
  get_abs_parent(...)
Surface.get_abs_parent(): return Surface find the top level parent of a subsurface
  get_alpha(...)
Surface.get_alpha(): return int_value or None get the current Surface transparency value
  get_at(...)
Surface.get_at((x, y)): return Color get the color value at a single pixel
  get_bitsize(...)
Surface.get_bitsize(): return int get the bit depth of the Surface pixel format
  get_buffer(...)
Surface.get_buffer(): return BufferProxy acquires a buffer object for the pixels of the Surface.
  get_bytesize(...)
Surface.get_bytesize(): return int get the bytes used per Surface pixel
  get_clip(...)
Surface.get_clip(): return Rect get the current clipping are of the Surface
  get_colorkey(...)
Surface.get_colorkey(): return RGB or None Get the current transparent colorkey
  get_flags(...)
Surface.get_flags(): return int get the additional flags used for the Surface
  get_height(...)
Surface.get_height(): return height get the height of the Surface
  get_locked(...)
Surface.get_locked(): return bool test if the Surface is current locked
  get_losses(...)
Surface.get_losses(): return (R, G, B, A) the significant bits used to convert between a color and a mapped integer
  get_masks(...)
Surface.get_masks(): return (R, G, B, A) the bitmasks needed to convert between a color and a mapped integer
  get_offset(...)
Surface.get_offset(): return (x, y) find the position of a child subsurface inside a parent
  get_palette(...)
Surface.get_palette(): return [RGB, RGB, RGB, ...] get the color index palette for an 8bit Surface
  get_palette_at(...)
Surface.get_palette_at(index): return RGB get the color for a single entry in a palette
  get_parent(...)
Surface.get_parent(): return Surface find the parent of a subsurface
  get_pitch(...)
Surface.get_pitch(): return int get the number of bytes used per Surface row
  get_rect(...)
Surface.get_rect(**kwargs): return Rect get the rectangular area of the Surface
  get_shifts(...)
Surface.get_shifts(): return (R, G, B, A) the bit shifts needed to convert between a color and a mapped integer
  get_size(...)
Surface.get_size(): return (width, height) get the dimensions of the Surface
  get_width(...)
Surface.get_width(): return width get the width of the Surface
  lock(...)
Surface.lock(): return None lock the Surface memory for pixel access
  map_rgb(...)
Surface.map_rgb(Color): return mapped_int convert a color into a mapped color value
  mustlock(...)
Surface.mustlock(): return bool test if the Surface requires locking
  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
  set_at(...)
Surface.set_at((x, y), Color): return None set the color value for a single pixel
  set_clip(...)
Surface.set_clip(rect): return None Surface.set_clip(None): return None set the current clipping area of the Surface
  set_colorkey(...)
Surface.set_colorkey(Color, flags=0): return None Surface.set_colorkey(None): return None Set the transparent colorkey
  set_palette(...)
Surface.set_palette([RGB, RGB, RGB, ...]): return None set the color palette for an 8bit Surface
  set_palette_at(...)
Surface.set_at(index, RGB): return None set the color for a single index in an 8bit Surface palette
  subsurface(...)
Surface.subsurface(Rect): return Surface create a new surface that references its parent
  unlock(...)
Surface.unlock(): return None unlock the Surface memory from pixel access
  unmap_rgb(...)
Surface.map_rgb(mapped_int): return Color convert a mapped integer color value into a Color
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(...)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides:
__builtin__.object.__init__

__copy__(...)

Surface.copy(): return Surface create a new copy of a Surface

__new__(T, S, ...)

T.__new__(S, ...) -> a new object with type S, a subtype of T
Returns:
a new object with type S, a subtype of T
Overrides:
__builtin__.object.__new__

__repr__(x)
(Representation operator)

x.__repr__() <==> repr(x)
Returns:
repr(x)
Overrides:
__builtin__.object.__repr__

blit(...)

Surface.blit(source, dest, area=None, special_flags = 0): return Rect draw one image onto another

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

convert_alpha(...)

Surface.convert_alpha(Surface): return Surface Surface.convert_alpha(): return Surface change the pixel format of an image including per pixel alphas

copy(...)

Surface.copy(): return Surface create a new copy of a Surface

fill(...)

Surface.fill(color, rect=None, special_flags=0): return Rect fill Surface with a solid color

get_abs_offset(...)

Surface.get_abs_offset(): return (x, y) find the absolute position of a child subsurface inside its top level parent

get_abs_parent(...)

Surface.get_abs_parent(): return Surface find the top level parent of a subsurface

get_alpha(...)

Surface.get_alpha(): return int_value or None get the current Surface transparency value

get_at(...)

Surface.get_at((x, y)): return Color get the color value at a single pixel

get_bitsize(...)

Surface.get_bitsize(): return int get the bit depth of the Surface pixel format

get_buffer(...)

Surface.get_buffer(): return BufferProxy acquires a buffer object for the pixels of the Surface.

get_bytesize(...)

Surface.get_bytesize(): return int get the bytes used per Surface pixel

get_clip(...)

Surface.get_clip(): return Rect get the current clipping are of the Surface

get_colorkey(...)

Surface.get_colorkey(): return RGB or None Get the current transparent colorkey

get_flags(...)

Surface.get_flags(): return int get the additional flags used for the Surface

get_height(...)

Surface.get_height(): return height get the height of the Surface

get_locked(...)

Surface.get_locked(): return bool test if the Surface is current locked

get_losses(...)

Surface.get_losses(): return (R, G, B, A) the significant bits used to convert between a color and a mapped integer

get_masks(...)

Surface.get_masks(): return (R, G, B, A) the bitmasks needed to convert between a color and a mapped integer

get_offset(...)

Surface.get_offset(): return (x, y) find the position of a child subsurface inside a parent

get_palette(...)

Surface.get_palette(): return [RGB, RGB, RGB, ...] get the color index palette for an 8bit Surface

get_palette_at(...)

Surface.get_palette_at(index): return RGB get the color for a single entry in a palette

get_parent(...)

Surface.get_parent(): return Surface find the parent of a subsurface

get_pitch(...)

Surface.get_pitch(): return int get the number of bytes used per Surface row

get_rect(...)

Surface.get_rect(**kwargs): return Rect get the rectangular area of the Surface

get_shifts(...)

Surface.get_shifts(): return (R, G, B, A) the bit shifts needed to convert between a color and a mapped integer

get_size(...)

Surface.get_size(): return (width, height) get the dimensions of the Surface

get_width(...)

Surface.get_width(): return width get the width of the Surface

lock(...)

Surface.lock(): return None lock the Surface memory for pixel access

map_rgb(...)

Surface.map_rgb(Color): return mapped_int convert a color into a mapped color value

mustlock(...)

Surface.mustlock(): return bool test if the Surface requires locking

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

set_at(...)

Surface.set_at((x, y), Color): return None set the color value for a single pixel

set_clip(...)

Surface.set_clip(rect): return None Surface.set_clip(None): return None set the current clipping area of the Surface

set_colorkey(...)

Surface.set_colorkey(Color, flags=0): return None Surface.set_colorkey(None): return None Set the transparent colorkey

set_palette(...)

Surface.set_palette([RGB, RGB, RGB, ...]): return None set the color palette for an 8bit Surface

set_palette_at(...)

Surface.set_at(index, RGB): return None set the color for a single index in an 8bit Surface palette

subsurface(...)

Surface.subsurface(Rect): return Surface create a new surface that references its parent

unlock(...)

Surface.unlock(): return None unlock the Surface memory from pixel access

unmap_rgb(...)

Surface.map_rgb(mapped_int): return Color convert a mapped integer color value into a Color

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Thu Jan 10 10:18:44 2008 http://epydoc.sf.net