builtin.h File Reference

Go to the source code of this file.

Functions
void	builtin (const char *layername, const char *builtin_script)
	call built-in script by script NOTE 1: Call in external script only! NOTE 2: Get error code in log windows. More...

Variables
	r =x y z[vel count pingpong]
	rotation layer More...
	move =start end [vel count pingpong]
	move layer More...
	movein =[axis vel flag]
	movein layer More...
	moveout =[axis vel flag]
	moveout layer More...
	fadein =[vel]
	fadein layer More...
	fadeout =[vel]
	fadeout layer More...
	fade =start end [vel count pingpong]
	fade layer More...
	scale = start end [vel count pingpong]
	scale layer More...
	visible = axis start end [vel count pingpong flag]
	visible layer More...
	aref = original_layername
	alias reference to layer NOTE: Support only layer in Photoshop! More...
	lottie ="filename" [fps loop pingpong width height]
	lottie animation More...
	audio ="filename" [loop]
	audio More...
	video = "filename" [loop]
	video More...

Detailed Description

Writing built-in script after layer name and MUST 1 space after that
parameter in scope [ ] is optional

<LayerName> <built-in Script>

Example pattern using built-in script in Photoshop

Layer 1 r=0x0x360

Definition in file builtin.h.

Function Documentation

builtin()

void builtin	(	const char *	layername,
		const char *	builtin_script
	)

call built-in script by script
NOTE 1: Call in external script only!
NOTE 2: Get error code in log windows.

Parameters

layername	name of layer, can be null that choose build-in layername from the other function.
builtin_script	string of built-in script.

Variable Documentation

aref

aref = original_layername

alias reference to layer
NOTE: Support only layer in Photoshop!

Parameters

original_layername

is layer to reference texture or animate Example: reference from boss layer aref=boss

Definition at line 231 of file builtin.h.

audio

audio ="filename" [loop]

audio

Parameters

name	is audio file name (MUST between double quote -> "filename.mp4").
loop	is boolean 1 = true, 0 = false (once)

See also

audio()

Example audio

audio="win.mp4"

Example set loop

audio="win.mp4"x1

Definition at line 271 of file builtin.h.

fade

fade =start end [vel count pingpong]

fade layer

Parameters

start	is opacity value 0 = transparent, 255 = opaque
end	is opacity value 0 = transparent, 255 = opaque
vel	is speed 1..inf, more is fastest, default is 300
count	is loop time, 0 is infinite, default is 0
pingpong	is loop style 1 = enable, 0 = disable, default is 0 Example fade=0x255 Fade in fade=0x255x300 Fade out fade=255x0x300 Fade loop fade=0x255x300x0 Fade loop pingpong fade=0x255x300x0x1

Definition at line 173 of file builtin.h.

fadein

fadein =[vel]

fadein layer

Parameters

vel	is speed 1..inf, more is fastest, default is 300 Example fadein= Example fadein fadein=500

Definition at line 127 of file builtin.h.

fadeout

fadeout =[vel]

fadeout layer

Parameters

vel	is speed 1..inf, more is fastest, default is 300 Example fadeout= Example fadeout fadeout=500

Definition at line 142 of file builtin.h.

lottie

lottie ="filename" [fps loop pingpong width height]

lottie animation

Parameters

name	is lottie animation file name (MUST between double quote -> "filename.json"). May be user can download from official website: https://lottiefiles.com/
fps	is frame speed, more is fast less is slow, 30 is default
loop	is boolean 1 = true, 0 = false (once)
pingpong	style animation playback (start->end->start); boolean 1 = true, 0 = false (once)
width	quality size of texture in width, default: 512 pixel
height	quality size of texture in height, default: 512 pixel

See also

lottie()

Example lottie

lottie="start.json"

Example set fps and resize

lottie="start.json"x60x1x1x512x512

Definition at line 253 of file builtin.h.

move

move =start end [vel count pingpong]

move layer

Parameters

start	is offset in x axis, currently add from layer position
end	is offset in y axis, currently add from layer position
vel	is speed 1..inf, more is fastest, default is 300
count	is loop time, 0 is infinite, default is 0
pingpong	is loop style 1 = enable, 0 = disable, default is 0 Example move=0x100 Example PingPong move=0x100x300x0x1

Definition at line 58 of file builtin.h.

movein

movein =[axis vel flag]

movein layer

Parameters

axis	0 is x, 1 is y.
vel	is speed 1..inf, more is fastest, default is 300
flag	is start corner of moving: 0 = left 1 = right 2 = top 3 = bottom 4 = left|top 5 = left|bottom 6 = right|top 7 = right|bottom Example movein=0x1000 Example movein right movein=0x800x1

Definition at line 85 of file builtin.h.

moveout

moveout =[axis vel flag]

moveout layer

Parameters

axis	0 is x, 1 is y.
vel	is speed 1..inf, more is fastest, default is 300
flag	is start corner of moving: 0 = left 1 = right 2 = top 3 = bottom 4 = left|top 5 = left|bottom 6 = right|top 7 = right|bottom Example moveout=0x1000 Example moveout left moveout=0x800x0

Definition at line 112 of file builtin.h.

r

r =x y z[vel count pingpong]

rotation layer

Parameters

x	is degree 0..360
y	is degree 0..360
z	is degree 0..360
vel	is speed 1..inf, more is fastest, default is 300
count	is loop time, 0 is infinite, default is 0
pingpong	is loop style 1 = enable, 0 = disable, default is 0 Example r=0x0x360 Example Pingpong r=0x0x90x100x0x1

Definition at line 39 of file builtin.h.

scale

scale = start end [vel count pingpong]

scale layer

Parameters

start	is size in x axis (can be decimal).
end	is size in y axis (can be decimal).
vel	is speed 1..inf, more is fastest, default is 300
count	is loop time, 0 is infinite, default is 0
pingpong	is loop style 1 = enable, 0 = disable, default is 0 Example scale=1x2x1 Example PingPong scale=1x2x1x0x1

Definition at line 192 of file builtin.h.

video

video = "filename" [loop]

video

Parameters

name	is video, gif or animated png file name (MUST between double quote -> "filename.mp4").
loop	is boolean 1 = true, 0 = false (once)

See also

video()

Example video

video="combo.mpg"

Example set loop

video="combo.mpg"x1

Definition at line 289 of file builtin.h.

visible

visible = axis start end [vel count pingpong flag]

visible layer

Parameters

axis	0 is x, 1 is y.
start	is visible size in x axis (0..100).
end	is visible size in y axis (0..100).
vel	is speed 1..inf, more is fastest, default is 300
count	is loop time, 0 is infinite, default is 0
pingpong	is loop style 1 = enable, 0 = disable, default is 0
flag	is visible pin default is left: 0 = left 1 = right 2 = top 3 = bottom 4 = center Example horizontal visible visible=0x0x100x100 Example vertical visible visible=1x0x100x100

Definition at line 220 of file builtin.h.