layer_sprite_blend


Description

This function controls the blending (or "tinting") of the sprite sprite and the default value is -1 (which represents the constant c_white, which can also be used). Any other value (including internal colour constants like c_red, or c_aqua) will blend the specified colour with the original sprite. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and then set the blending colour to use. Below you can see an example of a sprite that has been blended with different colours: Blended Sprites Please note that you should try to limit blending on the HTML5 platform (unless using WebGL), as each blended sprite has to be cached separately and so having many blended sprites may adversely affect performance (you can also set the cache size using the function sprite_set_cache_size()).


Syntax:

layer_sprite_blend(sprite_element_id, blend);


Arguments:

Argument Description
sprite_element_id The unique ID value of the sprite element to change
blend The colour to blend with the sprite sprite (default is c_white)


Returns:

N/A


Example:

var lay_id = layer_get_id("Asset_sky");
var spr_id = layer_sprite_get_id(lay_id, "Clouds");
layer_sprite_blend(spr_id, c_gray);

The above code gets the ID value of the sprite called "Clouds" assigned to the layer "Asset_sky" and then tints it to a colour.


Back: Sprite Layer Functions
next: layer_sprite_alpha
© Copyright YoYo Games Ltd. 2018 All Rights Reserved