Source

pygame / src / doc / color_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMECOLOR "Color(name) -> Color\nColor(r, g, b, a) -> Color\nColor(rgbvalue) -> Color\npygame object for color representations"

#define DOC_COLORR "r -> int\nGets or sets the red value of the Color."

#define DOC_COLORG "g -> int\nGets or sets the green value of the Color."

#define DOC_COLORB "b -> int\nGets or sets the blue value of the Color."

#define DOC_COLORA "a -> int\nGets or sets the alpha value of the Color."

#define DOC_COLORCMY "cmy -> tuple\nGets or sets the CMY representation of the Color."

#define DOC_COLORHSVA "hsva -> tuple\nGets or sets the HSVA representation of the Color."

#define DOC_COLORHSLA "hsla -> tuple\nGets or sets the HSLA representation of the Color."

#define DOC_COLORI1I2I3 "i1i2i3 -> tuple\nGets or sets the I1I2I3 representation of the Color."

#define DOC_COLORNORMALIZE "normalize() -> tuple\nReturns the normalized RGBA values of the Color."

#define DOC_COLORCORRECTGAMMA "correct_gamma (gamma) -> Color\nApplies a certain gamma value to the Color."

#define DOC_COLORSETLENGTH "set_length(len) -> None\nSet the number of elements in the Color to 1,2,3, or 4."



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

/*

pygame.Color
 Color(name) -> Color
 Color(r, g, b, a) -> Color
 Color(rgbvalue) -> Color
pygame object for color representations

pygame.Color.r
 r -> int
Gets or sets the red value of the Color.

pygame.Color.g
 g -> int
Gets or sets the green value of the Color.

pygame.Color.b
 b -> int
Gets or sets the blue value of the Color.

pygame.Color.a
 a -> int
Gets or sets the alpha value of the Color.

pygame.Color.cmy
 cmy -> tuple
Gets or sets the CMY representation of the Color.

pygame.Color.hsva
 hsva -> tuple
Gets or sets the HSVA representation of the Color.

pygame.Color.hsla
 hsla -> tuple
Gets or sets the HSLA representation of the Color.

pygame.Color.i1i2i3
 i1i2i3 -> tuple
Gets or sets the I1I2I3 representation of the Color.

pygame.Color.normalize
 normalize() -> tuple
Returns the normalized RGBA values of the Color.

pygame.Color.correct_gamma
 correct_gamma (gamma) -> Color
Applies a certain gamma value to the Color.

pygame.Color.set_length
 set_length(len) -> None
Set the number of elements in the Color to 1,2,3, or 4.

*/