8.16. tsImageFillColor

Syntax

Pascal

procedure tsImageFillColor3ub(ImageID: tsImageID; Red: tsByte;
  Green: tsByte; Blue: tsByte; ChannelMask: tsBitmask);

procedure tsImageFillColor3f(ImageID: tsImageID; Red: tsFloat;
  Green: tsFloat; Blue: tsFloat; ChannelMask: tsBitmask);

procedure tsImageFillColor4ub(ImageID: tsImageID; Red: tsByte;
  Green: tsByte; Blue: tsByte; Alpha: tsByte; ChannelMask: tsBitmask);

procedure tsImageFillColor4f(ImageID: tsImageID; Red: tsFloat;
  Green: tsFloat; Blue: tsFloat; Alpha: tsFloat; ChannelMask: tsBitmask);

C/C++

void tsImageFillColor3ub(tsImageID ImageID, tsByte Red,
  tsByte Green, tsByte Blue, tsBitmask ChannelMask);

void tsImageFillColor3f(tsImageID ImageID, tsFloat Red,
  tsFloat Green, tsFloat Blue, tsBitmask ChannelMask);

void tsImageFillColor4ub(tsImageID ImageID, tsByte Red,
  tsByte Green, tsByte Blue, tsByte Alpha, tsBitmask ChannelMask);

void tsImageFillColor4f(tsImageID ImageID, Red,
  tsFloat Green, tsFloat Blue, tsFloat Alpha, tsBitmask ChannelMask);

Description

Fills an image with an specific color. The operation can be affected by the adjusted image modes.

Params

ImageID

The ID of the image which will be resized.

Red, Green, Blue and Alpha

Indicates the value for one of the channels. The value may have 2 types. tsByte with an range from 0 to 255. tsFloat with an range from 0 to 1. If you call an version without the alpha parameter the value for the alpha always will be the maximum value (255 or 1).

If an channel wasn't specified in the channel mask the value for this channel get ignored.

ChannelMask

Indicates which channels getting filled. For an list of all available flags look in the table Channelmasks.

Error Codes

TS_NO_ACTIVE_CONTEXT

If there was no context bound.

TS_INVALID_OPERATION

If you try to resize an empty image.

TS_INVALID_VALUE

This will happen if you pass an invalid ImageID to this function.