Commits

Anonymous committed d3b1773

Fixing up some minor doc stuff

  • Participants
  • Parent commits 9371ca7

Comments (0)

Files changed (4)

File src/mixer.doc

 
 init
 initialize the mixer module
-pygame.mixer.init(frequency=22050, size=-16, stereo=2, buffer=1024): return None
+pygame.mixer.init(frequency=22050, size=-16, channels=2, buffer=1024): return None
 
 Initialize the mixer module for Sound loading and playback. The default
 arguments can be overridden to provide specific audio mixing. The size
 value is negative then signed sample values will be used. Positive values
 mean unsigned audio samples will be used. 
 
-The stereo argument is used to specify the number of channels used.  1 for 
-mono and 2 for stereo.
+The channels argument is used to specify whether to use mono or stereo.  1 for 
+mono and 2 for stereo. No other values are supported.
 
 The buffer argument controls the number of internal samples used in the
 sound mixer. The default value should work for most cases. It can be
 
 pre_init
 preset the mixer init arguments
-pygame.mixer.pre_init(frequency=0, size=0, stereo=0, buffersize=0): return None
+pygame.mixer.pre_init(frequency=0, size=0, channels=0, buffersize=0): return None
 
 Any nonzero arguments change the default values used when the real
 pygame.mixer.init() is called. The best way to set custom mixer playback
 
 get_init
 test if the mixer is initialized
-pygame.mixer.get_init(): return (frequency, format, stereo)
+pygame.mixer.get_init(): return (frequency, format, channels)
 
 If the mixer is initialized, this returns the playback arguments it 
 is using. If the mixer has not been initialized this returns None

File src/pygamedocs.h

 
 #define DOC_PYGAMESNDARRAYMAKESOUND "pygame.sndarray.make_sound(array): return Sound\nconvert an array into a Sound object"
 
-#define DOC_PYGAMESNDARRAYUSEARRAY "pygame.sndarray.use_array (arraytype): return None\nSets the array system to be used for sound arrays"
+#define DOC_PYGAMESNDARRAYUSEARRAYTYPE "pygame.sndarray.use_arraytype (arraytype): return None\nSets the array system to be used for sound arrays"
+
+#define DOC_PYGAMESNDARRAYGETARRAYTYPE "pygame.sndarray.get_arraytype (): return str\nGets the currently active array type."
 
 #define DOC_PYGAMESNDARRAYGETARRAYTYPES "pygame.sndarray.get_arraytypes (): return tuple\nGets the array system types currently supported."
 
 
 #define DOC_PYGAMESURFARRAYMAPARRAY "pygame.surfarray.map_array(Surface, array3d): return array2d\nMap a 3d array into a 2d array"
 
-#define DOC_PYGAMESURFARRAYUSEARRAY "pygame.surfarray.use_array (arraytype): return None\nSets the array system to be used for surface arrays"
+#define DOC_PYGAMESURFARRAYUSEARRAYTYPE "pygame.surfarray.use_arraytype (arraytype): return None\nSets the array system to be used for surface arrays"
+
+#define DOC_PYGAMESURFARRAYGETARRAYTYPE "pygame.surfarray.get_arraytype (): return str\nGets the currently active array type."
 
 #define DOC_PYGAMESURFARRAYGETARRAYTYPES "pygame.surfarray.get_arraytypes (): return tuple\nGets the array system types currently supported."
 
 
 #define DOC_PYGAMETRANSFORMSMOOTHSCALE "pygame.transform.smoothscale(Surface, (width, height), DestSurface = None): return Surface\nscale a surface to an arbitrary size smoothly"
 
-#define DOC_PYGAMETRANSFORMCHOP "pygame.transform.chop(Surface, rect): return Surface\nremove interior area of an image"
+#define DOC_PYGAMETRANSFORMCHOP "pygame.transform.chop(Surface, rect): return Surface\ngets a copy of an image with an interior area removed"
 
 #define DOC_PYGAMETRANSFORMLAPLACIAN "pygame.transform.laplacian(Surface, DestSurface = None): return Surface\nfind edges in a surface"
 

File src/surface.doc

 minimum alpha value. 
 
 This function will temporarily lock and unlock the Surface as needed.
+
+New in pygame 1.8.
 <END>
 
 

File src/transform.doc

 
 
 chop
-remove interior area of an image
+gets a copy of an image with an interior area removed
 pygame.transform.chop(Surface, rect): return Surface
 
 Extracts a portion of an image. All vertical and
-horizontal pixels surrounding the given rectangle area are removed. The
-resulting image is shrunken by the size of pixels removed.
+horizontal pixels surrounding the given rectangle area are removed.
+The corner areas (diagonal to the rect) are then brought together.
 (The original image is not altered by this operation.)
+
+NOTE: If you want a "crop" that returns the part of an image within
+a rect, you can blit with a rect to a new surface or copy a subsurface. 
 <END>
 
 
 pygame.transform.laplacian(Surface, DestSurface = None): return Surface
 
 Finds the edges in a surface using the laplacian algorithm.
+
+New in pygame 1.8
 <END>
 
 
 
 Takes a sequence of surfaces and returns a surface with average colors from each
 of the surfaces.
+
+New in pygame 1.8
 <END>
 
 
 
 You can use a threshold of (r,g,b,a) where the r,g,b can have different thresholds. So
 you could use an r threshold of 40 and a blue threshold of 2 if you like.
+
+New in pygame 1.8
 <END>
 <END>