pygame / src / doc / transform_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMETRANSFORM "pygame module to transform surfaces"

#define DOC_PYGAMETRANSFORMFLIP "pygame.transform.flip(Surface, xbool, ybool): return Surface\nflip vertically and horizontally"

#define DOC_PYGAMETRANSFORMSCALE "pygame.transform.scale(Surface, (width, height), DestSurface = None): return Surface\nresize to new resolution"

#define DOC_PYGAMETRANSFORMROTATE "pygame.transform.rotate(Surface, angle): return Surface\nrotate an image"

#define DOC_PYGAMETRANSFORMROTOZOOM "pygame.transform.rotozoom(Surface, angle, scale): return Surface\nfiltered scale and rotation"

#define DOC_PYGAMETRANSFORMSCALE2X "pygame.transform.scale2x(Surface, DestSurface = None): Surface\nspecialized image doubler"

#define DOC_PYGAMETRANSFORMSMOOTHSCALE "pygame.transform.smoothscale(Surface, (width, height), DestSurface = None): return Surface\nscale a surface to an arbitrary size smoothly"

#define DOC_PYGAMETRANSFORMGETSMOOTHSCALEBACKEND "pygame.transform.get_smoothscale_backend(): return String\nreturn smoothscale filter version in use: 'GENERIC', 'MMX', or 'SSE'"

#define DOC_PYGAMETRANSFORMSETSMOOTHSCALEBACKEND "pygame.transform.get_smoothscale_backend(type): return None\nset smoothscale filter version to one of: 'GENERIC', 'MMX', or 'SSE'"

#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"

#define DOC_PYGAMETRANSFORMAVERAGESURFACES "pygame.transform.average_surfaces(Surfaces, DestSurface = None, palette_colors = 1): return Surface\nfind the average surface from many surfaces."

#define DOC_PYGAMETRANSFORMAVERAGECOLOR "pygame.transform.average_color(Surface, Rect = None): return Color\nfinds the average color of a surface"

#define DOC_PYGAMETRANSFORMTHRESHOLD "pygame.transform.threshold(DestSurface, Surface, color, threshold = (0,0,0,0), diff_color = (0,0,0,0), change_return = 1, Surface = None, inverse = False): return num_threshold_pixels\nfinds which, and how many pixels in a surface are within a threshold of a color."



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


/*

pygame.transform
 pygame module to transform surfaces



pygame.transform.flip
 pygame.transform.flip(Surface, xbool, ybool): return Surface
flip vertically and horizontally



pygame.transform.scale
 pygame.transform.scale(Surface, (width, height), DestSurface = None): return Surface
resize to new resolution



pygame.transform.rotate
 pygame.transform.rotate(Surface, angle): return Surface
rotate an image



pygame.transform.rotozoom
 pygame.transform.rotozoom(Surface, angle, scale): return Surface
filtered scale and rotation



pygame.transform.scale2x
 pygame.transform.scale2x(Surface, DestSurface = None): Surface
specialized image doubler



pygame.transform.smoothscale
 pygame.transform.smoothscale(Surface, (width, height), DestSurface = None): return Surface
scale a surface to an arbitrary size smoothly



pygame.transform.get_smoothscale_backend
 pygame.transform.get_smoothscale_backend(): return String
return smoothscale filter version in use: 'GENERIC', 'MMX', or 'SSE'



pygame.transform.set_smoothscale_backend
 pygame.transform.get_smoothscale_backend(type): return None
set smoothscale filter version to one of: 'GENERIC', 'MMX', or 'SSE'



pygame.transform.chop
 pygame.transform.chop(Surface, rect): return Surface
gets a copy of an image with an interior area removed



pygame.transform.laplacian
 pygame.transform.laplacian(Surface, DestSurface = None): return Surface
find edges in a surface



pygame.transform.average_surfaces
 pygame.transform.average_surfaces(Surfaces, DestSurface = None, palette_colors = 1): return Surface
find the average surface from many surfaces.



pygame.transform.average_color
 pygame.transform.average_color(Surface, Rect = None): return Color
finds the average color of a surface



pygame.transform.threshold
 pygame.transform.threshold(DestSurface, Surface, color, threshold = (0,0,0,0), diff_color = (0,0,0,0), change_return = 1, Surface = None, inverse = False): return num_threshold_pixels
finds which, and how many pixels in a surface are within a threshold of a color.



*/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.