ObjFW
Loading...
Searching...
No Matches
OFColor Class Reference

A class for storing a color. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFColor:
OFObject <OFObject>

Instance Methods

(instancetype) - initWithRed:green:blue:alpha:
 Initializes an already allocated color with the specified red, green, blue and alpha value.
 
(void) - getRed:green:blue:alpha:
 Returns the red, green, blue and alpha value of the color.
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object.
 
(nullable OFMethodSignature *) - methodSignatureForSelector:
 Returns the method signature for the specified selector.
 
(void) - dealloc
 Deallocates the object.
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay.
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay.
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay.
 
(void) - performSelector:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay.
 
(void) - performSelector:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay.
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread.
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object.
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects.
 
(void) - performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects.
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects.
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread.
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object.
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects.
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects.
 
(void) - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects.
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay.
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay.
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay.
 
(void) - performSelector:onThread:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay.
 
(void) - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay.
 
(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.
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver.
 
- Instance Methods inherited from <OFObject>
(unsigned long) - hash
 Returns a hash for the object.
 
(unsigned int) - retainCount
 Returns the retain count.
 
(bool) - isProxy
 Returns whether the object is a proxy object.
 
(bool) - isKindOfClass:
 Returns a boolean whether the object is of the specified kind.
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class.
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector.
 
(nullable IMP- methodForSelector:
 Returns the implementation for the specified selector.
 
(nullable id) - performSelector:
 Performs the specified selector.
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object.
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects.
 
(nullable id) - performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects.
 
(nullable id) - performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects.
 
(bool) - isEqual:
 Checks two objects for equality.
 
(instancetype) - retain
 Increases the retain count.
 
(void) - release
 Decreases the retain count.
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
 
(instancetype) - self
 Returns the receiver.
 
(bool) - allowsWeakReference
 Returns whether the object allows a weak reference.
 
(bool) - retainWeakReference
 Retain a weak reference to this object.
 

Class Methods

(instancetype) + colorWithRed:green:blue:alpha:
 Creates a new color with the specified red, green, blue and alpha value.
 
(OFColor *) + black
 Returns the HTML color black.
 
(OFColor *) + silver
 Returns the HTML color silver.
 
(OFColor *) + gray
 Returns the HTML color gray.
 
(OFColor *) + grey
 Returns the HTML color gray.
 
(OFColor *) + white
 Returns the HTML color white.
 
(OFColor *) + maroon
 Returns the HTML color maroon.
 
(OFColor *) + red
 Returns the HTML color red.
 
(OFColor *) + purple
 Returns the HTML color purple.
 
(OFColor *) + fuchsia
 Returns the HTML color fuchsia.
 
(OFColor *) + green
 Returns the HTML color green.
 
(OFColor *) + lime
 Returns the HTML color lime.
 
(OFColor *) + olive
 Returns the HTML color olive.
 
(OFColor *) + yellow
 Returns the HTML color yellow.
 
(OFColor *) + navy
 Returns the HTML color navy.
 
(OFColor *) + blue
 Returns the HTML color blue.
 
(OFColor *) + teal
 Returns the HTML color teal.
 
(OFColor *) + aqua
 Returns the HTML color aqua.
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime.
 
(void) + unload
 A method which is called when the class is unloaded from the runtime.
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made.
 
(instancetype) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object.
 
(Class) + class
 Returns the class.
 
(OFString *) + className
 Returns the name of the class as a string.
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class.
 
(nullable Class) + superclass
 Returns the superclass of the class.
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector.
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol.
 
(nullable IMP+ instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector.
 
(nullable OFMethodSignature *) + instanceMethodSignatureForSelector:
 Returns the method signature of the instance method for the specified selector.
 
(OFString *) + description
 Returns a description for the class, which is usually the class name.
 
(nullable IMP+ replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class.
 
(nullable IMP+ replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class.
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver.
 
(bool) + resolveClassMethod:
 Try to resolve the specified class method.
 
(bool) + resolveInstanceMethod:
 Try to resolve the specified instance method.
 
(id) + copy
 Returns the class.
 

Additional Inherited Members

- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object.
 

Detailed Description

A class for storing a color.

Method Documentation

◆ aqua

+ (OFColor *) aqua

Returns the HTML color aqua.

The RGBA value is (0, 1, 1, 1).

Returns
The HTML color aqua

◆ black

+ (OFColor *) black

Returns the HTML color black.

The RGBA value is (0, 0, 0, 1).

Returns
The HTML color black

◆ blue

+ (OFColor *) blue

Returns the HTML color blue.

The RGBA value is (0, 0, 1, 1).

Returns
The HTML color blue

◆ colorWithRed:green:blue:alpha:

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

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

Parameters
redThe red value of the color, between 0.0 and 1.0
greenThe green value of the color, between 0.0 and 1.0
blueThe blue value of the color, between 0.0 and 1.0
alphaThe alpha value of the color, between 0.0 and 1.0
Returns
A new color with the specified red, green, blue and alpha value

◆ fuchsia

+ (OFColor *) fuchsia

Returns the HTML color fuchsia.

The RGBA value 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
redA pointer to store the red value of the color
greenA pointer to store the green value of the color
blueA pointer to store the blue value of the color
alphaAn optional pointer to store the alpha of the color

◆ gray

+ (OFColor *) gray

Returns the HTML color gray.

The RGBA value is (0.5, 0.5, 0.5, 1).

Returns
The HTML color gray

◆ green

+ (OFColor *) green

Returns the HTML color green.

The RGBA value 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 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 with the specified red, green, blue and alpha value.

Parameters
redThe red value of the color, between 0.0 and 1.0
greenThe green value of the color, between 0.0 and 1.0
blueThe blue value of the color, between 0.0 and 1.0
alphaThe alpha value of the color, between 0.0 and 1.0
Returns
A color initialized with the specified red, green, blue and alpha value

◆ lime

+ (OFColor *) lime

Returns the HTML color lime.

The RGBA value is (0, 1, 0, 1).

Returns
The HTML color lime

◆ maroon

+ (OFColor *) maroon

Returns the HTML color maroon.

The RGBA value is (0.5, 0, 0, 1).

Returns
The HTML color maroon

◆ navy

+ (OFColor *) navy

Returns the HTML color navy.

The RGBA value is (0, 0, 0.5, 1).

Returns
The HTML color navy

◆ olive

+ (OFColor *) olive

Returns the HTML color olive.

The RGBA value is (0.5, 0.5, 0, 1).

Returns
The HTML color olive

◆ purple

+ (OFColor *) purple

Returns the HTML color purple.

The RGBA value is (0.5, 0, 0.5, 1).

Returns
The HTML color purple

◆ red

+ (OFColor *) red

Returns the HTML color red.

The RGBA value is (1, 0, 0, 1).

Returns
The HTML color red

◆ silver

+ (OFColor *) silver

Returns the HTML color silver.

The RGBA value is (0.75, 0.75, 0.75, 1).

Returns
The HTML color silver

◆ teal

+ (OFColor *) teal

Returns the HTML color teal.

The RGBA value is (0, 0.5, 0.5, 1).

Returns
The HTML color teal

◆ white

+ (OFColor *) white

Returns the HTML color white.

The RGBA value is (1, 1, 1, 1).

Returns
The HTML color white

◆ yellow

+ (OFColor *) yellow

Returns the HTML color yellow.

The RGBA value is (1, 1, 0, 1).

Returns
The HTML color yellow

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