BuiltInShader

Represents a built-in shader loaded from the application's resources.

The properties of this class use delegated properties to manage shader uniform values. The getter is used to retrieve the current value of the uniform from the shader, while the setter updates the uniform value in the shader. The getter will always return the last value set through the setter, or null if it has not been set yet.

Inheritors

Properties

var id: ERROR CLASS: Symbol not found for UInt

The ID of the shader program.

isValid

val isValid: Boolean

Whether the shader is valid.

locs

var locs: List<Int>

The locations of the shader attributes and uniforms.

Functions

equals

open operator override fun equals(other: Any?): Boolean

getAttributeLocation

fun getAttributeLocation(attributeName: String): Int

Gets the location of a shader attribute variable by name.

getDefaultLocation

fun getDefaultLocation(uniformLocation: Shader.UniformLocation): Int

Gets the location of a shader uniform variable at its default name.

getLocation

fun getLocation(uniformName: String): Int

Gets the location of a shader uniform variable by name.

getLocationAt

fun getLocationAt(index: Int): Int

Gets the location of a shader uniform variable at the given index.

hasAttribute

fun hasAttribute(attributeName: String): Boolean

Checks if a shader has a specific attribute variable.

hashCode

open override fun hashCode(): Int

hasValue

fun hasValue(uniformName: String): Boolean

Checks if a shader has a specific uniform variable.

removeValue

fun removeValue(location: Int)

Removes a value for a shader uniform variable.

fun removeValue(uniformName: String)

Removes a value for a shader uniform variable by name.

setDefaultLocation

fun setDefaultLocation(uniformLocation: Shader.UniformLocation)

Sets the location of a shader uniform variable to its default name.

setDefaultLocations

fun setDefaultLocations(uniformLocations: Iterable<Shader.UniformLocation>)

fun setDefaultLocations(vararg uniformLocations: Shader.UniformLocation)

Sets the locations of multiple shader uniform variables to their default names.

setLocation

fun setLocation(index: Int, location: Int)

Sets the location of a shader uniform variable at the given index.

fun setLocation(index: Int, uniformName: String)

fun setLocation(uniformLocation: Shader.UniformLocation, uniformName: String)

Sets the location of a shader uniform variable by name.

fun setLocation(uniformLocation: Shader.UniformLocation, location: Int)

Sets the location of a shader uniform variable.

setLocations

fun setLocations(uniformLocations: Map<Shader.UniformLocation, String>)

Sets the locations of multiple shader uniform variables by name.

setValue

fun setValue(location: Int, value: ERROR CLASS: Symbol not found for Pair<kotlin/Float, kotlin/Float>): ERROR CLASS: Unresolved name: memScoped

Sets a 2D Vector (Pair) value for a shader uniform variable.

fun setValue(location: Int, value: ERROR CLASS: Symbol not found for Triple<kotlin/Float, kotlin/Float, kotlin/Float>): ERROR CLASS: Unresolved name: memScoped

Sets a 3D Vector (Triple) value for a shader uniform variable.

fun setValue(location: Int, value: ERROR CLASS: Symbol not found for UInt): ERROR CLASS: Unresolved name: memScoped

Sets an unsigned integer value for a shader uniform variable.

fun setValue(location: Int, value: Any?)

Sets a value for a shader uniform variable. The type of the value is inferred at runtime. Supported types are: Boolean, Float, Double, Int, UInt, Pair, Triple, Quadruple, Matrix4, Texture2D, and Color.

fun setValue(location: Int, value: Boolean)

Sets a boolean value for a shader uniform variable.

fun setValue(location: Int, value: Double)

Sets a double value for a shader uniform variable. Performs conversion to float.

fun setValue(location: Int, value: Float): ERROR CLASS: Unresolved name: memScoped

Sets a float value for a shader uniform variable.

fun setValue(location: Int, value: FloatArray)

Sets a float array value for a shader uniform variable.

fun setValue(location: Int, value: Int): ERROR CLASS: Unresolved name: memScoped

Sets an integer value for a shader uniform variable.

fun setValue(location: Int, value: IntArray)

Sets an int array value for a shader uniform variable.

fun setValue(location: Int, value: Quadruple<Float, Float, Float, Float>): ERROR CLASS: Unresolved name: memScoped

Sets a 4D Vector (Quadruple) value for a shader uniform variable.

fun setValue(location: Int, value: Color)

Sets a color value for a shader uniform variable.

fun setValue(location: Int, value: Matrix4)

Sets a matrix value for a shader uniform variable.

fun setValue(location: Int, value: Texture2D)

Sets a texture value for a shader uniform variable.

fun setValue(uniformName: String, value: ERROR CLASS: Symbol not found for Pair<kotlin/Float, kotlin/Float>)

Sets a 2D Vector (Pair) value for a shader uniform variable by name.

fun setValue(uniformName: String, value: ERROR CLASS: Symbol not found for Triple<kotlin/Float, kotlin/Float, kotlin/Float>)

Sets a 3D Vector (Triple) value for a shader uniform variable by name.

fun setValue(uniformName: String, value: ERROR CLASS: Symbol not found for UInt)

Sets an unsigned integer value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Any)

Sets a value for a shader uniform variable by name. The type of the value is inferred at runtime. Supported types are: Boolean, Float, Double, Int, UInt, Pair, Triple, Quadruple, Matrix4, Texture2D, and Color.

fun setValue(uniformName: String, value: Boolean)

Sets a boolean value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Float)

Sets a float value for a shader uniform variable by name.

fun setValue(uniformName: String, value: FloatArray)

Sets a float array value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Int)

Sets an integer value for a shader uniform variable by name.

fun setValue(uniformName: String, value: IntArray)

Sets an int array value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Quadruple<Float, Float, Float, Float>)

Sets a 4D Vector (Quadruple) value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Color)

Sets a color value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Matrix4)

Sets a matrix value for a shader uniform variable by name.

fun setValue(uniformName: String, value: Texture2D)

Sets a texture value for a shader uniform variable by name.

fun setValue(location: Int, value: Any, type: Shader.DataType): ERROR CLASS: Unresolved name: memScoped

Sets a value for a shader uniform variable.

fun setValue(uniformName: String, value: Any, type: Shader.DataType)

Sets a value for a shader uniform variable by name.

unload

fun unload()

Unloads the shader from VRAM.