Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

VisualShaderNodeVectorFunc

Inherits: VisualShaderNodeVectorBase < VisualShaderNode < Resource < RefCounted < Object

A vector function to be used within the visual shader graph.

Description

A visual shader node able to perform different functions using vectors.

Properties

Function

function

0

Enumerations

enum Function:

Function FUNC_NORMALIZE = 0

Normalizes the vector so that it has a length of 1 but points in the same direction.

Function FUNC_SATURATE = 1

Clamps the value between 0.0 and 1.0.

Function FUNC_NEGATE = 2

Returns the opposite value of the parameter.

Function FUNC_RECIPROCAL = 3

Returns 1/vector.

Function FUNC_ABS = 4

Returns the absolute value of the parameter.

Function FUNC_ACOS = 5

Returns the arc-cosine of the parameter.

Function FUNC_ACOSH = 6

Returns the inverse hyperbolic cosine of the parameter.

Function FUNC_ASIN = 7

Returns the arc-sine of the parameter.

Function FUNC_ASINH = 8

Returns the inverse hyperbolic sine of the parameter.

Function FUNC_ATAN = 9

Returns the arc-tangent of the parameter.

Function FUNC_ATANH = 10

Returns the inverse hyperbolic tangent of the parameter.

Function FUNC_CEIL = 11

Finds the nearest integer that is greater than or equal to the parameter.

Function FUNC_COS = 12

Returns the cosine of the parameter.

Function FUNC_COSH = 13

Returns the hyperbolic cosine of the parameter.

Function FUNC_DEGREES = 14

Converts a quantity in radians to degrees.

Function FUNC_EXP = 15

Base-e Exponential.

Function FUNC_EXP2 = 16

Base-2 Exponential.

Function FUNC_FLOOR = 17

Finds the nearest integer less than or equal to the parameter.

Function FUNC_FRACT = 18

Computes the fractional part of the argument.

Function FUNC_INVERSE_SQRT = 19

Returns the inverse of the square root of the parameter.

Function FUNC_LOG = 20

Natural logarithm.

Function FUNC_LOG2 = 21

Base-2 logarithm.

Function FUNC_RADIANS = 22

Converts a quantity in degrees to radians.

Function FUNC_ROUND = 23

Finds the nearest integer to the parameter.

Function FUNC_ROUNDEVEN = 24

Finds the nearest even integer to the parameter.

Function FUNC_SIGN = 25

Extracts the sign of the parameter, i.e. returns -1 if the parameter is negative, 1 if it's positive and 0 otherwise.

Function FUNC_SIN = 26

Returns the sine of the parameter.

Function FUNC_SINH = 27

Returns the hyperbolic sine of the parameter.

Function FUNC_SQRT = 28

Returns the square root of the parameter.

Function FUNC_TAN = 29

Returns the tangent of the parameter.

Function FUNC_TANH = 30

Returns the hyperbolic tangent of the parameter.

Function FUNC_TRUNC = 31

Returns a value equal to the nearest integer to the parameter whose absolute value is not larger than the absolute value of the parameter.

Function FUNC_ONEMINUS = 32

Returns 1.0 - vector.

Function FUNC_MAX = 33

Represents the size of the Function enum.

Property Descriptions

Function function = 0

The function to be performed. See Function for options.