ShaderEffect
Applies a custom full-screen shader.
- Creatable
Instance.new("ShaderEffect")- Inherits
- Instance
- Replication
- Standard
Behavior
ShaderEffect applies a custom full-screen shader.
Summary
The latest compilation error for this source, or nil when compilation has not been attempted, is pending, or has succeeded.
Whether the renderer has reported successful compilation for the current source.
Whether this post-processing effect is applied to the rendered image.
Parameters: string = "[[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0]]"parallel readread onlyThe serialized parameter values supplied to the custom shader.
The relative priority used to order or process this object.
Source: string = "fn effect(uv: vec2<f32>, color: vec4<f32>) -> vec4<f32> { return color; } "parallel readreplicatesThe custom shader program source.
Returns this instance if it is an ExecutionGroup.
Returns the value stored in the selected shader parameter slot.
SetParameter(index: number, value: number | boolean | Vector2 | Vector3 | Color3 | { number }): ()serial onlySets the selected shader parameter slot.
Properties
CompileError
ShaderEffect.CompileError: string? = ""The latest compilation error for this source, or nil when compilation has not been attempted, is pending, or has succeeded.
Compiled
ShaderEffect.Compiled: boolean = falseWhether the renderer has reported successful compilation for the current source.
Enabled
ShaderEffect.Enabled: boolean = trueWhether this post-processing effect is applied to the rendered image.
Parameters
ShaderEffect.Parameters: string = "[[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0]]"The serialized parameter values supplied to the custom shader.
Priority
ShaderEffect.Priority: number = 0The relative priority used to order or process this object.
Source
ShaderEffect.Source: string = "fn effect(uv: vec2<f32>, color: vec4<f32>) -> vec4<f32> {
return color;
}
"The custom shader program source. Source length is limited to 64 KiB. Read Compiled and CompileError for renderer compilation results.
Methods
GetExecutionGroup
ShaderEffect:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetParameter
ShaderEffect:GetParameter(index: number): (number, number, number, number)Returns the value stored in the selected shader parameter slot.
SetParameter
ShaderEffect:SetParameter(index: number, value: number | boolean | Vector2 | Vector3 | Color3 | { number }): ()Sets the selected shader parameter slot.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying