Data Structures | Functions | Variables
Color.h File Reference
#include <SFML/Graphics/Export.h>

Go to the source code of this file.

Data Structures

struct  sfColor
 Utility class for manpulating RGBA colors. More...
 

Functions

CSFML_GRAPHICS_API sfColor sfColor_fromRGB (sfUint8 red, sfUint8 green, sfUint8 blue)
 Construct a color from its 3 RGB components. More...
 
CSFML_GRAPHICS_API sfColor sfColor_fromRGBA (sfUint8 red, sfUint8 green, sfUint8 blue, sfUint8 alpha)
 Construct a color from its 4 RGBA components. More...
 
CSFML_GRAPHICS_API sfColor sfColor_fromInteger (sfUint32 color)
 Construct the color from 32-bit unsigned integer. More...
 
CSFML_GRAPHICS_API sfUint32 sfColor_toInteger (sfColor color)
 Convert a color to a 32-bit unsigned integer. More...
 
CSFML_GRAPHICS_API sfColor sfColor_add (sfColor color1, sfColor color2)
 Add two colors. More...
 
CSFML_GRAPHICS_API sfColor sfColor_subtract (sfColor color1, sfColor color2)
 Subtract two colors. More...
 
CSFML_GRAPHICS_API sfColor sfColor_modulate (sfColor color1, sfColor color2)
 Modulate two colors. More...
 

Variables

CSFML_GRAPHICS_API sfColor sfBlack
 Black predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfWhite
 White predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfRed
 Red predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfGreen
 Green predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfBlue
 Blue predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfYellow
 Yellow predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfMagenta
 Magenta predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfCyan
 Cyan predefined color. More...
 
CSFML_GRAPHICS_API sfColor sfTransparent
 Transparent (black) predefined color. More...
 

Function Documentation

◆ sfColor_add()

CSFML_GRAPHICS_API sfColor sfColor_add ( sfColor  color1,
sfColor  color2 
)

Add two colors.

Parameters
color1First color
color2Second color
Returns
Component-wise saturated addition of the two colors

◆ sfColor_fromInteger()

CSFML_GRAPHICS_API sfColor sfColor_fromInteger ( sfUint32  color)

Construct the color from 32-bit unsigned integer.

Parameters
colorNumber containing the RGBA components (in that order)
Returns
sfColor constructed from the 32-bit unsigned integer

◆ sfColor_fromRGB()

CSFML_GRAPHICS_API sfColor sfColor_fromRGB ( sfUint8  red,
sfUint8  green,
sfUint8  blue 
)

Construct a color from its 3 RGB components.

Parameters
redRed component (0 .. 255)
greenGreen component (0 .. 255)
blueBlue component (0 .. 255)
Returns
sfColor constructed from the components

◆ sfColor_fromRGBA()

CSFML_GRAPHICS_API sfColor sfColor_fromRGBA ( sfUint8  red,
sfUint8  green,
sfUint8  blue,
sfUint8  alpha 
)

Construct a color from its 4 RGBA components.

Parameters
redRed component (0 .. 255)
greenGreen component (0 .. 255)
blueBlue component (0 .. 255)
alphaAlpha component (0 .. 255)
Returns
sfColor constructed from the components

◆ sfColor_modulate()

CSFML_GRAPHICS_API sfColor sfColor_modulate ( sfColor  color1,
sfColor  color2 
)

Modulate two colors.

Parameters
color1First color
color2Second color
Returns
Component-wise multiplication of the two colors

◆ sfColor_subtract()

CSFML_GRAPHICS_API sfColor sfColor_subtract ( sfColor  color1,
sfColor  color2 
)

Subtract two colors.

Parameters
color1First color
color2Second color
Returns
Component-wise saturated subtraction of the two colors

◆ sfColor_toInteger()

CSFML_GRAPHICS_API sfUint32 sfColor_toInteger ( sfColor  color)

Convert a color to a 32-bit unsigned integer.

Returns
Color represented as a 32-bit unsigned integer

Variable Documentation

◆ sfBlack

Black predefined color.

Definition at line 47 of file Color.h.

◆ sfBlue

Blue predefined color.

Definition at line 51 of file Color.h.

◆ sfCyan

Cyan predefined color.

Definition at line 54 of file Color.h.

◆ sfGreen

Green predefined color.

Definition at line 50 of file Color.h.

◆ sfMagenta

Magenta predefined color.

Definition at line 53 of file Color.h.

◆ sfRed

Red predefined color.

Definition at line 49 of file Color.h.

◆ sfTransparent

CSFML_GRAPHICS_API sfColor sfTransparent

Transparent (black) predefined color.

Definition at line 55 of file Color.h.

◆ sfWhite

White predefined color.

Definition at line 48 of file Color.h.

◆ sfYellow

Yellow predefined color.

Definition at line 52 of file Color.h.