Package foundry.veil.api.client.render.shader.program

Interface UniformAccess

All Known Subinterfaces:

MutableUniformAccess, PostPipeline, ShaderProgram

All Known Implementing Classes:

BlitPostStage, CompositePostPipeline, CopyPostStage, DepthFunctionPostStage, DynamicShaderProgramImpl, FramebufferPostStage, MaskPostStage, ShaderProgramImpl

public interface UniformAccess

Provides read and write access to all uniform variables in a shader program.

Method Summary

Modifier and Type	Method	Description
ShaderUniformAccess	getOrCreateUniform(CharSequence name)	Retrieves a uniform by name or creates a reference to one that may exist in the future.
int	getStorageBlock(CharSequence name)	Retrieves the location of a storage block.
@Nullable ShaderUniformAccess	getUniform(CharSequence name)	Retrieves a uniform by name.
int	getUniformBlock(CharSequence name)	Retrieves the location of a uniform block.
int	getUniformLocation(CharSequence name)	Retrieves the location of a uniform.
ShaderUniformAccess	getUniformSafe(CharSequence name)	Retrieves a uniform by name.
default boolean	hasStorageBlock(CharSequence name)	Checks if the specified storage block exists in the shader.
default boolean	hasUniform(CharSequence name)	Checks if the specified uniform exists in the shader.
default boolean	hasUniformBlock(CharSequence name)	Checks if the specified uniform block exists in the shader.

Method Details

getUniformLocation

int getUniformLocation(CharSequence name)

Retrieves the location of a uniform.

Parameters:

name - The name of the uniform to get

Returns:

The location of that uniform or -1 if not found

hasUniform

default boolean hasUniform(CharSequence name)

Checks if the specified uniform exists in the shader.

Parameters:

name - The name of the uniform to check

Returns:

Whether that uniform can be set

getUniform

@Nullable
@Nullable ShaderUniformAccess getUniform(CharSequence name)

Retrieves a uniform by name.

Parameters:

name - The name of the uniform to get

Returns:

The uniform with that name or null if the uniform does not exist

getUniformSafe

ShaderUniformAccess getUniformSafe(CharSequence name)

Retrieves a uniform by name.

Parameters:

name - The name of the uniform to get

Returns:

The uniform with that name

getOrCreateUniform

ShaderUniformAccess getOrCreateUniform(CharSequence name)

Retrieves a uniform by name or creates a reference to one that may exist in the future.

Parameters:

name - The name of the uniform to get

Returns:

The uniform instance

getUniformBlock

int getUniformBlock(CharSequence name)

Retrieves the location of a uniform block.

Parameters:

name - The name of the uniform block to get

Returns:

The location of that uniform block or -1 if not found

hasUniformBlock

default boolean hasUniformBlock(CharSequence name)

Checks if the specified uniform block exists in the shader.

Parameters:

name - The name of the uniform block to check

Returns:

Whether that uniform block can be set

getStorageBlock

int getStorageBlock(CharSequence name)

Retrieves the location of a storage block.

Parameters:

name - The name of the storage block to get

Returns:

The location of that storage block or -1 if not found

hasStorageBlock

default boolean hasStorageBlock(CharSequence name)

Checks if the specified storage block exists in the shader.

Parameters:

name - The name of the storage block to check

Returns:

Whether that storage block can be set