Source

pygame / src / doc / pixelarray_doc.h

Full commit
/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEPIXELARRAY "PixelArray(Surface) -> PixelArray\npygame object for direct pixel access of surfaces"

#define DOC_PIXELARRAYSURFACE "surface -> Surface\nGets the Surface the PixelArray uses."

#define DOC_PIXELARRAYITEMSIZE "itemsize -> int\nReturns the byte size of a pixel array item"

#define DOC_PIXELARRAYNDIM "ndim -> int\nReturns the number of dimensions."

#define DOC_PIXELARRAYSHAPE "shape -> tuple of int's\nReturns the array size."

#define DOC_PIXELARRAYSTRIDES "strides -> tuple of int's\nReturns byte offsets for each array dimension."

#define DOC_PIXELARRAYMAKESURFACE "make_surface() -> Surface\nCreates a new Surface from the current PixelArray."

#define DOC_PIXELARRAYREPLACE "replace(color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)) -> None\nReplaces the passed color in the PixelArray with another one."

#define DOC_PIXELARRAYEXTRACT "extract(color, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray\nExtracts the passed color from the PixelArray."

#define DOC_PIXELARRAYCOMPARE "compare(array, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray\nCompares the PixelArray with another one."

#define DOC_PIXELARRAYTRANSPOSE "transpose() -> PixelArray\nExchanges the x and y axis."



/* Docs in a comment... slightly easier to read. */

/*

pygame.PixelArray
 PixelArray(Surface) -> PixelArray
pygame object for direct pixel access of surfaces

pygame.PixelArray.surface
 surface -> Surface
Gets the Surface the PixelArray uses.

pygame.PixelArray.itemsize
 itemsize -> int
Returns the byte size of a pixel array item

pygame.PixelArray.ndim
 ndim -> int
Returns the number of dimensions.

pygame.PixelArray.shape
 shape -> tuple of int's
Returns the array size.

pygame.PixelArray.strides
 strides -> tuple of int's
Returns byte offsets for each array dimension.

pygame.PixelArray.make_surface
 make_surface() -> Surface
Creates a new Surface from the current PixelArray.

pygame.PixelArray.replace
 replace(color, repcolor, distance=0, weights=(0.299, 0.587, 0.114)) -> None
Replaces the passed color in the PixelArray with another one.

pygame.PixelArray.extract
 extract(color, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray
Extracts the passed color from the PixelArray.

pygame.PixelArray.compare
 compare(array, distance=0, weights=(0.299, 0.587, 0.114)) -> PixelArray
Compares the PixelArray with another one.

pygame.PixelArray.transpose
 transpose() -> PixelArray
Exchanges the x and y axis.

*/