Package foundry.veil.api.glsl.node.function

Class GlslFunctionNode

java.lang.Object

foundry.veil.api.glsl.node.function.GlslFunctionNode

All Implemented Interfaces:

GlslNode, GlslRootNode

public class GlslFunctionNode
extends Object
implements GlslRootNode

Defines a function in a GLSL file with an optional body.

Field Summary

Fields inherited from interface foundry.veil.api.glsl.node.GlslNode

NEWLINE

Constructor Summary

Constructors

Constructor	Description
GlslFunctionNode(GlslFunctionHeader header, @Nullable Collection<GlslNode> body)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable GlslNodeList	getBody()
GlslFunctionHeader	getHeader()
@NotNull String	getName()
List<GlslParameterDeclaration>	getParameters()
GlslSpecifiedType	getReturnType()
String	getSourceString()
int	hashCode()
boolean	setBody(@Nullable Collection<GlslNode> body)	Sets the body of this function or null to make this a function prototype.
void	setHeader(GlslFunctionHeader header)	Sets the function header of this function to the specified value.
GlslFunctionNode	setName(@Nullable String name)
Stream<GlslNode>	stream()
String	toString()
void	visit(GlslFunctionVisitor visitor)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface foundry.veil.api.glsl.node.GlslNode

getType, setBody, toList

Methods inherited from interface foundry.veil.api.glsl.node.GlslRootNode

asDeclaration, asField, asFunction, asStruct, isDeclaration, isField, isFunction, isStruct

Constructor Details

GlslFunctionNode

public GlslFunctionNode(GlslFunctionHeader header,
 @Nullable
 @Nullable Collection<GlslNode> body)

Method Details

visit

public void visit(GlslFunctionVisitor visitor)

getHeader

public GlslFunctionHeader getHeader()

Returns:

The full signature of this function

getName

@NotNull
public @NotNull String getName()

Specified by:

getName in interface GlslRootNode

getReturnType

public GlslSpecifiedType getReturnType()

Returns:

The return type of the function

getParameters

public List<GlslParameterDeclaration> getParameters()

Returns:

The parameters of the function

getBody

@Nullable
public @Nullable GlslNodeList getBody()

Specified by:

getBody in interface GlslNode

Returns:

The body of this node or null if there is no sub-body in this node

setHeader

public void setHeader(GlslFunctionHeader header)

Sets the function header of this function to the specified value.

Parameters:

header - The new header

setName

public GlslFunctionNode setName(@Nullable
 @Nullable String name)

Specified by:

setName in interface GlslRootNode

setBody

public boolean setBody(@Nullable
 @Nullable Collection<GlslNode> body)

Sets the body of this function or null to make this a function prototype.

Specified by:

setBody in interface GlslNode

Parameters:

body - The new function body

Returns:

Whether the action was successful

getSourceString

public String getSourceString()

Specified by:

getSourceString in interface GlslNode

stream

public Stream<GlslNode> stream()

Specified by:

stream in interface GlslNode

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object