Introduction

The ColorOperation enumeration defines possible color operations which can be used by an IColorable to modify its appearance. For more information, see the IColorable wiki entry.

ColorOperation Values

The following table lists color operations and supported platforms:

* As of August 15 2024 the only color operation supported is Texture. These will likely be expanded in future versions of FlatRedBall Web.

Introduction

The Add color operation allows the addition of the Color (Red, Green, Blue) values to the texture drawn by an object. This can be used to "lighten", or simulate light shining on an object.

Code Usage

The following code can be used to set a Sprite's color operation to Add when the space bar is pressed.

private void CustomActivity()
{
    var keyboard = InputManager.Keyboard;
    if(keyboard.KeyDown(Microsoft.Xna.Framework.Input.Keys.Space))
    {
        SpriteInstance.ColorOperation = FlatRedBall.Graphics.ColorOperation.Add;
        SpriteInstance.Red = 1;
        SpriteInstance.Green = 1;
        SpriteInstance.Blue = 1;
    }
    else
    {
        // reset the defaults:
        SpriteInstance.ColorOperation = FlatRedBall.Graphics.ColorOperation.Texture;
        SpriteInstance.Red = 0;
        SpriteInstance.Green = 0;
        SpriteInstance.Blue = 0;
    }
}

The ColorOperation.Color option makes the drawn object completely ignore its Texture and use only the color. For objects like Sprites, this results in a colored quad (no texture). Alpha is ignored completely as well, so even if the Sprite's Texture has transparency, it will appear as a solid rectangle when using this color operation. Sprites that use .Color do not need to have a Texture. Therefore, the following code is acceptable:

sprite.ColorOperation = ColorOperation.Color;
sprite.Red = 1;

Introduction

The Texture color operation results in an object being drawn with its unmodified texture. Color values (red, green and blue) on the IColorable are completely ignored, unless the object has no texture. The Texture color operation is the default color operation for FlatRedBall types like Sprite and Text.

Code Example

Texture color operation can be assigned on any IColorable, such as Sprite:

var sprite = SpriteManager.AddSprite(SpriteTexture);
sprite.ColorOperation = ColorOperation.Texture;

Color Values

As mentioned above, the Red, Green, and Blue values have no impact on an object which uses the Texture color operation.

Introduction

The InterpolateColor ColorOperation can be used to blend a Sprite to a particular color. The Alpha value on the IColorable is used to perform the blending, so IColorables which use the InterpolateColor ColorOperation must rely on only their texture for transparency.

Code Example

Camera.Main.UsePixelCoordinates();

for (int i = 0; i < 10; i++)
{
    Sprite sprite = SpriteManager.AddSprite("Content/Bear.png");
    sprite.TextureScale = 1;
    sprite.X = -200 + 40 * i;

    sprite.ColorOperation = ColorOperation.InterpolateColor;
    sprite.Red = 1;
    sprite.Green = 0;
    sprite.Blue = 0;
    // The maximum value for 'i' in this loop is 9, so let's make that full alpha 
    sprite.Alpha = i / 9.0f;
}

Usage Example - Coloring Grayscale Image

Images which are grayscale can be colored using the Modulate color operation. This is a fast way to create variety for entities such as enemies or equipment. The following animation shows tinting using the FlatRedBall Editor on a Sprite with Modulate color operation.

Code Example - Darkening

The following code creates 10 bears, starting with a color of pure black (0,0,0) and ending with white (1,1,1). The bears start dark (as if in shadow), then become progressively brighter.

 Camera.Main.UsePixelCoordinates();
 Camera.Main.BackgroundColor = Color.Gray;

 for (int i = 0; i < 10; i++)
 {
     Sprite sprite = SpriteManager.AddSprite("Content/Bear.png");
     sprite.TextureScale = 1;
     sprite.X = -200 + 40 * i;

     sprite.ColorOperation = ColorOperation.Modulate;
     sprite.Red = i / 9.0f;
     sprite.Green = i / 9.0f;
     sprite.Blue = i / 9.0f;
 }

Code Example - Tinting

// This makes it easier to see the blue bear:
Camera.Main.BackgroundColor = Color.Gray;

Sprite originalSprite = SpriteManager.AddSprite("Content/Bear.png");
originalSprite.Y = 60;

Sprite redSprite = SpriteManager.AddSprite("Content/Bear.png");
redSprite.TextureScale = 1;
redSprite.ColorOperation = ColorOperation.Modulate;
redSprite.Red = 1;
redSprite.Green = 0;
redSprite.Blue = 0;
redSprite.X = -60;

Sprite greenSprite = SpriteManager.AddSprite("Content/Bear.png");
greenSprite.TextureScale = 1;
greenSprite.ColorOperation = ColorOperation.Modulate;
greenSprite.Red = 0;
greenSprite.Green = 1;
greenSprite.Blue = 0;

Sprite blueSprite = SpriteManager.AddSprite("Content/Bear.png");
blueSprite.TextureScale = 1;
blueSprite.ColorOperation = ColorOperation.Modulate;
blueSprite.Red = 0;
blueSprite.Green = 0;
blueSprite.Blue = 1;
blueSprite.X = 60;