A class for storing a color. More...

#import <ObjFW/ObjFW.h>

Inheritance diagram for OFColor:

Instance Methods
(instancetype)	- initWithRed:green:blue:alpha:
	Initializes an already allocated color in the sRGB color space with the specified red, green, blue and alpha value. More...

(instancetype)	- initWithRed:green:blue:alpha:colorSpace:
	Initializes an already allocated color in the specified color space with the specified red, green, blue and alpha value. More...

(void)	- getRed:green:blue:alpha:
	Returns the red, green, blue and alpha value of the color. More...

(OFColor *)	- colorUsingColorSpace:
	Returns the color converted to the specified color space. More...

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object. More...

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object. More...

(unsigned int)	- retainCount
	Returns the retain count. More...

(bool)	- isProxy
	Returns whether the object is a proxy object. More...

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind. More...

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...

(nullable id)	- performSelector:
	Performs the specified selector. More...

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(bool)	- isEqual:
	Checks two objects for equality. More...

(instancetype)	- retain
	Increases the retain count. More...

(void)	- release
	Decreases the retain count. More...

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...

(instancetype)	- self
	Returns the receiver. More...

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference. More...

(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

Class Methods
(instancetype)	+ colorWithRed:green:blue:alpha:
	Creates a new color in the sRGB color space with the specified red, green, blue and alpha value. More...

(instancetype)	+ colorWithRed:green:blue:alpha:colorSpace:
	Creates a new color in the specified color space with the specified red, green, blue and alpha value. More...

(OFColor *)	+ black
	Returns the HTML color `black`. More...

(OFColor *)	+ silver
	Returns the HTML color `silver`. More...

(OFColor *)	+ gray
	Returns the HTML color `gray`. More...

(OFColor *)	+ grey
	Returns the HTML color `gray`. More...

(OFColor *)	+ white
	Returns the HTML color `white`. More...

(OFColor *)	+ maroon
	Returns the HTML color `maroon`. More...

(OFColor *)	+ red
	Returns the HTML color `red`. More...

(OFColor *)	+ purple
	Returns the HTML color `purple`. More...

(OFColor *)	+ fuchsia
	Returns the HTML color `fuchsia`. More...

(OFColor *)	+ green
	Returns the HTML color `green`. More...

(OFColor *)	+ lime
	Returns the HTML color `lime`. More...

(OFColor *)	+ olive
	Returns the HTML color `olive`. More...

(OFColor *)	+ yellow
	Returns the HTML color `yellow`. More...

(OFColor *)	+ navy
	Returns the HTML color `navy`. More...

(OFColor *)	+ blue
	Returns the HTML color `blue`. More...

(OFColor *)	+ teal
	Returns the HTML color `teal`. More...

(OFColor *)	+ aqua
	Returns the HTML color `aqua`. More...

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(nullable Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Properties
OFColorSpace *	colorSpace
	The color space in which the color is. More...

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object. More...

Detailed Description

A class for storing a color.

Method Documentation

◆ aqua()

+ (OFColor *) aqua

Returns the HTML color aqua.

The RGBA value in the sRGB color space is (0, 1, 1, 1).

Returns: The HTML color aqua

◆ black()

+ (OFColor *) black

Returns the HTML color black.

The RGBA value in the sRGB color space is (0, 0, 0, 1).

Returns: The HTML color black

◆ blue()

+ (OFColor *) blue

Returns the HTML color blue.

The RGBA value in the sRGB color space is (0, 0, 1, 1).

Returns: The HTML color blue

◆ colorUsingColorSpace:()

- (OFColor *) colorUsingColorSpace: (OFColorSpace *) colorSpace

Returns the color converted to the specified color space.

Parameters

colorSpace The color space to convert the color to

Returns: The color converted to the specified color space

◆ colorWithRed:green:blue:alpha:()

+ (instancetype) colorWithRed:	(float)	red
green:	(float)	green
blue:	(float)	blue
alpha:	(float)	alpha

Creates a new color in the sRGB color space with the specified red, green, blue and alpha value.

Parameters

red	The red value of the color
green	The green value of the color
blue	The blue value of the color
alpha	The alpha value of the color, between 0.0 and 1.0

Returns: A new color with the specified red, green, blue and alpha value

◆ colorWithRed:green:blue:alpha:colorSpace:()

+ (instancetype) colorWithRed:	(float)	red
green:	(float)	green
blue:	(float)	blue
alpha:	(float)	alpha
colorSpace:	(OFColorSpace *)	colorSpace

Creates a new color in the specified color space with the specified red, green, blue and alpha value.

Parameters

red	The red value of the color
green	The green value of the color
blue	The blue value of the color
alpha	The alpha value of the color, between 0.0 and 1.0
colorSpace	The color space the color is in

Returns: A new color with the specified red, green, blue and alpha value

◆ fuchsia()

+ (OFColor *) fuchsia

Returns the HTML color fuchsia.

The RGBA value in the sRGB color space is (1, 0, 1, 1).

Returns: The HTML color fuchsia

◆ getRed:green:blue:alpha:()

- (void) getRed:	(float *)	red
green:	(float *)	green
blue:	(float *)	blue
alpha:	(nullable float *)	alpha

Returns the red, green, blue and alpha value of the color.

Parameters

red	A pointer to store the red value of the color
green	A pointer to store the green value of the color
blue	A pointer to store the blue value of the color
alpha	An optional pointer to store the alpha of the color

◆ gray()

+ (OFColor *) gray

Returns the HTML color gray.

The RGBA value in the sRGB color space is (0.5, 0.5, 0.5, 1).

Returns: The HTML color gray

◆ green()

+ (OFColor *) green

Returns the HTML color green.

The RGBA value in the sRGB color space is (0, 0.5, 0, 1).

Returns: The HTML color green

◆ grey()

+ (OFColor *) grey

Returns the HTML color gray.

Deprecated:: Use gray instead.

The RGBA value in the sRGB color space is (0.5, 0.5, 0.5, 1).

Returns: The HTML color gray

◆ initWithRed:green:blue:alpha:()

- (instancetype) initWithRed:	(float)	red
green:	(float)	green
blue:	(float)	blue
alpha:	(float)	alpha

Initializes an already allocated color in the sRGB color space with the specified red, green, blue and alpha value.

Parameters

red	The red value of the color
green	The green value of the color
blue	The blue value of the color
alpha	The alpha value of the color, between 0.0 and 1.0

Returns: A color initialized with the specified red, green, blue and alpha value

◆ initWithRed:green:blue:alpha:colorSpace:()

- (instancetype) initWithRed:	(float)	red
green:	(float)	green
blue:	(float)	blue
alpha:	(float)	alpha
colorSpace:	(OFColorSpace *)	colorSpace

Initializes an already allocated color in the specified color space with the specified red, green, blue and alpha value.

Parameters

red	The red value of the color
green	The green value of the color
blue	The blue value of the color
alpha	The alpha value of the color, between 0.0 and 1.0
colorSpace	The color space the color is in

Returns: A color initialized with the specified red, green, blue and alpha value

◆ lime()

+ (OFColor *) lime

Returns the HTML color lime.

The RGBA value in the sRGB color space is (0, 1, 0, 1).

Returns: The HTML color lime

◆ maroon()

+ (OFColor *) maroon

Returns the HTML color maroon.

The RGBA value in the sRGB color space is (0.5, 0, 0, 1).

Returns: The HTML color maroon

◆ navy()

+ (OFColor *) navy

Returns the HTML color navy.

The RGBA value in the sRGB color space is (0, 0, 0.5, 1).

Returns: The HTML color navy

◆ olive()

+ (OFColor *) olive

Returns the HTML color olive.

The RGBA value in the sRGB color space is (0.5, 0.5, 0, 1).

Returns: The HTML color olive

◆ purple()

+ (OFColor *) purple

Returns the HTML color purple.

The RGBA value in the sRGB color space is (0.5, 0, 0.5, 1).

Returns: The HTML color purple

◆ red()

+ (OFColor *) red

Returns the HTML color red.

The RGBA value in the sRGB color space is (1, 0, 0, 1).

Returns: The HTML color red

◆ silver()

+ (OFColor *) silver

Returns the HTML color silver.

The RGBA value in the sRGB color space is (0.75, 0.75, 0.75, 1).

Returns: The HTML color silver

◆ teal()

+ (OFColor *) teal

Returns the HTML color teal.

The RGBA value in the sRGB color space is (0, 0.5, 0.5, 1).

Returns: The HTML color teal

◆ white()

+ (OFColor *) white

Returns the HTML color white.

The RGBA value in the sRGB color space is (1, 1, 1, 1).

Returns: The HTML color white

◆ yellow()

+ (OFColor *) yellow

Returns the HTML color yellow.

The RGBA value in the sRGB color space is (1, 1, 0, 1).

Returns: The HTML color yellow

Property Documentation

◆ colorSpace

- (OFColorSpace *) colorSpace

readnonatomicretain

The color space in which the color is.

The color's red, green and blue values should be interpreted according to the color space.

The documentation for this class was generated from the following files:

src/OFColor.h
src/OFColor.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ aqua()

◆ black()

◆ blue()

◆ colorUsingColorSpace:()

◆ colorWithRed:green:blue:alpha:()

◆ colorWithRed:green:blue:alpha:colorSpace:()

◆ fuchsia()

◆ getRed:green:blue:alpha:()

◆ gray()

◆ green()

◆ grey()

◆ initWithRed:green:blue:alpha:()

◆ initWithRed:green:blue:alpha:colorSpace:()

◆ lime()

◆ maroon()

◆ navy()

◆ olive()

◆ purple()

◆ red()

◆ silver()

◆ teal()

◆ white()

◆ yellow()

Property Documentation

◆ colorSpace