filament/io.github.erkko68.filament/MaterialInstance

MaterialInstance

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

Each Material can spawn multiple MaterialInstances with different parameter values (colors, textures, numeric uniforms, etc.). Changes to a MaterialInstance only affect renderables using that specific instance, not the Material or other instances.

Creating and destroying: Create instances via Material.createInstance() and destroy with Engine.destroy(instance). You can duplicate an existing instance using the companion object's duplicate() method.

Setting parameters: Use setParameter() overloads to set uniforms (booleans, floats, vectors, matrices, textures). Parameter names and types must match those defined in the material. Array parameters are also supported via setParameter(name, type, array, offset, count) variants.

Rendering state customization: Each MaterialInstance can override per-instance rendering behavior:

  • Scissor rectangle for pixel-perfect clipping

  • Polygon offset for depth artifacts

  • Culling mode (override material's cull setting)

  • Depth test configuration

  • Stencil test and operations

  • Color and depth write masks

These settings override the Material's defaults.

See also

expect class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

Each Material can spawn multiple MaterialInstances with different parameter values (colors, textures, numeric uniforms, etc.). Changes to a MaterialInstance only affect renderables using that specific instance, not the Material or other instances.

Creating and destroying: Create instances via Material.createInstance() and destroy with Engine.destroy(instance). You can duplicate an existing instance using the companion object's duplicate() method.

Setting parameters: Use setParameter() overloads to set uniforms (booleans, floats, vectors, matrices, textures). Parameter names and types must match those defined in the material. Array parameters are also supported via setParameter(name, type, array, offset, count) variants.

Rendering state customization: Each MaterialInstance can override per-instance rendering behavior:

  • Scissor rectangle for pixel-perfect clipping

  • Polygon offset for depth artifacts

  • Culling mode (override material's cull setting)

  • Depth test configuration

  • Stencil test and operations

  • Color and depth write masks

These settings override the Material's defaults.

See also

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

Each Material can spawn multiple MaterialInstances with different parameter values (colors, textures, numeric uniforms, etc.). Changes to a MaterialInstance only affect renderables using that specific instance, not the Material or other instances.

Creating and destroying: Create instances via Material.createInstance() and destroy with Engine.destroy(instance). You can duplicate an existing instance using the companion object's duplicate() method.

Setting parameters: Use setParameter() overloads to set uniforms (booleans, floats, vectors, matrices, textures). Parameter names and types must match those defined in the material. Array parameters are also supported via setParameter(name, type, array, offset, count) variants.

Rendering state customization: Each MaterialInstance can override per-instance rendering behavior:

  • Scissor rectangle for pixel-perfect clipping

  • Polygon offset for depth artifacts

  • Culling mode (override material's cull setting)

  • Depth test configuration

  • Stencil test and operations

  • Color and depth write masks

These settings override the Material's defaults.

See also

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

Each Material can spawn multiple MaterialInstances with different parameter values (colors, textures, numeric uniforms, etc.). Changes to a MaterialInstance only affect renderables using that specific instance, not the Material or other instances.

Creating and destroying: Create instances via Material.createInstance() and destroy with Engine.destroy(instance). You can duplicate an existing instance using the companion object's duplicate() method.

Setting parameters: Use setParameter() overloads to set uniforms (booleans, floats, vectors, matrices, textures). Parameter names and types must match those defined in the material. Array parameters are also supported via setParameter(name, type, array, offset, count) variants.

Rendering state customization: Each MaterialInstance can override per-instance rendering behavior:

  • Scissor rectangle for pixel-perfect clipping

  • Polygon offset for depth artifacts

  • Culling mode (override material's cull setting)

  • Depth test configuration

  • Stencil test and operations

  • Color and depth write masks

These settings override the Material's defaults.

See also

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

Each Material can spawn multiple MaterialInstances with different parameter values (colors, textures, numeric uniforms, etc.). Changes to a MaterialInstance only affect renderables using that specific instance, not the Material or other instances.

Creating and destroying: Create instances via Material.createInstance() and destroy with Engine.destroy(instance). You can duplicate an existing instance using the companion object's duplicate() method.

Setting parameters: Use setParameter() overloads to set uniforms (booleans, floats, vectors, matrices, textures). Parameter names and types must match those defined in the material. Array parameters are also supported via setParameter(name, type, array, offset, count) variants.

Rendering state customization: Each MaterialInstance can override per-instance rendering behavior:

  • Scissor rectangle for pixel-perfect clipping

  • Polygon offset for depth artifacts

  • Culling mode (override material's cull setting)

  • Depth test configuration

  • Stencil test and operations

  • Color and depth write masks

These settings override the Material's defaults.

See also

Constructors

Link copied to clipboard
constructor(mMaterial: Material?, nativeMaterialInstance: MaterialInstance)
constructor(nativeMaterialInstance: MaterialInstance)
constructor(jsMaterialInstance: MaterialInstance)
constructor(nativeHandle: MemorySegment?)
constructor(nativeHandle: CPointer<FilaMaterialInstance>?)

Types

Link copied to clipboard
actual enum BooleanElement : Enum<MaterialInstance.BooleanElement>

Element types for boolean parameter arrays.

expect enum BooleanElement : Enum<MaterialInstance.BooleanElement>

Element types for boolean parameter arrays.

actual enum BooleanElement : Enum<MaterialInstance.BooleanElement>

Element types for boolean parameter arrays.

actual enum BooleanElement : Enum<MaterialInstance.BooleanElement>

Element types for boolean parameter arrays.

actual enum BooleanElement : Enum<MaterialInstance.BooleanElement>

Element types for boolean parameter arrays.

Link copied to clipboard
actual object Companion
expect object Companion
actual object Companion
actual object Companion
actual object Companion
Link copied to clipboard
actual enum FloatElement : Enum<MaterialInstance.FloatElement>

Element types for floating-point parameter arrays.

expect enum FloatElement : Enum<MaterialInstance.FloatElement>

Element types for floating-point parameter arrays.

actual enum FloatElement : Enum<MaterialInstance.FloatElement>

Element types for floating-point parameter arrays.

actual enum FloatElement : Enum<MaterialInstance.FloatElement>

Element types for floating-point parameter arrays.

actual enum FloatElement : Enum<MaterialInstance.FloatElement>

Element types for floating-point parameter arrays.

Link copied to clipboard
actual enum IntElement : Enum<MaterialInstance.IntElement>

Element types for integer parameter arrays.

expect enum IntElement : Enum<MaterialInstance.IntElement>

Element types for integer parameter arrays.

actual enum IntElement : Enum<MaterialInstance.IntElement>

Element types for integer parameter arrays.

actual enum IntElement : Enum<MaterialInstance.IntElement>

Element types for integer parameter arrays.

actual enum IntElement : Enum<MaterialInstance.IntElement>

Element types for integer parameter arrays.

Link copied to clipboard
actual enum StencilFace : Enum<MaterialInstance.StencilFace>

Which face(s) the stencil operation applies to.

expect enum StencilFace : Enum<MaterialInstance.StencilFace>

Which face(s) the stencil operation applies to.

actual enum StencilFace : Enum<MaterialInstance.StencilFace>

Which face(s) the stencil operation applies to.

actual enum StencilFace : Enum<MaterialInstance.StencilFace>

Which face(s) the stencil operation applies to.

actual enum StencilFace : Enum<MaterialInstance.StencilFace>

Which face(s) the stencil operation applies to.

Link copied to clipboard
actual enum StencilOperation : Enum<MaterialInstance.StencilOperation>

Stencil test operation determines how the stencil buffer is modified.

expect enum StencilOperation : Enum<MaterialInstance.StencilOperation>

Stencil test operation determines how the stencil buffer is modified.

actual enum StencilOperation : Enum<MaterialInstance.StencilOperation>

Stencil test operation determines how the stencil buffer is modified.

actual enum StencilOperation : Enum<MaterialInstance.StencilOperation>

Stencil test operation determines how the stencil buffer is modified.

actual enum StencilOperation : Enum<MaterialInstance.StencilOperation>

Stencil test operation determines how the stencil buffer is modified.

Properties

Link copied to clipboard
actual var cullingMode: Material.CullingMode

Gets/sets the face culling mode.

expect var cullingMode: Material.CullingMode

Gets/sets the face culling mode.

actual var cullingMode: Material.CullingMode

Gets/sets the face culling mode.

actual var cullingMode: Material.CullingMode

Gets/sets the face culling mode.

actual var cullingMode: Material.CullingMode

Gets/sets the face culling mode.

Link copied to clipboard
actual var depthFunc: TextureSampler.CompareFunction

Gets/sets the depth function.

expect var depthFunc: TextureSampler.CompareFunction

Gets/sets the depth function.

actual var depthFunc: TextureSampler.CompareFunction

Gets/sets the depth function.

actual var depthFunc: TextureSampler.CompareFunction

Gets/sets the depth function.

actual var depthFunc: TextureSampler.CompareFunction

Gets/sets the depth function.

Link copied to clipboard
actual var isColorWriteEnabled: Boolean

Gets/sets whether color write is enabled.

expect var isColorWriteEnabled: Boolean

Gets/sets whether color write is enabled.

actual var isColorWriteEnabled: Boolean

Gets/sets whether color write is enabled.

actual var isColorWriteEnabled: Boolean

Gets/sets whether color write is enabled.

actual var isColorWriteEnabled: Boolean

Gets/sets whether color write is enabled.

Link copied to clipboard
actual var isDepthCullingEnabled: Boolean

Gets/sets whether depth culling (depth testing) is enabled.

expect var isDepthCullingEnabled: Boolean

Gets/sets whether depth culling (depth testing) is enabled.

actual var isDepthCullingEnabled: Boolean

Gets/sets whether depth culling (depth testing) is enabled.

actual var isDepthCullingEnabled: Boolean

Gets/sets whether depth culling (depth testing) is enabled.

actual var isDepthCullingEnabled: Boolean

Gets/sets whether depth culling (depth testing) is enabled.

Link copied to clipboard
actual var isDepthWriteEnabled: Boolean

Gets/sets whether depth write is enabled.

expect var isDepthWriteEnabled: Boolean

Gets/sets whether depth write is enabled.

actual var isDepthWriteEnabled: Boolean

Gets/sets whether depth write is enabled.

actual var isDepthWriteEnabled: Boolean

Gets/sets whether depth write is enabled.

actual var isDepthWriteEnabled: Boolean

Gets/sets whether depth write is enabled.

Link copied to clipboard
actual var isDoubleSided: Boolean

Gets/sets whether double-sided lighting is enabled.

expect var isDoubleSided: Boolean

Gets/sets whether double-sided lighting is enabled.

actual var isDoubleSided: Boolean

Gets/sets whether double-sided lighting is enabled.

actual var isDoubleSided: Boolean

Gets/sets whether double-sided lighting is enabled.

actual var isDoubleSided: Boolean

Gets/sets whether double-sided lighting is enabled.

Link copied to clipboard
actual var isStencilWriteEnabled: Boolean

Gets/sets whether stencil write is enabled.

expect var isStencilWriteEnabled: Boolean

Gets/sets whether stencil write is enabled.

actual var isStencilWriteEnabled: Boolean

Gets/sets whether stencil write is enabled.

actual var isStencilWriteEnabled: Boolean

Gets/sets whether stencil write is enabled.

actual var isStencilWriteEnabled: Boolean

Gets/sets whether stencil write is enabled.

Link copied to clipboard
actual var maskThreshold: Float

Gets/sets the alpha mask threshold for masked blending mode.

expect var maskThreshold: Float

Gets/sets the alpha mask threshold for masked blending mode.

actual var maskThreshold: Float

Gets/sets the alpha mask threshold for masked blending mode.

actual var maskThreshold: Float

Gets/sets the alpha mask threshold for masked blending mode.

actual var maskThreshold: Float

Gets/sets the alpha mask threshold for masked blending mode.

Link copied to clipboard
actual val material: Material

Get the Material this instance is created from.

expect val material: Material

Get the Material this instance is created from.

actual val material: Material

Get the Material this instance is created from.

actual val material: Material

Get the Material this instance is created from.

actual val material: Material

Get the Material this instance is created from.

Link copied to clipboard
actual val name: String

Get the name of this MaterialInstance.

expect val name: String

Get the name of this MaterialInstance.

actual val name: String

Get the name of this MaterialInstance.

actual val name: String

Get the name of this MaterialInstance.

actual val name: String

Get the name of this MaterialInstance.

Link copied to clipboard
actual val shadowCullingMode: Material.CullingMode

Returns the face culling mode for the shadow passes.

expect val shadowCullingMode: Material.CullingMode

Returns the face culling mode for the shadow passes.

actual val shadowCullingMode: Material.CullingMode

Returns the face culling mode for the shadow passes.

actual val shadowCullingMode: Material.CullingMode

Returns the face culling mode for the shadow passes.

actual val shadowCullingMode: Material.CullingMode

Returns the face culling mode for the shadow passes.

Link copied to clipboard
actual var specularAntiAliasingThreshold: Float

Gets/sets the clamping threshold used to suppress estimation errors when applying specular anti-aliasing.

expect var specularAntiAliasingThreshold: Float

Gets/sets the clamping threshold used to suppress estimation errors when applying specular anti-aliasing.

actual var specularAntiAliasingThreshold: Float

Gets/sets the clamping threshold used to suppress estimation errors when applying specular anti-aliasing.

actual var specularAntiAliasingThreshold: Float

Gets/sets the clamping threshold used to suppress estimation errors when applying specular anti-aliasing.

actual var specularAntiAliasingThreshold: Float

Gets/sets the clamping threshold used to suppress estimation errors when applying specular anti-aliasing.

Link copied to clipboard
actual var specularAntiAliasingVariance: Float

Gets/sets the screen space variance of the filter kernel used when applying specular anti-aliasing.

expect var specularAntiAliasingVariance: Float

Gets/sets the screen space variance of the filter kernel used when applying specular anti-aliasing.

actual var specularAntiAliasingVariance: Float

Gets/sets the screen space variance of the filter kernel used when applying specular anti-aliasing.

actual var specularAntiAliasingVariance: Float

Gets/sets the screen space variance of the filter kernel used when applying specular anti-aliasing.

actual var specularAntiAliasingVariance: Float

Gets/sets the screen space variance of the filter kernel used when applying specular anti-aliasing.

Link copied to clipboard
actual var transparencyMode: Material.TransparencyMode

Gets/sets the transparency rendering mode.

expect var transparencyMode: Material.TransparencyMode

Gets/sets the transparency rendering mode.

actual var transparencyMode: Material.TransparencyMode

Gets/sets the transparency rendering mode.

actual var transparencyMode: Material.TransparencyMode

Gets/sets the transparency rendering mode.

actual var transparencyMode: Material.TransparencyMode

Gets/sets the transparency rendering mode.

Functions

Link copied to clipboard
actual fun setCullingMode(colorPassCullingMode: Material.CullingMode, shadowPassCullingMode: Material.CullingMode)

Sets different culling modes for color and shadow passes.

expect fun setCullingMode(colorPassCullingMode: Material.CullingMode, shadowPassCullingMode: Material.CullingMode)

Sets different culling modes for color and shadow passes.

actual fun setCullingMode(colorPassCullingMode: Material.CullingMode, shadowPassCullingMode: Material.CullingMode)

Sets different culling modes for color and shadow passes.

actual fun setCullingMode(colorPassCullingMode: Material.CullingMode, shadowPassCullingMode: Material.CullingMode)

Sets different culling modes for color and shadow passes.

actual fun setCullingMode(colorPassCullingMode: Material.CullingMode, shadowPassCullingMode: Material.CullingMode)

Sets different culling modes for color and shadow passes.

Link copied to clipboard
actual fun setParameter(name: String, x: Boolean)

Sets a boolean parameter.

actual fun setParameter(name: String, x: Float)

Sets a float parameter.

actual fun setParameter(name: String, x: Int)

Sets an integer parameter.

actual fun setParameter(name: String, texture: Texture, sampler: TextureSampler)

Sets a texture parameter with sampler configuration.

actual fun setParameter(name: String, x: Boolean, y: Boolean)

Sets a 2-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float)

Sets a 2-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int)

Sets a 2-component integer vector parameter.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean)

Sets a 3-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float)

Sets a 3-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int)

Sets a 3-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbType, r: Float, g: Float, b: Float)

Sets an RGB color parameter.

actual fun setParameter(name: String, type: MaterialInstance.BooleanElement, v: BooleanArray, offset: Int, count: Int)

Sets a parameter from a boolean array.

actual fun setParameter(name: String, type: MaterialInstance.FloatElement, v: FloatArray, offset: Int, count: Int)

Sets a parameter from a float array.

actual fun setParameter(name: String, type: MaterialInstance.IntElement, v: IntArray, offset: Int, count: Int)

Sets a parameter from an integer array.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean, w: Boolean)

Sets a 4-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float, w: Float)

Sets a 4-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int, w: Int)

Sets a 4-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbaType, r: Float, g: Float, b: Float, a: Float)

Sets an RGBA color parameter.

expect fun setParameter(name: String, x: Boolean)

Sets a boolean parameter.

expect fun setParameter(name: String, x: Float)

Sets a float parameter.

expect fun setParameter(name: String, x: Int)

Sets an integer parameter.

expect fun setParameter(name: String, texture: Texture, sampler: TextureSampler)

Sets a texture parameter with sampler configuration.

expect fun setParameter(name: String, x: Boolean, y: Boolean)

Sets a 2-component boolean vector parameter.

expect fun setParameter(name: String, x: Float, y: Float)

Sets a 2-component float vector parameter.

expect fun setParameter(name: String, x: Int, y: Int)

Sets a 2-component integer vector parameter.

expect fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean)

Sets a 3-component boolean vector parameter.

expect fun setParameter(name: String, x: Float, y: Float, z: Float)

Sets a 3-component float vector parameter.

expect fun setParameter(name: String, x: Int, y: Int, z: Int)

Sets a 3-component integer vector parameter.

expect fun setParameter(name: String, type: Colors.RgbType, r: Float, g: Float, b: Float)

Sets an RGB color parameter.

expect fun setParameter(name: String, type: MaterialInstance.BooleanElement, v: BooleanArray, offset: Int, count: Int)

Sets a parameter from a boolean array.

expect fun setParameter(name: String, type: MaterialInstance.FloatElement, v: FloatArray, offset: Int, count: Int)

Sets a parameter from a float array.

expect fun setParameter(name: String, type: MaterialInstance.IntElement, v: IntArray, offset: Int, count: Int)

Sets a parameter from an integer array.

expect fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean, w: Boolean)

Sets a 4-component boolean vector parameter.

expect fun setParameter(name: String, x: Float, y: Float, z: Float, w: Float)

Sets a 4-component float vector parameter.

expect fun setParameter(name: String, x: Int, y: Int, z: Int, w: Int)

Sets a 4-component integer vector parameter.

expect fun setParameter(name: String, type: Colors.RgbaType, r: Float, g: Float, b: Float, a: Float)

Sets an RGBA color parameter.

actual fun setParameter(name: String, x: Boolean)

Sets a boolean parameter.

actual fun setParameter(name: String, x: Float)

Sets a float parameter.

actual fun setParameter(name: String, x: Int)

Sets an integer parameter.

actual fun setParameter(name: String, texture: Texture, sampler: TextureSampler)

Sets a texture parameter with sampler configuration.

actual fun setParameter(name: String, x: Boolean, y: Boolean)

Sets a 2-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float)

Sets a 2-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int)

Sets a 2-component integer vector parameter.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean)

Sets a 3-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float)

Sets a 3-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int)

Sets a 3-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbType, r: Float, g: Float, b: Float)

Sets an RGB color parameter.

actual fun setParameter(name: String, type: MaterialInstance.BooleanElement, v: BooleanArray, offset: Int, count: Int)

Sets a parameter from a boolean array.

actual fun setParameter(name: String, type: MaterialInstance.FloatElement, v: FloatArray, offset: Int, count: Int)

Sets a parameter from a float array.

actual fun setParameter(name: String, type: MaterialInstance.IntElement, v: IntArray, offset: Int, count: Int)

Sets a parameter from an integer array.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean, w: Boolean)

Sets a 4-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float, w: Float)

Sets a 4-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int, w: Int)

Sets a 4-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbaType, r: Float, g: Float, b: Float, a: Float)

Sets an RGBA color parameter.

actual fun setParameter(name: String, x: Boolean)

Sets a boolean parameter.

actual fun setParameter(name: String, x: Float)

Sets a float parameter.

actual fun setParameter(name: String, x: Int)

Sets an integer parameter.

actual fun setParameter(name: String, texture: Texture, sampler: TextureSampler)

Sets a texture parameter with sampler configuration.

actual fun setParameter(name: String, x: Boolean, y: Boolean)

Sets a 2-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float)

Sets a 2-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int)

Sets a 2-component integer vector parameter.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean)

Sets a 3-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float)

Sets a 3-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int)

Sets a 3-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbType, r: Float, g: Float, b: Float)

Sets an RGB color parameter.

actual fun setParameter(name: String, type: MaterialInstance.BooleanElement, v: BooleanArray, offset: Int, count: Int)

Sets a parameter from a boolean array.

actual fun setParameter(name: String, type: MaterialInstance.FloatElement, v: FloatArray, offset: Int, count: Int)

Sets a parameter from a float array.

actual fun setParameter(name: String, type: MaterialInstance.IntElement, v: IntArray, offset: Int, count: Int)

Sets a parameter from an integer array.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean, w: Boolean)

Sets a 4-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float, w: Float)

Sets a 4-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int, w: Int)

Sets a 4-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbaType, r: Float, g: Float, b: Float, a: Float)

Sets an RGBA color parameter.

actual fun setParameter(name: String, x: Boolean)

Sets a boolean parameter.

actual fun setParameter(name: String, x: Float)

Sets a float parameter.

actual fun setParameter(name: String, x: Int)

Sets an integer parameter.

actual fun setParameter(name: String, texture: Texture, sampler: TextureSampler)

Sets a texture parameter with sampler configuration.

actual fun setParameter(name: String, x: Boolean, y: Boolean)

Sets a 2-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float)

Sets a 2-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int)

Sets a 2-component integer vector parameter.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean)

Sets a 3-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float)

Sets a 3-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int)

Sets a 3-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbType, r: Float, g: Float, b: Float)

Sets an RGB color parameter.

actual fun setParameter(name: String, type: MaterialInstance.BooleanElement, v: BooleanArray, offset: Int, count: Int)

Sets a parameter from a boolean array.

actual fun setParameter(name: String, type: MaterialInstance.FloatElement, v: FloatArray, offset: Int, count: Int)

Sets a parameter from a float array.

actual fun setParameter(name: String, type: MaterialInstance.IntElement, v: IntArray, offset: Int, count: Int)

Sets a parameter from an integer array.

actual fun setParameter(name: String, x: Boolean, y: Boolean, z: Boolean, w: Boolean)

Sets a 4-component boolean vector parameter.

actual fun setParameter(name: String, x: Float, y: Float, z: Float, w: Float)

Sets a 4-component float vector parameter.

actual fun setParameter(name: String, x: Int, y: Int, z: Int, w: Int)

Sets a 4-component integer vector parameter.

actual fun setParameter(name: String, type: Colors.RgbaType, r: Float, g: Float, b: Float, a: Float)

Sets an RGBA color parameter.

Link copied to clipboard
actual fun setPolygonOffset(scale: Float, constant: Float)

Sets a polygon offset that will be applied to all renderables drawn with this material instance.

expect fun setPolygonOffset(scale: Float, constant: Float)

Sets a polygon offset that will be applied to all renderables drawn with this material instance.

actual fun setPolygonOffset(scale: Float, constant: Float)

Sets a polygon offset that will be applied to all renderables drawn with this material instance.

actual fun setPolygonOffset(scale: Float, constant: Float)

Sets a polygon offset that will be applied to all renderables drawn with this material instance.

actual fun setPolygonOffset(scale: Float, constant: Float)

Sets a polygon offset that will be applied to all renderables drawn with this material instance.

Link copied to clipboard
actual fun setScissor(left: Int, bottom: Int, width: Int, height: Int)

Set-up a custom scissor rectangle; by default it is disabled.

expect fun setScissor(left: Int, bottom: Int, width: Int, height: Int)

Set-up a custom scissor rectangle; by default it is disabled.

actual fun setScissor(left: Int, bottom: Int, width: Int, height: Int)

Set-up a custom scissor rectangle; by default it is disabled.

actual fun setScissor(left: Int, bottom: Int, width: Int, height: Int)

Set-up a custom scissor rectangle; by default it is disabled.

actual fun setScissor(left: Int, bottom: Int, width: Int, height: Int)

Set-up a custom scissor rectangle; by default it is disabled.

Link copied to clipboard
actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction)

Sets the stencil comparison function for both front and back faces (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction, face: MaterialInstance.StencilFace)

Sets the stencil comparison function (default is ALWAYS).

expect fun setStencilCompareFunction(func: TextureSampler.CompareFunction)

Sets the stencil comparison function for both front and back faces (default is ALWAYS).

expect fun setStencilCompareFunction(func: TextureSampler.CompareFunction, face: MaterialInstance.StencilFace)

Sets the stencil comparison function (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction)

Sets the stencil comparison function for both front and back faces (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction, face: MaterialInstance.StencilFace)

Sets the stencil comparison function (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction)

Sets the stencil comparison function for both front and back faces (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction, face: MaterialInstance.StencilFace)

Sets the stencil comparison function (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction)

Sets the stencil comparison function for both front and back faces (default is ALWAYS).

actual fun setStencilCompareFunction(func: TextureSampler.CompareFunction, face: MaterialInstance.StencilFace)

Sets the stencil comparison function (default is ALWAYS).

Link copied to clipboard
actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation)

Sets the depth fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth fail operation (default is KEEP).

expect fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation)

Sets the depth fail operation for both front and back faces (default is KEEP).

expect fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth fail operation (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation)

Sets the depth fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth fail operation (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation)

Sets the depth fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth fail operation (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation)

Sets the depth fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth fail operation (default is KEEP).

Link copied to clipboard
actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation)

Sets the depth-stencil pass operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth-stencil pass operation (default is KEEP).

expect fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation)

Sets the depth-stencil pass operation for both front and back faces (default is KEEP).

expect fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth-stencil pass operation (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation)

Sets the depth-stencil pass operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth-stencil pass operation (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation)

Sets the depth-stencil pass operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth-stencil pass operation (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation)

Sets the depth-stencil pass operation for both front and back faces (default is KEEP).

actual fun setStencilOpDepthStencilPass(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the depth-stencil pass operation (default is KEEP).

Link copied to clipboard
actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation)

Sets the stencil fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the stencil fail operation (default is KEEP).

expect fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation)

Sets the stencil fail operation for both front and back faces (default is KEEP).

expect fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the stencil fail operation (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation)

Sets the stencil fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the stencil fail operation (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation)

Sets the stencil fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the stencil fail operation (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation)

Sets the stencil fail operation for both front and back faces (default is KEEP).

actual fun setStencilOpStencilFail(op: MaterialInstance.StencilOperation, face: MaterialInstance.StencilFace)

Sets the stencil fail operation (default is KEEP).

Link copied to clipboard
actual fun setStencilReadMask(readMask: Int)

Sets the stencil read mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil read mask (default is 0xFF / 255 / all bits).

expect fun setStencilReadMask(readMask: Int)

Sets the stencil read mask for both front and back faces (default is 0xFF / 255 / all bits).

expect fun setStencilReadMask(readMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil read mask (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int)

Sets the stencil read mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil read mask (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int)

Sets the stencil read mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil read mask (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int)

Sets the stencil read mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilReadMask(readMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil read mask (default is 0xFF / 255 / all bits).

Link copied to clipboard
actual fun setStencilReferenceValue(value: Int)

Sets the stencil reference value for both front and back faces (default is 0).

actual fun setStencilReferenceValue(value: Int, face: MaterialInstance.StencilFace)

Sets the stencil reference value (default is 0).

expect fun setStencilReferenceValue(value: Int)

Sets the stencil reference value for both front and back faces (default is 0).

expect fun setStencilReferenceValue(value: Int, face: MaterialInstance.StencilFace)

Sets the stencil reference value (default is 0).

actual fun setStencilReferenceValue(value: Int)

Sets the stencil reference value for both front and back faces (default is 0).

actual fun setStencilReferenceValue(value: Int, face: MaterialInstance.StencilFace)

Sets the stencil reference value (default is 0).

actual fun setStencilReferenceValue(value: Int)

Sets the stencil reference value for both front and back faces (default is 0).

actual fun setStencilReferenceValue(value: Int, face: MaterialInstance.StencilFace)

Sets the stencil reference value (default is 0).

actual fun setStencilReferenceValue(value: Int)

Sets the stencil reference value for both front and back faces (default is 0).

actual fun setStencilReferenceValue(value: Int, face: MaterialInstance.StencilFace)

Sets the stencil reference value (default is 0).

Link copied to clipboard
actual fun setStencilWriteMask(writeMask: Int)

Sets the stencil write mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil write mask (default is 0xFF / 255 / all bits).

expect fun setStencilWriteMask(writeMask: Int)

Sets the stencil write mask for both front and back faces (default is 0xFF / 255 / all bits).

expect fun setStencilWriteMask(writeMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil write mask (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int)

Sets the stencil write mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil write mask (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int)

Sets the stencil write mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil write mask (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int)

Sets the stencil write mask for both front and back faces (default is 0xFF / 255 / all bits).

actual fun setStencilWriteMask(writeMask: Int, face: MaterialInstance.StencilFace)

Sets the stencil write mask (default is 0xFF / 255 / all bits).

Link copied to clipboard
actual fun unsetScissor()

Disables the scissor box test; rendering is not restricted to any region.

expect fun unsetScissor()

Disables the scissor box test; rendering is not restricted to any region.

actual fun unsetScissor()

Disables the scissor box test; rendering is not restricted to any region.

actual fun unsetScissor()

Disables the scissor box test; rendering is not restricted to any region.

actual fun unsetScissor()

Disables the scissor box test; rendering is not restricted to any region.

Generated by Dokka
© 2026 Copyright