CCEffectSaturation Class Reference

Inherits from	CCEffect : NSObject
Declared in	CCEffectSaturation.h

Overview

CCEffectSaturation adjusts the saturation of the sprite or effect node it is attached to.

Tasks

Accessing Effect Attributes

saturation property

Initializing a CCEffectSaturation object

– init
– initWithSaturation:

Creating a CCEffectSaturation object

+ effectWithSaturation:

Properties

saturation

The saturation adjustment value which is in the range [-1..1]. -1 completely desaturates all affected pixels resulting in a grayscale image, 0 results in no change, 1 results in an increase in saturation by 100%.

@property (nonatomic) float saturation

Declared In

CCEffectSaturation.h

Class Methods

effectWithSaturation:

Creates a CCEffectSaturation object with the supplied parameters.

+ (id)effectWithSaturation:(float)saturation

Parameters

saturation: The desired saturation adjustment.

Return Value

The CCEffectSaturation object.

Declared In

CCEffectSaturation.h

Instance Methods

init

Initializes a CCEffectSaturation object with a saturation adjustment of 0.

- (id)init

Return Value

The CCEffecSaturation object.

Declared In

CCEffectSaturation.h

initWithSaturation:

Initializes a CCEffectSaturation object with the supplied parameters.

- (id)initWithSaturation:(float)saturation

Parameters

saturation: The desired saturation adjustment.

Return Value

The CCEffectSaturation object.

Declared In

CCEffectSaturation.h