Slang 0.902000 2004.07.29 04:33:03 2006.01.26 00:14:49 green green 0.799000 yes system variable almost nothing none Returns the value of the green color channel of the pixel at the current position (implicitly adressed by x and y) The returned value can be a value between 0 and maxcol. As system variables are read only to the script language, any attempt to assign values will fail. none red red 0.799000 yes system variable almost nothing none Returns the value of the red color channel of the pixel at the current position (implicitly adressed by x and y) The returned value can be a value between 0 and maxcol. As system variables are read only to the script language, any attempt to assign values will fail. none blue blue 0.799000 yes system variable almost nothing none Returns the value of the blue color channel of the pixel at the current position (implicitly adressed by x and y) The returned value can be a value between 0 and maxcol. As system variables are read only to the script language, any attempt to assign values will fail. none pi pi 0.799000 no system constant almost nothing none Numeric constant 3.141593 Mathematical constant, that descripes the raltionship between circumsference and diameter of a circle. none x x 0.799000 yes system variable almost nothing none The x coordinate of the current position The x coordinate of the current position is only valid for the following events: - Each Pixel - Each Red - Each Green - Each Blue For all other events, x remains 0. As system variables are read only to the script language, any attempt to assign values will fail. none y y 0.799000 yes system variable almost nothing none The y coordinate of the current position. The y coordinate of the current position is only valid for the following events: - Each Line - Each Pixel - Each Red - Each Green - Each Blue For all other events, y remains 0. As system variables are read only to the script language, any attempt to assign values will fail. none width width 0.799000 no system variable almost nothing none The width of the target frame/image that has to be rendered As system variables are read only to the script language, any attempt to assign values will fail. none height height 0.799000 no system variable almost nothing none The height of the target frame/image that has to be rendered As system variables are read only to the script language, any attempt to assign values will fail. none maxx maxx 0.799000 no system variable almost nothing none The maximum value that x can become. This is always calculated as width-1. The very first pixel in a pixel-row starts counting with 0. Therefore the last pixel in the row is always 1 lower then the number of pixels in a row. As system variables are read only to the script language, any attempt to assign values will fail. none maxy maxy 0.799000 no system variable almost nothing none The maximum value that y can become. This is always calculated as height-1. The very first pixel in a pixel-column starts counting with 0. Therefore the last pixel in the column is always 1 lower then the number of pixels in a column. As system variables are read only to the script language, any attempt to assign values will fail. none maxcol maxcol 0.799000 no system constant almost nothing none The maximum value that one of the color channels (reg/green/blue) can have. maxcol is defined as 255. As system constants are read only to the script language, any attempt to assign values will fail. none frame frame 0.799000 no system variable almost nothing none The index of the current frame, while rendering a video clip. The returned value can be a value between 0 and maxframe. As system variables are read only to the script language, any attempt to assign values will fail. none maxframe maxframe 0.799000 no system variable almost nothing none The highest ordinal that the system variable 'frame' may become while a sequence of frames is processed. See 'Return' none progress progress 0.799000 no system variable almost nothing none Indicator of the progress within a video clip The progress system variable indicates to progress within a video clip: 0.0 the very first frame has to be rendered 0.5 the frame closest to the middle of the clip has to be rendered 1.0 the very last frame has to be rendered The value of progress is calculated for every frame within a video clip. As system variables are read only to the script language, any attempt to assign values will fail. none setoffscreen( setoffscreen( color_red, color_green, color_blue ) 0.811000 no function somewhat color_red: value of red color channel (0 to maxcol) color_green: value of green color channel (0 to maxcol) color_blue: value of blue color channel (0 to maxcol) nothing The functions red@, green@ and blue@ can retrieve the color information of pixels at other coordinates then the current x/y-position. For the case that invalid x/y-coordinates are pointing outside the source image, the offscreen-color is used. The offscreen-color is by default RGB(0,0,0) (black). The setoffscreen function can be used to set a different color. none blurred( blurred( int_size ) 0.815000 yes function heavy int_size integer value that defines the dimesions of the relevant area that surrounds the current pixel Average value of the red color channel of all pixels within the dimension int_size x int_size for the current pixel. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none blurgreen( blurgreen( int_size ) 0.815000 yes function heavy int_size integer value that defines the dimesions of the relevant area that surrounds the current pixel Average value of the green color channel of all pixels within the dimension int_size x int_size for the current pixel. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none blurblue( blurblue( int_size ) 0.815000 yes function heavy int_size integer value that defines the dimesions of the relevant area that surrounds the current pixel Average value of the blue color channel of all pixels within the dimension int_size x int_size for the current pixel. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none blurred@( blurred@( coord_x, coord_y, int_size ) 0.815000 no function heavy coord_x x-coordinate of a given position coord_y y-coordinate of a given position int_size integer value that defines the dimesions of the relevant area that surrounds the pixel at the given position Average value of the red color channel of all pixels within the dimension int_size x int_size for the pixel of the given position. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none blurgreen@( blurgreen@( coord_x, coord_y, int_size ) 0.815000 no function heavy coord_x x-coordinate of a given position coord_y y-coordinate of a given position int_size integer value that defines the dimesions of the relevant area that surrounds the pixel at the given position Average value of the green color channel of all pixels within the dimension int_size x int_size for the pixel of the given position. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none blurblue@( blurblue@( coord_x, coord_y, int_size ) 0.815000 no function heavy coord_x x-coordinate of a given position coord_y y-coordinate of a given position int_size integer value that defines the dimesions of the relevant area that surrounds the pixel at the given position Average value of the blue color channel of all pixels within the dimension int_size x int_size for the pixel of the given position. See 'Return'. The bigger int_size is, the bigger is the relevant square-region and therefore the image will become more blured. none edge( edge( int_clear ) 0.815000 yes function heavy int_clear integer between 1 and 10 to clear unwanted edge details (1=many edge details, 10 very low edge details) Real number between 0 and 1 that represents the likelihood that the current pixel represents an edge. Sobel edge detection. Examines the surrounding of the current pixel and evaluates how likely the pixel represents an edge. none edge@( edge@( coord_x, coord_y, int_clear ) 0.815000 no function heavy coord_x x-coordinate of a given position coord_y y-coordinate of a given position int_clear integer between 1 and 10, to clear unwanted edge details (1=many edge details, 10 very low edge details) Real number between 0 and 1 that represents the likelihood that the pixel at the given position represents an edge. Sobel edge detection. Examines the surrounding of the pixel at the given position and evaluates how likely the pixel represents an edge. none + + 0.799000 no operator almost nothing none The sum of the values of the left and the right side of the plus operator. The mathematical plus operator calculates the sum of two values. The following sample sets 'somevariable' to the value of 12: somevariable=8+4; - - 0.799000 no operator almost nothing none The difference between the value of the left- and rightside operand. The mathematical minus operator is used to calculate differences between to given values. The following code sets the variable 'result' to a value of 15: val1=25; val2=10; result=val1-val2; * * 0.799000 no operator somewhat none Product of the left and right side of the operator Multiplication operator: multiplies the left side of the operator with the expression at the right side. Note: The interpreter is not yet capable of operator precedence, except in case of use of parenthesis. This means that '2+3*4' is computed as 20 and not as 14. A simple workaround is the use of paranthesis. The expression '2+(3*4)' will be correctly computed as 14. The following example assigns the value 12 to 'somevariable': somevariable = 3*4 / / 0.799000 no operator somewhat none Product of the left and right side of the operator Division operator: divides the left side of the operator by the expression at the right side. The right side (divisor) must be different from 0. Note: The interpreter is not yet capable of operator precedence, except in case of use of parenthesis. This means that '4+16/4' is computed as 5 and not as 8. A simple workaround is the use of paranthesis. The expression '4+(16/4)' will be correctly computed as 8. The following example assigns the value 5 to 'somevariable': somevariable = 20/4 % % 0.799000 no operator somewhat none reminder of the division The result of the modulus operator is the reminder from the division of the first operator with the second. The following example sets 'somevariable' to the value of 2: somevariable = 10 % 4 ( ( 0.799000 no operator almost nothing none none Parenthesis are either used to specify operator precedence or to determine begin and end of a functions parameter list. The compiler/interpreter processes formulas from left to right by default. Within complex calculations, it is usually necessary to specify which math operation shall be prior to the others. Prior operations must be encapsulated between an opening and an closing parenthesis. It is possible to nest multiple occurances of parenthesis. In that case, the most inner parenthesis operation will become priority to the others. In the follwing sample the multiplication (4*5) will be calculated first. Then the result of that multiplication (20) will become devided by 10 (20/10). Finaly, 123 will be reduced by the result of the division (123-2): value=(123-((4*5)/10)) == == 0.803000 no operator almost nothing none Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'equal' is used to determine whether the operand left to the operator is equal to the operand at the right side of the operator. It can be used in conjunction with the 'if' function. It shall not be confused with the single equal sign, that is for assignment of values to variables. In the following sample 3 will be assigned to value3, because value1 is equal to value2: value1=20; value2=20; value3=if(value1==value2,3,7) < < 0.803000 no operator almost nothing none Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'lower than' is used to determine whether the operand left to the operator is lower than the operand right to the operator. It can be used in conjunction with the 'if' function. In the following sample 3 will be assigned to value3, because value1 is lower than value2: value1=20; value2=30; value3=if(value1<value2,3,7) > > 0.803000 no operator almost nothing none Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'greater than' is used to determine whether the operand left to the operator is greater than the operand at the right side of the operator. It can be used in conjunction with the 'if' function. In the following sample 7 will be assigned to value3, because value1 is higher than value2: value1=20; value2=30; value3=if(value1>value2,3,7) <= <= 0.803000 no operator almost nothing none Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'lower/equal than' is used to determine whether the operand left to the operator is lower or equal to the operand at the right side of the operator. It can be used in conjunction with the 'if' function. In the following sample 3 will be assigned to value3, because value1 is equal to value2: value1=20; value2=20; value3=if(value1<=value2,3,7) >= >= 0.803000 no operator almost nothing none Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'greater/equal' is used to determine whether the operand left to the operator is greater or equal to the operand at the right side of the operator. It can be used in conjunction with the 'if' function. In the following sample 3 will be assigned to value3, because value1 is equal to value2: value1=20; value2=20; value3=if(value1>=value2,3,7) || || 0.803000 no operator almost nothing none Boolean expression: 1 if true, 0 if false. The logical or-operator is used to combine logical expressions. It can be used in conjunction with the 'if' function. The following example returns value_1 if condition_1 OR condition_2 is true: somevariable = if( condition_1 || condition_2, value_1, value_2 ) && && 0.803000 no operator almost nothing none Boolean expression: 1 if true, 0 if false. The logical and-operator is used to combine logical expressions. It can be used in conjunction with the 'if' function. The following example returns value_1 if condition_1 AND condition_2 is true: somevariable = if( condition_1 && condition_2, value_1, value_2 ) ) ) 0.799000 no operator almost nothing none none Parenthesis are either used to specify operator precedence or to determine begin and end of a functions parameter list. The compiler/interpreter processes formulas from left to right by default. Within complex calculations, it is usually necessary to specify which math operation shall be prior to the others. Prior operations must be encapsulated between an opening and an closing parenthesis. It is possible to nest multiple occurances of parenthesis. In that case, the most inner parenthesis operation will become priority to the others. In the follwing sample the multiplication (4*5) will be calculated first. Then the result of that multiplication (20) will become devided by 10 (20/10). Finaly, 123 will be reduced by the result of the division (123-2): value=(123-((4*5)/10)) = = 0.799000 no operator almost nothing none none The single equal sign is used to assign values to variables. It shall not be confused with the double equal sign ('=='), that is for comparison of two given values. In the following sample the value 123 will be assigned to the variable 'somevariable': somevariable=123 In the following sample the result of the calculation 4*5 will be assigned to 'somevariable': somevariable=4*5 pow( pow( base, exponent ) 0.799000 no function somewhat base numeric value that will be raised to the power of exponent exponent numeric value where base will raised to Returns base, raised to the power of exponent. The pow function computes base raised to the power of exponent. none sqrt( sqrt( numeric ) 0.799000 no function somewhat numeric numeric expression Square root of 'numeric' See 'Return'. none tan( tan( angle_rad ) 0.799000 no function somewhat angle_rad numeric expression tan returns the tangent of angle_rad. See 'Return'. none atan( atan( numeric ) 0.799000 no function somewhat numeric numeric expression atan returns the arctangent of x. Calculates the arctangent of x. none sin( sin( angle_rad ) 0.799000 no function somewhat angle_rad numeric expression sin returns the sine of angle_rad. See 'Return'. none asin( asin( numeric ) 0.799000 no function somewhat numeric numeric expression The asin function returns the arcsine of numeric in radians. If numeric is less than –1 or greater than 1, asin causes an math error. Calculates the arcsine. none cos( cos( angle_rad ) 0.799000 no function somewhat not yet done not yet done not yet done none acos( acos( numeric ) 0.799000 no function somewhat numeric numeric expression The acos function returns the arccosine of numeric in the range 0 to p radians. If numeric is less than –1 or greater than 1, acos causes an math error. Calculates the arccosine. none int( int( numeric ) 0.812000 no function somewhat a numeric expression Returns the integer part of the numeric expression. See 'Return' none red@( red@( coord_x, coord_y ) 0.799000 no function average coord_x x-coordinate of a provided position coord_y y-coordinate of a provided position Returns the value of the red color channel of the pixel at the given position (explicitly adressed by parameters coord_x and coord_y) The parameter coord_x must be a value between 0 and maxx. The parameter coord_y must be a value between 0 and maxy. For the case that one of both parameters is outside the valid range, the value of the red channel of the offscreen-color will be returned. none green@( green@( coord_x, coord_y ) 0.799000 no function average coord_x x-coordinate of a provided position coord_y y-coordinate of a provided position Returns the value of the green color channel of the pixel at the given position (explicitly adressed by parameters coord_x and coord_y) The parameter coord_x must be a value between 0 and maxx. The parameter coord_y must be a value between 0 and maxy. For the case that one of both parameters is outside the valid range, the value of the green channel of the offscreen-color will be returned. none blue@( blue@( coord_x, coord_y ) 0.799000 no function average coord_x x-coordinate of a provided position coord_y y-coordinate of a provided position Returns the value of the blue color channel of the pixel at the given position (explicitly adressed by parameters coord_x and coord_y) The parameter coord_x must be a value between 0 and maxx. The parameter coord_y must be a value between 0 and maxy. For the case that one of both parameters is outside the valid range, the value of the blue channel of the offscreen-color will be returned. none if( if( condition, case_true, case_false ) 0.803000 no function somewhat condition boolean expression that will be evaluated case_true the value that will be returned if condition is true case_false the value that will be returned if condition is false The function will return the second parameter (case_true) if the first parameter (condition) is true, otherwise it will return the second parameter (case_false). See 'Return' In the following example 456 will be assigned to value5, because value1 (30) is not lower/equal value2 (19): value1=30; value2=19; value3=123; value4=456; value5=if(value1<=value2,value3,value4) The following example shows how severall if-functions are nested within each other: value5=if(value1<=value2,if(value2>=234,345,456),if(value3==333,123,345)) max( max( value_1, value_2 ) 0.804000 no function somewhat value_1 one of the two numeric values that are to be compared value_2 one of the two numeric values that are to be compared either value_1 or value_2 Compares value_1 with value_2 and returns the higher value of both. in the following sample somevariable will become 456: somevariable = min( 123, 456 ) min( min( value_1, value_2 ) 0.804000 no function somewhat value_1 one of the two numeric values that are to be compared value_2 one of the two numeric values that are to be compared either value_1 or value_2 Compares value_1 with value_2 and returns the lower of both values. in the following sample somevariable will become 123: somevariable = min( 123, 456 ) rotatex( rotatex( center_x, center_y, angle_deg ) 0.802000 no function average center_x x-coordinate of a given position center_y y-coordinate of a given position angle_deg degree of angle for rotation Returns the transformed x-coordinate of the current position. By using this function, it is possible to transform the coordinates of the current position. The position will become rotated around a given center-position for a given amount of degrees. none rotatey( rotatey( center_x, center_y, angle_deg ) 0.802000 no function average center_x x-coordinate of a given position center_y y-coordinate of a given position angle_deg degree of angle for rotation Returns the transformed y-coordinate of the current position. By using this function, it is possible to transform the coordinates of the current position. The position will become rotated around a given center-position for a given amount of degrees. none distance( distance( to_x, to_y ) 0.802000 yes function average to_x x coordinate of the second point to_y y coordinate of the second point The distance between the position of the current pixel and the given point in pixels The distance is calculated as follows: distance = sqrt( pow( x-to_x, 2 ) + pow( y-to_y, 2 ) ) none distance@( distance@( from_x, from_y, to_x, to_y ) 0.811000 no function average from_x x coordinate of point 1 from_y y coordinate of point 1 to_x x coordinate of point 2 to_y y coordinate of point 2 The distance between two given points in pixels The distance is calculated as follows: distance = sqrt( pow( from_x-to_x, 2 ) + pow( from_y-to_y, 2 ) ) none colordist( colordist( color_red, color_green, color_blue ) 0.811000 yes function average color_red red color channel of the second color color_green grenn color channel of the second color color_blue blue color channel of the second color The distance between the given color and the color of the pixel at the current position. A color is defined by its three color channels red, green and blue, where every channel can have a value between 0 and 255. Those values can be used as coordinates in a 3d cube. The cube has a resolution of 255 by 255 by 255, where every possible color has its position. Like in any other 3d space the distance between two given points can be computed: distance=sqrt( pow( red1-red2, 2 ) + pow( green1-green2, 2 ) + pow( blue1-blue2, 2 ) ) The distance can be used as an indicator for the similarity of two given colors. none abs( abs( numeric ) 0.811000 no function somewhat numeric numeric expression abs returns the absolute value of its argument. Calculates the absolute value of the numeric argument. none tracegrey( tracegrey( to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none tracered( tracered( to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none tracegreen( tracegreen( to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none traceblue( traceblue( to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none tracegrey@( tracegrey@( from_x, from_y, to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none tracered@( tracered@( from_x, from_y, to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none tracegreen@( tracegreen@( from_x, from_y, to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none traceblue@( traceblue@( from_x, from_y, to_x, to_y, percent ) 0.817000 yes function heavy not yet done not yet done not yet done none rotatex@( rotatex@( point_x, point_y, center_x, center_y, angle_deg ) 0.818000 no function average point_x x-coordinate of a given position point_y y-coordinate of a given position center_x x-coordinate of a given position center_y y-coordinate of a given position angle_deg degree of angle for rotation Returns the transformed x-coordinate of a given position. By using this function, it is possible to transform the coordinates of the given position. The position will become rotated around a given center-position for a given amount of degrees. none rotatey@( rotatey@( point_x, point_y, center_x, center_y, angle_deg ) 0.818000 no function average point_x x-coordinate of a given position point_y y-coordinate of a given position center_x x-coordinate of a given position center_y y-coordinate of a given position angle_deg degree of angle for rotation Returns the transformed y-coordinate of a given position. By using this function, it is possible to transform the coordinates of the given position. The position will become rotated around a given center-position for a given amount of degrees. none true true 0.821000 no system constant almost nothing none Numeric value 1 This keyword represents one of the two values that a boolean expression can have. The second value is 'false'. none false false 0.821000 no system constant almost nothing none Numeric value 0 This keyword represents one of the two values that a boolean expression can have. The second value is 'true'. none seed( seed( use_static ) 0.821000 no function somewhat use_static boolean expression, that indicates that the pattern of generated random values shall remain static for each rendered frame The function returns true if it was successfull, otherwise false. Initiates the rand() function (function to retrieve random numeric values). It should only be used once for each frame (at event 'Each Frame'). none rand( rand( lower_bound, upper_bound ) 0.821000 no function somewhat lower_bound numeric value that determines the lowest random value upper_bound numeric value that determines the highest random value Random numeric value within the range of lower_bound to upper_bound. See 'Return' none != != 0.902000 no operator almost nothing not yet done Boolean expression (true or false) as result of a comparison between the left and the right operand of the operator. The logical operator 'unequal' is used to determine whether the operand left to the operator is unequal to the operand at the right side of the operator. It can be used in conjunction with the 'if' function. In the following sample the value of the system variable 'red' will be assigned for the case that the value of x is different to the value of centerx. Otherwise 0 will be assigned: centerx=height/2 ... if(x!=centerx,red,0) http://www.burgers-transition-site.de/downloads/fxbench/SlangReference.xml