Shader: "scaled image"

"scaled image"

ClassForeground
Synopsis Blends an image using a mask.
Arguments

"file name" Description: Filename of foreground image to be read.
Default:""
Hint:-
"image" Description: A foreground image in memory.
Default:
Hint:-
"mask file name" Description: Filename of image to be used as mask.
Default:""
Hint:-
"mask image" Description: Image to be used as mask.
Default:
Hint:-
"invert mask" Description: Invert the masking behaviour.
Default:FALSE
Hint:-
"rotation" Description: Rotate the image 0, 90, 180 or 270 degrees.
Default:LI_ANGLE_DEG_0
Hint:-
"aspect mode" Description: Select behaviour if the image does not fit the display; 'stretch' the image to fit ('stretch clipped' is the same but without wrapping around), preserve the image aspect ratio ('keep ratio') by cropping part of the image ('keep ratio clipped' is the same but without wrapping around), use black borders ('letterbox'), match the view, lock the background image to the 'centre' of the view, or 'repeat' (tile) the image without scaling.
Default:LI_ASPECT_MODE_STRETCH
Hint:-
"keep texture" Description: If set to TRUE, the shader will keep the image live in memory even if it is deleted elsewhere in the application.
Default:FALSE
Hint:-
"softness" Description: Controls the degree of blurring on the image texture.
Default:1.0
Hint:-
"x offset" Description: Offset the image in horizontal direction.
Default:0.0
Hint:-
"y offset" Description: Offset the image in vertical direction.
Default:0.0
Hint:-
"image brightness" Description: The brightness of the image.
Default:1.0
Hint:-
"coverage" Description: Scaling factor for alpha values. Values less than 1 make the image more transparent and greater than 1 make image more opaque. The mask image can be any image with 1 or 3 channels. In the case of images with 3 channels, only the first (red) is used.
Default:1.0
Hint:-
"use alpha channel" Description: Use the alpha channel of the image or file as the mask source.
Default:FALSE
Hint:-

Previous page alphabetically (foglight)
Next page alphabetically (gausscurve)
Index


Copyright © 2010 Lightwork Design Limited. All rights reserved